starred/audiobookshelf
1
0
Fork 0
mirror of https://github.com/advplyr/audiobookshelf.git synced 2026-05-30 23:40:40 +02:00
Code Issues 1.0k Packages Projects Releases 10 Wiki Activity

[Enhancement]: Add link to backup guide #1550

New Issue
Open
opened 2026-04-24 23:49:49 +02:00 by adam · 2 comments
adam commented 2026-04-24 23:49:49 +02:00
Owner
Copy Link
Copy Source

Originally created by @nichwall on GitHub (Nov 26, 2023).

Describe the feature/enhancement

Add a button in the backups page to link to the backups guide. There isn't a lot of extra information on the guide, but would be good to standardized things linking to existing guides.

https://www.audiobookshelf.org/guides/migration-and-backups

Screenshot_20231126-075007

Originally created by @nichwall on GitHub (Nov 26, 2023). ### Describe the feature/enhancement Add a button in the backups page to link to the backups guide. There isn't a lot of extra information on the guide, but would be good to standardized things linking to existing guides. https://www.audiobookshelf.org/guides/migration-and-backups ![Screenshot_20231126-075007](https://github.com/advplyr/audiobookshelf/assets/5686638/efc1216c-49b8-4567-9379-77d1cfaea2e8)
adam added the enhancement label 2026-04-24 23:49:49 +02:00
adam commented 2026-04-24 23:49:49 +02:00
Author
Owner
Copy Link
Copy Source

@advplyr commented on GitHub (Nov 26, 2023):

I could see that guide adding confusion if linking from that page because the guide doesn't explain anything on the page specifically. If we have a separate section on that guide discussing the normal backup creation and restore then we could link to that.
For most users now they will just need to press the "Restore" button to restore a backup created on v2.3.x or up. Any backup created on v2.2.x or below is going to show an error message there and not allow it to be restored through the UI. At this point it should be pretty rare that users need to touch the filesystem for a backup.

@advplyr commented on GitHub (Nov 26, 2023): I could see that guide adding confusion if linking from that page because the guide doesn't explain anything on the page specifically. If we have a separate section on that guide discussing the normal backup creation and restore then we could link to that. For most users now they will just need to press the "Restore" button to restore a backup created on v2.3.x or up. Any backup created on v2.2.x or below is going to show an error message there and not allow it to be restored through the UI. At this point it should be pretty rare that users need to touch the filesystem for a backup.
adam commented 2026-04-24 23:49:50 +02:00
Author
Owner
Copy Link
Copy Source

@nichwall commented on GitHub (Nov 26, 2023):

That's fair. I agree the existing guide won't apply to many people since most people have already upgraded or are new users, but don't want to rewrite it yet since there are still people who are on 2.2.x (and may not update for a while).

I don't want to have two different "restore from backup guides", so maybe switching the backup and migration sections so the backup is at the top and seen first. Then it can better explain the specific backups page, then go into the migration issues further down for users it applies to. I'll take a stab at rewriting it.

@nichwall commented on GitHub (Nov 26, 2023): That's fair. I agree the existing guide won't apply to many people since most people have already upgraded or are new users, but don't want to rewrite it yet since there are still people who are on 2.2.x (and may not update for a while). I don't want to have two different "restore from backup guides", so maybe switching the backup and migration sections so the backup is at the top and seen first. Then it can better explain the specific backups page, then go into the migration issues further down for users it applies to. I'll take a stab at rewriting it.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
authentication
backlog
bug
chapter editor
config-issue
ebooks
encoding/embedding
enhancement
help wanted
listening sessions & progress
planned
possible plugin
progress sync
pull-request
Mirrored from GitHub Pull Request
 sorting/filtering/searching
unable to reproduce
upload
users & permissions
waiting
No Label enhancement
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam (Adam Melkus)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/audiobookshelf#1550
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?