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

Update readme

Browse source
This commit is contained in:
Zed 2020-06-01 13:36:10 +02:00
parent 43e87f5174
commit 4a43209386
2 changed files with 24 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
README.md
View file

@ -9,7 +9,7 @@ Inspired by the [invidio.us](https://github.com/omarroth/invidious) project.
- All requests go through the backend, client never talks to Twitter - All requests go through the backend, client never talks to Twitter
- Prevents Twitter from tracking your IP or JavaScript fingerprint - Prevents Twitter from tracking your IP or JavaScript fingerprint
- Unofficial API (no rate limits or developer account required) - Unofficial API (no rate limits or developer account required)
- Lightweight (for [@nim_lang](https://nitter.net/nim_lang), 36KB vs 580KB from twitter.com) - Lightweight (for [@nim_lang](https://nitter.net/nim_lang), 58KB vs 784KB from twitter.com)
- RSS feeds - RSS feeds
- Themes - Themes
- Mobile support (responsive design) - Mobile support (responsive design)
@ -18,7 +18,7 @@ Inspired by the [invidio.us](https://github.com/omarroth/invidious) project.
## Todo (roughly in this order) ## Todo (roughly in this order)
- Embeds - Embeds
- Caching + archiving tweets/profiles - Archiving tweets/profiles
- Simple account system with customizable feed - Simple account system with customizable feed
- Json API endpoints - Json API endpoints
- Emoji support (WIP, uses native font for now) - Emoji support (WIP, uses native font for now)
@ -36,12 +36,14 @@ It's basically impossible to use Twitter without JavaScript enabled. If you try,
you're redirected to the legacy mobile version which is awful both functionally you're redirected to the legacy mobile version which is awful both functionally
and aesthetically. For privacy-minded folks, preventing JavaScript analytics and and aesthetically. For privacy-minded folks, preventing JavaScript analytics and
potential IP-based tracking is important, but apart from using the legacy mobile potential IP-based tracking is important, but apart from using the legacy mobile
version and a VPN, it's impossible. version and a VPN, it's impossible. This is is especially relevant now that Twitter
[removed the ability](https://www.eff.org/deeplinks/2020/04/twitter-removes-privacy-option-and-shows-why-we-need-strong-privacy-laws)
for users to control whether their data gets sent to advertisers.
Using an instance of Nitter (hosted on a VPS for example), you can browse Using an instance of Nitter (hosted on a VPS for example), you can browse
Twitter without JavaScript while retaining your privacy. In addition to Twitter without JavaScript while retaining your privacy. In addition to
respecting your privacy, Nitter is on average around 15 times lighter than respecting your privacy, Nitter is on average around 15 times lighter than
Twitter, and in some cases serves pages faster. Twitter, and in most cases serves pages faster (eg. timelines 2-4x faster).
In the future a simple account system will be added that lets you follow Twitter In the future a simple account system will be added that lets you follow Twitter
users, allowing you to have a clean chronological timeline without needing a users, allowing you to have a clean chronological timeline without needing a
@ -57,8 +59,16 @@ 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
install it system-wide or in the user directory you create below. install it system-wide or in the user directory you create below.
You also need to install `libsass` to compile the scss files. On Ubuntu and To compile the scss files, you need to install `libsass`. On Ubuntu and Debian,
Debian, you can use `libsass-dev`. you can use `libsass-dev`.
Redis is required for caching and in the future for account info. It should be
available on most distros as `redis` or `redis-server` (Ubuntu/Debian).
Running it with the default config is fine, Nitter's default config is set to
use the default Redis port and localhost.
Here's how to create a `nitter` user, clone the repo, and build the project
along with the scss.
```bash ```bash
# useradd -m nitter # useradd -m nitter
@ -70,10 +80,11 @@ $ nimble scss
$ mkdir ./tmp $ mkdir ./tmp
``` ```
Set your hostname, port, page title and HMAC key in `nitter.conf`, then run Set your hostname, port, HMAC key, https (must be correct for cookies), and
Nitter by executing `./nitter`. You should run Nitter behind a reverse proxy Redis info in `nitter.conf`, run `redis-server --daemonize yes`, then run Nitter
such as [Nginx](https://github.com/zedeus/nitter/wiki/Nginx) or Apache for by executing `./nitter`. You should run Nitter behind a reverse proxy such as
better security. [Nginx](https://github.com/zedeus/nitter/wiki/Nginx) or Apache for security
reasons.
To build and run Nitter in Docker: To build and run Nitter in Docker:
```bash ```bash
@ -86,6 +97,8 @@ A prebuilt Docker image is provided as well:
docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d -p 8080:8080 zedeus/nitter:latest docker run -v $(pwd)/nitter.conf:/src/nitter.conf -d -p 8080:8080 zedeus/nitter:latest
``` ```
Note the Docker commands expect a `nitter.conf` file in the directory you run them.
To run Nitter via systemd you can use this service file: To run Nitter via systemd you can use this service file:
```bash ```bash

1
src/nitter.nim
View file

@ -15,6 +15,7 @@ let (cfg, fullCfg) = getConfig(configPath)
updateDefaultPrefs(fullCfg) updateDefaultPrefs(fullCfg)
setCacheTimes(cfg) setCacheTimes(cfg)
setHmacKey(cfg.hmacKey) setHmacKey(cfg.hmacKey)
initRedisPool(cfg) initRedisPool(cfg)
asyncCheck initTokenPool(cfg) asyncCheck initTokenPool(cfg)