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

Format readme

Browse source
This commit is contained in:
zedeus 2022-06-09 09:34:06 +02:00
parent 5cceca4e93
commit 74c13b372d
1 changed files with 8 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -34,7 +34,7 @@ XMR: 42hKayRoEAw4D6G6t8mQHPJHQcXqofjFuVfavqKeNMNUZfeJLJAcNU19i1bGdDvcdN6romiSscW
## Resources ## Resources
The wiki contains The wiki contains
[a list of instances](https://github.com/zedeus/nitter/wiki/Instances) and [a list of instances](https://github.com/zedeus/nitter/wiki/Instances) and
[browser extensions](https://github.com/zedeus/nitter/wiki/Extensions) [browser extensions](https://github.com/zedeus/nitter/wiki/Extensions)
maintained by the community. maintained by the community.
@ -67,9 +67,10 @@ Twitter account.
## Installation ## Installation
### Dependencies ### Dependencies
* libpcre
* libsass - libpcre
* redis - libsass
- redis
To compile Nitter you need a Nim installation, see To compile Nitter you need a Nim installation, see
[nim-lang.org](https://nim-lang.org/install.html) for details. It is possible to [nim-lang.org](https://nim-lang.org/install.html) for details. It is possible to
@ -115,18 +116,21 @@ before you can run the container. See below for how to also run Redis using
Docker. Docker.
To build and run Nitter in Docker: To build and run Nitter in Docker:
```bash ```bash
docker build -t nitter:latest . docker build -t nitter:latest .
docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d --network host nitter:latest docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d --network host nitter:latest
``` ```
A prebuilt Docker image is provided as well: A prebuilt Docker image is provided as well:
```bash ```bash
docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d --network host zedeus/nitter:latest docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d --network host zedeus/nitter:latest
``` ```
Using docker-compose to run both Nitter and Redis as different containers: Using docker-compose to run both Nitter and Redis as different containers:
Change `redisHost` from `localhost` to `nitter-redis` in `nitter.conf`, then run: Change `redisHost` from `localhost` to `nitter-redis` in `nitter.conf`, then run:
```bash ```bash
docker-compose up -d docker-compose up -d
``` ```