readme

SEAPUNK · May 13, 2024 · 890ec5f · 890ec5f
1 parent fa82208
commit 890ec5f
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,17 @@
 # atsugami
+
+a booru viewer
+
+## install
+
+(so far,) the easiest way to run it locally is to use docker:
+
+```sh
+docker run \
+  -e PROXY_SECRET=$(openssl rand -hex 32) \
+  -p 55600:55600 \
+  --name atsugami \
+  ghcr.io/seapunk/atsugami:latest
+```
+
+this will start atsugami and have a web server running on port 55600