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

Add documentation for common PostgreSQL tasks common to NetBox administration #1510

New Issue
Closed
opened 2025-12-29 16:32:34 +01:00 by adam · 4 comments
adam commented 2025-12-29 16:32:34 +01:00
Owner
Copy Link

Originally created by @bdlamprecht on GitHub (Jan 25, 2018).

Issue type

[ ] Feature request
[ ] Bug report
[X] Documentation

Environment

N/A

Description

A comment in the NetworkToCode Slack channel took place yesterday about "network folks that are still trying to get the hang of the API/Programming world" and managing installations of NetBox.

I think it would be a good idea to provide some documented examples of common DB tasks related to the administration of NetBox. I'm thinking something like a FAQ section would be the correct location but am open to other suggestions.

As a newcomer myself to the scene, I know I have to frequently use my GoogleFu to look up how to do the following tasks (and I don't think I'm alone in the regard):

  1. How to backup the PostgreSQL DB correctly ideally using DigitalOcean Spaces (have to give a plug for your employer who allows you time to develop NetBox 💯) or Amazon S3
  2. How to migrate from a development installation of NetBox to production installation (i.e. including custom_fields that have been defined and tested in a specific environment)

Not sure how common this one is, but I'll include it to be thorough.

  1. How to "dump" the just schema of the DB for migrations, etc.

I'd be happy to submit a PR with what I recently learned on those three topics if you think it would be a good idea to include that in the official documentation on ReadTheDocs. Additionally, perhaps there are more than just those mentioned above which would be important to include as well.

Originally created by @bdlamprecht on GitHub (Jan 25, 2018). ### Issue type [ ] Feature request <!-- An enhancement of existing functionality --> [ ] Bug report <!-- Unexpected or erroneous behavior --> [X] Documentation <!-- A modification to the documentation --> ### Environment N/A ### Description A comment in the `NetworkToCode` Slack channel took place yesterday about "network folks that are still trying to get the hang of the API/Programming world" and managing installations of NetBox. I think it would be a good idea to provide some documented examples of common DB tasks related to the administration of NetBox. I'm thinking something like a `FAQ` section would be the correct location but am open to other suggestions. As a newcomer myself to the scene, I know I have to frequently use my `GoogleFu` to look up how to do the following tasks (and I don't think I'm alone in the regard): 1. How to backup the PostgreSQL DB correctly ideally using DigitalOcean `Spaces` (have to give a plug for your employer who allows you time to develop NetBox :100:) or Amazon `S3` 2. How to migrate from a development installation of NetBox to production installation (i.e. including `custom_fields` that have been defined and tested in a specific environment) Not sure how common this one is, but I'll include it to be thorough. 3. How to "dump" the just schema of the DB for migrations, etc. I'd be happy to submit a PR with what I recently learned on those three topics if you think it would be a good idea to include that in the official documentation on `ReadTheDocs`. Additionally, perhaps there are more than just those mentioned above which would be important to include as well.
adam added the status: acceptedtype: documentation labels 2025-12-29 16:32:34 +01:00
adam closed this issue 2025-12-29 16:32:34 +01:00
adam commented 2025-12-29 16:32:34 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 27, 2018):

I'm okay with this, but let's be cognizant of scope creep. I want to avoid overextending the scope of our documentation covering information that's readily available elsewhere.

@jeremystretch commented on GitHub (Jan 27, 2018): I'm okay with this, but let's be cognizant of scope creep. I want to avoid overextending the scope of our documentation covering information that's readily available elsewhere.
adam commented 2025-12-29 16:32:35 +01:00
Author
Owner
Copy Link

@bdlamprecht commented on GitHub (Jan 27, 2018):

Yeah, I completely agree that we shouldn't duplicate what is already available.

Do you think that a FAQ would be an appropriate place to document this?
Are there other things you or other people would like to see included besides the three I mentioned above?

@bdlamprecht commented on GitHub (Jan 27, 2018): Yeah, I completely agree that we shouldn't duplicate what is already available. Do you think that a FAQ would be an appropriate place to document this? Are there other things you or other people would like to see included besides the three I mentioned above?
adam commented 2025-12-29 16:32:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jan 27, 2018):

I'd prefer to avoid a FAQ format in the official docs and maybe establish a "general administration" section of the docs, or something in that vein. We do have a FAQ on GitHub but that pertains more to maintenance of the project rather than NetBox itself.

@jeremystretch commented on GitHub (Jan 27, 2018): I'd prefer to avoid a FAQ format in the official docs and maybe establish a "general administration" section of the docs, or something in that vein. We do have a FAQ on GitHub but that pertains more to maintenance of the project rather than NetBox itself.
adam commented 2025-12-29 16:32:35 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Jul 27, 2018):

I've added an "administration" section to the v2.4 docs, which includes instructions for replicating NetBox. We'll likely add other common tasks over time.

@jeremystretch commented on GitHub (Jul 27, 2018): I've added an "administration" section to the v2.4 docs, which includes instructions for replicating NetBox. We'll likely add other common tasks over time.
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 status: accepted type: documentation
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#1510
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?