|
|
@@ -13,8 +13,9 @@ Inspired by the [invidio.us](https://github.com/omarroth/invidious) project.
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
-You need to install nim on your system: https://nim-lang.org/install.html
|
|
|
-It is possible to install nim system wide or in the user directory you create below.
|
|
|
+To compile Nitter you need a Nim installation, see here for details: https://nim-lang.org/install.html
|
|
|
+You also need to install `libsass` to compile the scss files.
|
|
|
+It is possible to install Nim system-wide or in the user directory you create below.
|
|
|
|
|
|
```bash
|
|
|
# useradd -m nitter
|
|
|
@@ -22,16 +23,15 @@ It is possible to install nim system wide or in the user directory you create be
|
|
|
$ git clone https://github.com/zedeus/nitter
|
|
|
$ cd nitter
|
|
|
$ nimble build -d:release
|
|
|
+$ nimble scss
|
|
|
$ mkdir ./tmp
|
|
|
```
|
|
|
|
|
|
-To run nitter, execute `./nitter`. It's currently not possible to change any settings or things
|
|
|
-like the title, this will change as the project matures a bit. For now the focus
|
|
|
-is on implementing missing features.
|
|
|
+Set your port and page title in `nitter.conf`, then run Nitter by executing `./nitter`.
|
|
|
+You should run Nitter behind a reverse proxy such as nginx or Apache for better
|
|
|
+security.
|
|
|
|
|
|
-You should put nitter behind a reverse proxy with e.g. nginx or apache.
|
|
|
-
|
|
|
-It is also possible to run nitter via systemd:
|
|
|
+To run Nitter via systemd you can use this service file:
|
|
|
|
|
|
```bash
|
|
|
[Unit]
|
|
|
@@ -57,7 +57,7 @@ RestartSec=15
|
|
|
WantedBy=multi-user.target
|
|
|
```
|
|
|
|
|
|
-Then enable and start
|
|
|
+Then enable and run the service:
|
|
|
`systemctl enable --now nitter.service`
|
|
|
|
|
|
## Todo (roughly in this order)
|
|
|
@@ -77,13 +77,22 @@ 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
|
|
|
and aesthetically. For privacy-minded folks, preventing JavaScript analytics and
|
|
|
potential IP-based tracking is important, but apart from using the legacy mobile
|
|
|
-version and a VPN, it's impossible. Using an instance of Nitter (hosted on a VPS
|
|
|
-for example), you can essentially browse Twitter without JavaScript, while
|
|
|
-retaining your privacy. In addition to respecting your privacy, Nitter is on
|
|
|
-average around 15 times lighter than Twitter, and in some cases serves pages
|
|
|
-faster. 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 Twitter account.
|
|
|
+version and a VPN, it's impossible.
|
|
|
+
|
|
|
+Using an instance of Nitter (hosted on a VPS
|
|
|
+for example), you can browse Twitter without JavaScript while retaining your
|
|
|
+privacy. In addition to respecting your privacy, Nitter is on average around 15
|
|
|
+times lighter than Twitter, and in some cases serves pages faster.
|
|
|
+
|
|
|
+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 Twitter
|
|
|
+account.
|
|
|
+
|
|
|
+## Contact
|
|
|
+
|
|
|
+Feel free to join our Freenode IRC channel at #nitter, or our
|
|
|
+[Matrix server](https://riot.im/app/#/room/#nitter:matrix.org).
|
|
|
|
|
|
## Screenshot
|
|
|
|
Zed