From be4fbc5eca9fd7c62a64663590dd0aa34cc33870 Mon Sep 17 00:00:00 2001
From: Shihaam Abdul Rahman <shihaam@shihaam.me>
Date: Mon, 23 Jan 2023 14:16:27 +0500
Subject: [PATCH] added some readme

---
 README.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..c340d64
--- /dev/null
+++ b/README.md
@@ -0,0 +1,47 @@
+
+
+- Production `docker-compose.yml`
+
+```yaml
+version: '3.5'
+services:
+################################################
+   netbox:
+      image: git.shihaam.dev/dockerfiles/netbox
+      ports:
+         - 8000:8000
+      volumes:
+         - ./configuration.py:/opt/netbox/netbox/netbox/configuration.py
+      command: python manage.py runserver 0.0.0.0:8000 --insecure # COMMENT THIS LINE WHEN RUNNING IN PRODUCTION
+      depends_on:
+         - redis
+         - postgres
+################################################
+   postgres:
+      image: postgres:13-alpine
+      volumes:
+         - ./data/db:/var/lib/postgresql/data
+      environment:
+         - POSTGRES_DB=netbox
+         - POSTGRES_USER=netbox
+         - POSTGRES_PASSWORD=even-confider-closable
+      restart: always
+################################################
+   redis:
+      image: redis:6.0-alpine
+      restart: always
+```
+
+- save this as docker-compose.yml and run `docker compose up -d`
+
+## Some commands that will be useful
+- Migrate Database (required on initial install and upgrade
+```bash
+docker compose exec netbox ./manage.py migrate
+```
+- Create new Superuser account, (it might not show any output, just enter a username and press enter)
+```bash
+docker compose exec netbox ./manage.py createsuperuser
+```
+
+