Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs] Rework backups a bit #1942

Merged
merged 5 commits into from
Jul 7, 2023

Conversation

daenney
Copy link
Member

@daenney daenney commented Jul 3, 2023

Description

This changes the existing backup documentation to:

  • Push a bit harder on people to perform backups, it's not really just a nice to have
  • Removes the language about migrating to/from GoToSocial and a different ActivityPub server since that's really not supported
  • Adds a section about using backup software and provides an example on how to do this using Borgmatic

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@daenney daenney mentioned this pull request Jul 3, 2023
9 tasks
@NyaaaWhatsUpDoc
Copy link
Member

Looks great! A few comments, but otherwise good to me :). Once that other PR is in so the local media backup section can be updated (if that's good with you) we should be able to merge this.

@tsmethurst
Copy link
Contributor

Cool! This looks good to me, valuable contribution. Feel free to merge once you're both happy with it, i reckon :)

@daenney
Copy link
Member Author

daenney commented Jul 5, 2023

I've pushed some updates, including a little script people can use to transform the output into Borg patterns. This is all pending #1943, otherwise it doesn't make any sense.

This changes the existing backup documentation to:

* Push a bit harder on people to perform backups, it's not really just a
  nice to have
* Removes the language about migrating to/from GoToSocial and a
  different ActivityPub server since that's really not supported
* Adds a section about using backup software and provides an example on
  how to do this using Borgmatic
This adds documentation pointing people at the media list-local command
in order to determine what media files they need to include as part of
their backups.

Provides a Python script that people can use to transform the media
listing from the CLI into Borg patterns. It also includes a Borgmatic
config.yaml in the repository so people can easily fetch it instead of
copy-pasting from the docs.
It works either way, as a pattern like data/files/<ID> would match a
file on /data/files/<ID>. But it would potentially also match any path
that happens to include data/files/<ID> but not rooted at the
storage-local-base-path.
@tsmethurst
Copy link
Contributor

Now that #1943 is squerged, should i squerge this too? 👀

@daenney
Copy link
Member Author

daenney commented Jul 7, 2023

Yup. I just rebased it and fixed a few links.

@tsmethurst tsmethurst merged commit 9ff4c20 into superseriousbusiness:main Jul 7, 2023
2 checks passed
@daenney daenney deleted the docs-backup branch July 7, 2023 09:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants