From 0e01ecb001dcd918ccbf430f7441053dff175144 Mon Sep 17 00:00:00 2001 From: Zed Date: Mon, 27 Dec 2021 02:23:24 +0100 Subject: [PATCH] Add more readme headers --- README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b6fa670..e90e58d 100644 --- a/README.md +++ b/README.md @@ -100,7 +100,9 @@ using the systemd service below. You should run Nitter behind a reverse proxy such as [Nginx](https://github.com/zedeus/nitter/wiki/Nginx) or Apache for security reasons. -To run Nitter with docker, you will need to install Redis before you run these commands. +### Docker + +To run Nitter with Docker, you'll need to install Redis before you run these commands. To build and run Nitter in Docker: ```bash @@ -121,6 +123,8 @@ docker-compose up -d Note the Docker commands expect a `nitter.conf` file in the directory you run them. +### systemd + To run Nitter via systemd you can use this service file: ```ini @@ -150,6 +154,8 @@ WantedBy=multi-user.target Then enable and run the service: `systemctl enable --now nitter.service` +### Logging + Nitter currently prints some errors to stdout, and there is no real logging implemented. If you're running Nitter with systemd, you can check stdout like this: `journalctl -u nitter.service` (add `--follow` to see just the last 15