|
@@ -0,0 +1,53 @@
|
|
|
|
|
+# 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
|
|
|
|
|
+
|
|
|
|
|
+```no-highlight
|
|
|
|
|
+pg_dump netbox > netbox.sql
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+## Load an Exported Database
|
|
|
|
|
+
|
|
|
|
|
+!!! warning
|
|
|
|
|
+ This will destroy and replace any existing instance of the database.
|
|
|
|
|
+
|
|
|
|
|
+```no-highlight
|
|
|
|
|
+psql -c 'drop database netbox'
|
|
|
|
|
+psql -c 'create database netbox'
|
|
|
|
|
+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
|
|
|
|
|
+
|
|
|
|
|
+If you want to export only the database schema, and not the data itself (e.g. for development reference), do the following:
|
|
|
|
|
+
|
|
|
|
|
+```no-highlight
|
|
|
|
|
+pg_dump -s netbox > netbox_schema.sql
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+# 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
|
|
|
|
|
+
|
|
|
|
|
+Execute the following command from the root of the NetBox installation path (typically `/opt/netbox`):
|
|
|
|
|
+
|
|
|
|
|
+```no-highlight
|
|
|
|
|
+tar -czf netbox_media.tar.gz netbox/media/
|
|
|
|
|
+```
|
|
|
|
|
+
|
|
|
|
|
+## Restore the Media Directory
|
|
|
|
|
+
|
|
|
|
|
+To extract the saved archive into a new installation, run the following from the installation root:
|
|
|
|
|
+
|
|
|
|
|
+```no-highlight
|
|
|
|
|
+tar -xf netbox_media.tar.gz
|
|
|
|
|
+```
|