Browse Source

Add note about creating nitter.conf for Docker

Fixes #1392
Zed 3 months ago
parent
commit
6ab2143df0
1 changed files with 16 additions and 2 deletions
  1. 16 2
      README.md

+ 16 - 2
README.md

@@ -129,6 +129,17 @@ To run Nitter with Docker, you'll need to install and run Redis separately
 before you can run the container. See below for how to also run Redis using
 before you can run the container. See below for how to also run Redis using
 Docker.
 Docker.
 
 
+First create your config file. The Docker commands mount it into the container,
+so it has to exist on the host beforehand. If you've cloned the repo:
+
+```bash
+cp nitter.example.conf nitter.conf
+```
+
+If you're using the prebuilt image without a local clone, download
+[`nitter.example.conf`](https://raw.githubusercontent.com/zedeus/nitter/master/nitter.example.conf)
+and save it as `nitter.conf` instead.
+
 To build and run Nitter in Docker:
 To build and run Nitter in Docker:
 
 
 ```bash
 ```bash
@@ -151,8 +162,11 @@ Change `redisHost` from `localhost` to `nitter-redis` in `nitter.conf`, then run
 docker-compose up -d
 docker-compose up -d
 ```
 ```
 
 
-Note the Docker commands expect a `nitter.conf` file in the directory you run
-them.
+Note the Docker commands mount `nitter.conf` (and `sessions.jsonl` for
+docker-compose) from the directory you run them in. If a mounted file doesn't
+exist, Docker silently creates a directory in its place and the container fails
+with `not a directory: Are you trying to mount a directory onto a file`. Remove
+that directory and create the file as shown above.
 
 
 ### systemd
 ### systemd