From 252e9879ef67139b6d6f73cc7785677de26f675a Mon Sep 17 00:00:00 2001
From: theycallhermax <mdwalters.pm@proton.me>
Date: Sat, 1 Mar 2025 02:35:02 -0500
Subject: [PATCH] add docker instructions cleanup docker compose

---
 docker-compose.yml |  4 ++--
 docker.md          | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 36 insertions(+), 2 deletions(-)
 create mode 100644 docker.md

diff --git a/docker-compose.yml b/docker-compose.yml
index cdf3e6f..19e7f90 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -31,7 +31,7 @@ services:
       - "8000:8000"
     restart: always
     volumes:
-      - emoji-data:/catask/static/emojis
+      - catask-data:/catask/static/emojis
       - ./config.json:/catask/config.json
       - ./.env:/catask/.env
 
@@ -41,4 +41,4 @@ networks:
 
 volumes:
   db-data:
-  emoji-data:
+  catask-data:
diff --git a/docker.md b/docker.md
new file mode 100644
index 0000000..abc8da2
--- /dev/null
+++ b/docker.md
@@ -0,0 +1,34 @@
+# CatAsk on Docker (or Podman)
+
+## Prerequisites
+
+- Docker + `docker-compose` (or Podman + `podman-compose`)
+
+## Steps
+
+Before starting CatAsk, you must copy the configuration files to their proper places first:
+
+```sh
+cp config.example.json config.json
+cp .env.example .env
+```
+
+Then, paste this into the `.env` file, and replace sections that are marked with `[CHANGE THIS]`.
+
+```env
+DB_HOST = postgres
+DB_NAME = catask
+DB_USER = catask
+DB_PASS = catask
+DB_PORT = 5432
+ADMIN_PASSWORD = [CHANGE THIS]
+APP_SECRET = [CHANGE THIS]
+```
+
+You may now start CatAsk:
+
+```sh
+docker compose up
+```
+
+If you have done everything correctly, going to `http://localhost:8000` in your browser should show a question box screen. You may now log in with your admin password, and configure the instance.