Updates How to backup your Hubs instance#230
Merged
Exairnous merged 9 commits intoSep 26, 2025
Merged
Conversation
What: Changes the How to backup your Hubs instance instructions. Removes instructions that utilized DigitalOcean backups and snapshots. Adds backup and restore instructions. Adds a couple of possible error messages and what to do. Why: Upgrade of Hubs Community Edition will utilize a different DigitalOcean storage solution which makes DigitalOcean backups and snapshots useless. Additionally, these instructions place a copy of the Hubs data directly on the user's computer, which could be retrieved in case of errors at DigitalOcean. Note: commit does modify images 1 through 6, as appropriate. Commit does not delete images 7 through 12 from the previous version. I didn't know how to delete those now unneeded files.
What: Fixes Markdown text for headings and adds a space that was needed (typo) Why: Only formatting changes. I forgot to do a preview check yesterday. Note: Any comments/reviews welcome.
…n times Why: So users don't panic if backup or restore doesn't go as fast as in our testing
Exairnous
requested changes
Sep 16, 2025
Member
Exairnous
left a comment
Exairnous
left a comment
There was a problem hiding this comment.
Looks mostly good, but I left notes about a couple typos and one small change we might want to consider.
| ## **How to do a backup** | ||
|
|
||
| 1\. At Digital Ocean, select **Backups & Snapshots**. | ||
| 1. Open VS Code. Make sure you are in the community-edition folder. This is similar to [the Beginner's Guide, Step 12h](https://docs.hubsfoundation.org/beginners-guide-to-CE.html#12-generate-your-config-file). |
Member
There was a problem hiding this comment.
There's a trailing space at the end of this line that should be removed.
Suggested change
| 1. Open VS Code. Make sure you are in the community-edition folder. This is similar to [the Beginner's Guide, Step 12h](https://docs.hubsfoundation.org/beginners-guide-to-CE.html#12-generate-your-config-file). | |
| 1. Open VS Code. Make sure you are in the community-edition folder. This is similar to [the Beginner's Guide, Step 12h](https://docs.hubsfoundation.org/beginners-guide-to-CE.html#12-generate-your-config-file). |
| ## **How to restore a backup** | ||
|
|
||
| ## **Restoring your Hubs data from a Snapshot** | ||
| 1. Open VS Code. Be sure to be in the community-edition folder. These instructions will, by default, restore the latest or most recent backup. |
Member
There was a problem hiding this comment.
There's a trailing space at the end of this line that should be removed.
Suggested change
| 1. Open VS Code. Be sure to be in the community-edition folder. These instructions will, by default, restore the latest or most recent backup. | |
| 1. Open VS Code. Be sure to be in the community-edition folder. These instructions will, by default, restore the latest or most recent backup. |
Comment on lines
+66
to
+68
| ## **After Restoring** | ||
|
|
||
| It will take a short while for everything to be restored. DO might indicate that the droplet is available and running but it takes a few minutes for Hubs to restart itself. If you try your Hubs immediately, you will get broken webpages. | ||
| It will take a short while for everything to be restored. It takes a few minutes for Hubs to restart itself. |
Member
There was a problem hiding this comment.
Looking at this again now, do we need the "After Restoring" section anymore, given that just above we say that "Your instance is back up and running. All of your data should be there."?
Collaborator
Author
There was a problem hiding this comment.
Perhaps modify the section to a note within the section just above.
Member
You can stage deleted files by using |
What: Deletes trailing spaces, moves comment about Hubs taking time to restart into the How to Restore Step 4 (last step) section. Deletes images 7-12. Why: Fixes typos, clarifies what the "few minutes" is addressing besides the fact that the Terminal will return an 'instance restarted' notification. Images 7-12 were mostly DO captures of Backups and Snapshots which are now unneeded in these instructions. Note: addresses comments from review. Thank you!
What: Deletes trailing spaces, moves comment about Hubs taking time to restart into the How to Restore Step 4 (last step) section. Deletes images 7-12. Why: Fixes typos, clarifies what the "few minutes" is addressing besides the fact that the Terminal will return an 'instance restarted' notification. Images 7-12 were mostly DO captures of Backups and Snapshots which are now unneeded in these instructions. Note: addresses comments from review. Thank you!
What: Removes 2 trainling spaces. Modifies the After Restoring section by tightening wording about any time delay. Modifies OUT reference to DO in page description. Why: Trailing spaces annoy Exairnous. Restoring section tries to clarify that Hubs instance is back up but that it does take a little time--moments -- for a user to access it to find their instance is fully online. Note: I didn't spot the page description problem until this review. Prior description emphasized backups at DO. The new method does not. Therefore, removed Kubernetes wording and mention of DO. Please review and thank you.
Collaborator
Author
|
Oops. Good news! The rebase command did get me back to a logical place to submit my commit changes! Bad news. Instead of submitting one commit (which I thought was all I had), three commits came in: two from my prior attempts and one more that actually does change one more tiny thing. Oh well. Anything worth doing is worth doing three times...isn't that the phrase? |
What: Fixes typos of trailing spaces, fixes numbering, rewords some awkward parts. Why: Trailing spaces have a specific meaning and they were not needed in this case. Numbering was wrong. Address the "could take hours" phrase which did not read well in one case. Note: Please review. Thank you.
Exairnous
reviewed
Sep 25, 2025
Member
Exairnous
left a comment
Exairnous
left a comment
There was a problem hiding this comment.
Left a couple comments (now that I've had a chance to read over this again). Feel free to address or ignore. Either way, it looks good to me and can be merged at the time of release.
| ## **How to restore a backup** | ||
|
|
||
| > 💡 Tip: Snapshots do backup volumes. Automated backups do not. These are not persistent volumes; these are extra volumes for off node storage that a user might purchase. | ||
| 1. Open VS Code. Be sure to be in the community-edition folder. These instructions will, by default, restore the latest or most recent backup. |
Member
There was a problem hiding this comment.
Should we link to the Beginner's Guide here (when talking about being in the community-edition folder), the same as we do up above (or reference the link above)?
Exairnous
approved these changes
Sep 25, 2025
Incorporates suggestion. Co-authored-by: Exairnous <mythologylover75@gmail.com>
What: Adds more depth to Why section. Adds a link and image to start of Restore section so that instance matches the Backup section. Why: Alignment and tweaks based on review.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What?
Changes the How to backup your Hubs instance instructions. Removes instructions that utilized DigitalOcean backups and snapshots. Adds backup and restore instructions. Adds a couple of possible error messages and what to do.
Why?
Upgrade of Hubs Community Edition will utilize a different DigitalOcean storage solution which makes DigitalOcean backups and snapshots useless. Additionally, these instructions place a copy of the Hubs data directly on the user's computer, which could be retrieved in case of errors at DigitalOcean.
Limitations
Did not know how to stage deleted image files. But if the Markdown doesn't pull them, does it matter??
Alternatives considered
Hubs CE as of this writing does not create backups. We've depended for one year on DigitalOcean backups and snapshots. We've had reports of success and failures with those. Additionally, they cost extra at DO.
The "upgrade" of Hubs CE coming soon (September 2025) will actually make DigitalOcean backups and snapshots completely unusable. So there basically will be NO other option for backups other than this method unless users want to risk losing all of their custom Hubs CE data (avatar, scenes, logos, etc.)
Also, we remembered that we are expecting Hubs newbies to do this process, hopefully at least once. There will be some users that might need to pull backups more frequently. So the instructions here are simple, but they assume that users can use a Terminal window and enter commands.
Open questions
Commit does modify images 1 through 6, as appropriate. Commit does not delete images 7 through 12 from the previous Hubs docs image folder. I didn't know how to delete and then "stage" those now unneeded files.
Additional details or related context
Approval and merging of this PR is expected at the same time that the Hubs CE code is upgraded Hubs-Foundation/hubs-cloud#387 #231 #232 #234