mirror/netbox-community-netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2024-05-10 07:54:54 +00:00
Code Activity

Reset documentation hierarchy

Browse Source
This commit is contained in:
Jeremy Stretch
2020-03-05 17:23:56 -05:00
parent f89773f4a3
commit a7c133daa6
21 changed files with 110 additions and 76 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/administration/netbox-shell.md
View File

@@ -1,3 +1,5 @@
# The NetBox Python Shell
NetBox includes a Python shell within which objects can be directly queried, created, modified, and deleted. To enter the shell, run the following command:
```

16
docs/administration/replicating-netbox.md
View File

@@ -1,11 +1,13 @@
# Replicating the Database
# Replicating NetBox
## Replicating the Database
NetBox uses [PostgreSQL](https://www.postgresql.org/) for its database, so general PostgreSQL best practices will apply to NetBox. You can dump and restore the database using the `pg_dump` and `psql` utilities, respectively.
!!! note
The examples below assume that your database is named `netbox`.
## Export the Database
### Export the Database
Use the `pg_dump` utility to export the entire database to a file:
@@ -19,7 +21,7 @@ When replicating a production database for development purposes, you may find it
pg_dump --exclude-table-data=extras_objectchange netbox > netbox.sql
```
## Load an Exported Database
### Load an Exported Database
!!! warning
This will destroy and replace any existing instance of the database.
@@ -32,7 +34,7 @@ psql netbox < netbox.sql
Keep in mind that PostgreSQL user accounts and permissions are not included with the dump: You will need to create those manually if you want to fully replicate the original database (see the [installation docs](../installation/1-postgresql.md)). When setting up a development instance of NetBox, it's strongly recommended to use different credentials anyway.
## Export the Database Schema
### Export the Database Schema
If you want to export only the database schema, and not the data itself (e.g. for development reference), do the following:
@@ -47,11 +49,11 @@ python3 manage.py invalidate all
---
# Replicating Media
## Replicating Media
NetBox stored uploaded files (such as image attachments) in its media directory. To fully replicate an instance of NetBox, you'll need to copy both the database and the media files.
## Archive the Media Directory
### Archive the Media Directory
Execute the following command from the root of the NetBox installation path (typically `/opt/netbox`):
@@ -59,7 +61,7 @@ Execute the following command from the root of the NetBox installation path (typ
tar -czf netbox_media.tar.gz netbox/media/
```
## Restore the Media Directory
### Restore the Media Directory
To extract the saved archive into a new installation, run the following from the installation root: