Cynosphere/nitter
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Add more readme headers

Browse source
This commit is contained in:
Zed 2021-12-27 02:23:24 +01:00
parent 38df06e8f5
commit 0e01ecb001
1 changed files with 7 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -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 such as [Nginx](https://github.com/zedeus/nitter/wiki/Nginx) or Apache for
security reasons. 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: To build and run Nitter in Docker:
```bash ```bash
@ -121,6 +123,8 @@ docker-compose up -d
Note the Docker commands expect a `nitter.conf` file in the directory you run them. 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: To run Nitter via systemd you can use this service file:
```ini ```ini
@ -150,6 +154,8 @@ WantedBy=multi-user.target
Then enable and run the service: Then enable and run the service:
`systemctl enable --now nitter.service` `systemctl enable --now nitter.service`
### Logging
Nitter currently prints some errors to stdout, and there is no real 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 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 this: `journalctl -u nitter.service` (add `--follow` to see just the last 15