From ae524019af95de4136da2d643b3fa83c734305ae Mon Sep 17 00:00:00 2001
From: Rishi Ghan <rishi.ghan@gmail.com>
Date: Mon, 28 Mar 2022 09:19:44 -0700
Subject: [PATCH] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20Added=20instructions=20for?=
 =?UTF-8?q?=20docker-compose?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md          | 14 ++++++++++++++
 docker-compose.env |  4 ++++
 2 files changed, 18 insertions(+)

diff --git a/README.md b/README.md
index 1a0c866..f4cd674 100644
--- a/README.md
+++ b/README.md
@@ -36,3 +36,17 @@ You can get one [here.](https://comicvine.gamespot.com/api/) Metadata scraping w
 
 1. Clone this repo
 2. Edit the `docker-compose.env` file
+   1. Find the hostname of your machine and set the `UNDERLYING_HOSTNAME` to that. For e.g. `UNDERLYING_HOSTNAME=foo`
+   2. Set the `COMICS_DIRECTORY` and `USERDATA_DIRECTORY` to the correct _absolute_ paths
+   3. Set the `COMICVINE_API` to your ComicVine API key
+3. Save the file
+4. Run the stack using: `env $(cat docker-compose.env | xargs) docker-compose up`
+
+
+## Troubleshooting
+
+General
+
+1. Some common problems can be traced to out-of-date images, and as such can be mitigated by simply pruning orphaned images: `docker system prune -a`
+2. 
+
diff --git a/docker-compose.env b/docker-compose.env
index 8c62c5c..0eefbe7 100644
--- a/docker-compose.env
+++ b/docker-compose.env
@@ -2,10 +2,14 @@ UNDERLYING_HOSTNAME=ghost
 COMICS_DIRECTORY=/Users/rishi/work/threetwo/comics
 USERDATA_DIRECTORY=/Users/rishi/work/threetwo/userdata
 
+COMICVINE_API_KEY=foobar
+
+
 LOGGER=true
 LOGLEVEL=info
 SERVICEDIR=dist/services
 
+UNRAR_BIN_PATH=
 MONGO_URI=mongodb://db:27017/threetwo
 REDIS_URI=redis://redis:6379
 TRANSPORTER=redis://redis:6379