starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

The documentation is missing a "How to backup and restore" section #3112

New Issue
Closed
opened 2025-12-29 18:25:45 +01:00 by adam · 4 comments
adam commented 2025-12-29 18:25:45 +01:00
Owner
Copy Link

Originally created by @991jo on GitHub (Jan 3, 2020).

Change Type

[X] Addition
[ ] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Proposed Changes

Currently the netbox documentation does not include a section on what has to be backup to restore a complete netbox installation.
I do not propose that netbox should consider the exact commands because depending on how you may or may not automate your netbox installation those may vary.
But a list of all things that have to be considered would be nice.

  • Is everything that is relevant contained in the psql database?
  • Or is there something in redis that wants to be backed up?
  • Do I have to backup the SECRET_KEY from the config?
  • Where is the master key used to store secrets?
  • What about reports, media and scripts?
  • Are there any other things?

I think that backing up netbox is a very important topic because as a single source of truth the impact of data loss might be a catastrophe. Adding a "How to backup" section to the configuration that tells me what is important would give me a lot of confidence in my netbox installation.

A related issue might be: https://github.com/netbox-community/netbox/issues/567

Originally created by @991jo on GitHub (Jan 3, 2020). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [X] Addition [ ] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes Currently the netbox documentation does not include a section on what has to be backup to restore a complete netbox installation. I do not propose that netbox should consider the exact commands because depending on how you may or may not automate your netbox installation those may vary. But a list of all things that have to be considered would be nice. - Is everything that is relevant contained in the psql database? - Or is there something in redis that wants to be backed up? - Do I have to backup the SECRET_KEY from the config? - Where is the master key used to store secrets? - What about reports, media and scripts? - Are there any other things? I think that backing up netbox is a very important topic because as a single source of truth the impact of data loss might be a catastrophe. Adding a "How to backup" section to the configuration that tells me what is important would give me a lot of confidence in my netbox installation. A related issue might be: https://github.com/netbox-community/netbox/issues/567
adam closed this issue 2025-12-29 18:25:45 +01:00
adam commented 2025-12-29 18:25:46 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 3, 2020):

Replicating NetBox is documented here.

@jeremystretch commented on GitHub (Jan 3, 2020): Replicating NetBox is documented [here](https://netbox.readthedocs.io/en/stable/administration/replicating-netbox/).
adam commented 2025-12-29 18:25:46 +01:00
Author
Owner
Copy Link

@991jo commented on GitHub (Jan 7, 2020):

If this is the guide that tells me how to backup my netbox installtion then the word "backup" should be found somewhere on that page. Someone who searches for "backup" in the documentation does not find this site.

@991jo commented on GitHub (Jan 7, 2020): If this is the guide that tells me how to backup my netbox installtion then the word "backup" should be found somewhere on that page. Someone who searches for "backup" in the documentation does not find this site.
adam commented 2025-12-29 18:25:47 +01:00
Author
Owner
Copy Link

@LBegnaud commented on GitHub (Jan 7, 2020):

But that isn't how to back it up. That documentation instructs how to create a new netbox instance with an existing netbox as a seed of data. Backups would be best done following standard practices likely of VM-level snapshots with maybe rolling pg_dumps into a directory. you could use that above doc as a guide to know what needs to be backed up, though.

@LBegnaud commented on GitHub (Jan 7, 2020): But that isn't how to back it up. That documentation instructs how to create a new netbox instance with an existing netbox as a seed of data. Backups would be best done following standard practices likely of VM-level snapshots with maybe rolling pg_dumps into a directory. you could use that above doc as a guide to know what needs to be backed up, though.
adam commented 2025-12-29 18:25:47 +01:00
Author
Owner
Copy Link

@hSaria commented on GitHub (Jan 7, 2020):

I think that's out of scope because it isn't related to NetBox. Backing up your OS/VM/Container and/or your database is not application-dependent; they're things you would do in your own infrastructure.

@hSaria commented on GitHub (Jan 7, 2020): I think that's out of scope because it isn't related to NetBox. Backing up your OS/VM/Container and/or your database is not application-dependent; they're things you would do in your own infrastructure.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#3112
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?