public/geek-cookbook
1
0
Fork 0
mirror of https://github.com/funkypenguin/geek-cookbook/ synced 2025-12-12 17:26:19 +00:00
Code Issues Releases Wiki Activity

Add recipe for Nitter (#276)

Browse Source 
* Add recipe for Nitter

Signed-off-by: David Young <davidy@funkypenguin.co.nz>

* Add new status to Nitter

Signed-off-by: David Young <davidy@funkypenguin.co.nz>

---------

Signed-off-by: David Young <davidy@funkypenguin.co.nz>
This commit is contained in:
David Young
2023-03-15 13:54:36 +13:00
committed by GitHub
parent cf44acda27
commit 98ce09a173
7 changed files with 218 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
_snippets/common-links.md
View File

@@ -48,6 +48,7 @@
[nextcloud]: /recipes/nextcloud/
[nightscout]: /recipes/nightscout/
[nomie]: /recipes/nomie/
[nitter]: /recipes/nitter/
[nzbget]: /recipes/autopirate/nzbget/
[nzbhydra]: /recipes/autopirate/nzbhydra/
[ombi]: /recipes/autopirate/ombi/
@@ -70,6 +71,7 @@
[sabnzbd]: /recipes/autopirate/sabnzbd/
[searxng]: /recipes/searxng/
[sonarr]: /recipes/autopirate/sonarr/
[tiny-tiny-rss]: /recipes/tiny-tiny-rss/
[tfa-dex-static]: /docker-swarm/traefik-forward-auth/dex-static/
[tfa-google]: /docker-swarm/traefik-forward-auth/google/
[tfa-keycloak]: /docker-swarm/traefik-forward-auth/keycloak/

34
docs/blog/posts/changelog/new-recipe-nitter-swarm.md Normal file
View File

@@ -0,0 +1,34 @@
---
date: 2023-03-15
categories:
- CHANGELOG
tags:
- nitter
links:
- Nitter recipe: recipes/nitter.md
description: New Recipe Added - Nomie - quantified-self tracker with couchdb multi-device sync
title: Added recipe for Nitter on Docker Swarm
image: /images/nitter.png
recipe: Nitter
---
# Added recipe for {{ page.meta.recipe }} (swarm)
Are you becoming increasingly wary of Twitter, [post-space-Karen](https://knowyourmeme.com/editorials/guides/who-is-space-karen-and-why-is-the-nickname-trending-on-twitter)? Try Nitter, a (*read-only*) private frontend to Twitter, supporting username and keyword search, with geeky features like RSS and theming!
<!-- more -->
![Screenshot of {{ page.meta.recipe }}]({{ page.meta.image }}){ loading=lazy }
[Nitter](https://github.com/zedeus/nitter) is a free and open source alternative Twitter front-end focused on privacy and performance, with features including:
:white_check_mark: No JavaScript or ads<br/>
:white_check_mark: All requests go through the backend, client never talks to Twitter<br/>
:white_check_mark: Prevents Twitter from tracking your IP or JavaScript fingerprint<br/>
:white_check_mark: Uses Twitter's unofficial API (*no rate limits or developer account required*)<br/>
:white_check_mark: Lightweight (for @nim_lang, 60KB vs 784KB from twitter.com)<br/>
:white_check_mark: RSS feeds, Themes, Mobile support (*responsive design*)<br/>
See the [recipe][nitter] for more!
--8<-- "common-links.md"

BIN
docs/images/nitter.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 446 KiB

177
docs/recipes/nitter.md Normal file
View File

@@ -0,0 +1,177 @@
---
description: Neat one-sentence description of recipe for social media previews
recipe: Nitter
title: Short, punchy title for search engine results / social previews
image: /images/nitter.png
status: new
---
# {{ page.meta.recipe }} on Docker Swarm
Are you becoming increasingly wary of Twitter, [post-space-Karen](https://knowyourmeme.com/editorials/guides/who-is-space-karen-and-why-is-the-nickname-trending-on-twitter)? Try Nitter, a (*read-only*) private frontend to Twitter, supporting username and keyword search, with geeky features like RSS and theming!
!!! note "But what about Twitter's API Developer rules?"
In a [GitHub issue](https://github.com/zedeus/nitter/issues/783#issuecomment-1414810634) querying whether Nitter would be affected by Twitter's API schenanigans, developer @zedeus pointed out that Nitter uses an **unofficial** API, and responded concisely:
> I'm not bound by that developer agreement, so whatevs.
\*micdrop\*
![Screenshot of {{ page.meta.recipe }}]({{ page.meta.image }}){ loading=lazy }
[Nitter](https://github.com/zedeus/nitter) is a free and open source alternative Twitter front-end focused on privacy and performance, with features including:
:white_check_mark: No JavaScript or ads<br/>
:white_check_mark: All requests go through the backend, client never talks to Twitter<br/>
:white_check_mark: Prevents Twitter from tracking your IP or JavaScript fingerprint<br/>
:white_check_mark: Uses Twitter's unofficial API (*no rate limits or developer account required*)<br/>
:white_check_mark: Lightweight (for @nim_lang, 60KB vs 784KB from twitter.com)<br/>
:white_check_mark: RSS feeds, Themes, Mobile support (*responsive design*)<br/>
## {{ page.meta.recipe }} Requirements
--8<-- "recipe-standard-ingredients.md"
## Preparation
### Setup data locations
First we create a directory to hold the data which Redis will cache for nitter:
```bash
mkdir /var/data/nitter
```
### Create config file
Nitter is configured using a flat text file, so create `/var/data/config/nitter/nitter.conf` from the [example at in the repo](https://github.com/zedeus/nitter/blob/master/nitter.example.conf), and then we'll mount it (*read-only*) into the container, below. Here's what it looks like, if you'd prefer a copy-paste (*the only critical setting is `redisHost` be set to `redis`*)
```bash title="/var/data/config/nitter/nitter.conf"
[Server]
address = "0.0.0.0"
port = 8080
https = true # disable to enable cookies when not using https
httpMaxConnections = 100
staticDir = "./public"
title = "example.com's nitter"
hostname = "nitter.example.com"
[Cache]
listMinutes = 240 # how long to cache list info (not the tweets, so keep it high)
rssMinutes = 10 # how long to cache rss queries
redisHost = "redis" #(1)!
redisPort = 6379
redisPassword = ""
redisConnections = 20 # connection pool size
redisMaxConnections = 30
# max, new connections are opened when none are available, but if the pool size
# goes above this, they're closed when released. don't worry about this unless
# you receive tons of requests per second
[Config]
hmacKey = "imasecretsecretkey" # random key for cryptographic signing of video urls
base64Media = false # use base64 encoding for proxied media urls
enableRSS = true # set this to false to disable RSS feeds
enableDebug = false # enable request logs and debug endpoints
proxy = "" # http/https url, SOCKS proxies are not supported
proxyAuth = ""
tokenCount = 10
# minimum amount of usable tokens. tokens are used to authorize API requests,
# but they expire after ~1 hour, and have a limit of 187 requests.
# the limit gets reset every 15 minutes, and the pool is filled up so there's
# always at least $tokenCount usable tokens. again, only increase this if
# you receive major bursts all the time
# Change default preferences here, see src/prefs_impl.nim for a complete list
[Preferences]
theme = "Nitter"
replaceTwitter = "nitter.example.com" #(2)!
replaceYouTube = "piped.video" #(3)!
replaceReddit = "teddit.net" #(4)!
proxyVideos = true
hlsPlayback = false
infiniteScroll = false
```
1. Note that because we're using docker swarm, we can simply use `redis` as the target redis host
2. Set this to your Nitter URL to have Nitter rewrite twitter.com links in tweets to itself
3. If you've setup [Invidious][invidious], then you can have Nitter rewrite any YouTube URLs to your Invidious instance
4. I don't know what Teddit is (*yet*), but I assume it's a private Reddit proxy, and I hope that it has a teddy bear as its logo! :bear:
### {{ page.meta.recipe }} Docker Swarm config
Create a docker swarm config file in docker-compose syntax (v3), something like the example below:
--8<-- "premix-cta.md"
```yaml
version: "3.2" # https://docs.docker.com/compose/compose-file/compose-versioning/#version-3
services:
nitter:
image: zedeus/nitter:latest
volumes:
- /var/data/config/nitter/nitter.conf:/src/nitter.conf:Z,ro
deploy:
replicas: 1
labels:
# traefik
- traefik.enable=true
- traefik.docker.network=traefik_public
- traefik.http.routers.nitter.rule=Host(`nitter.example.com`)
- traefik.http.routers.nitter.entrypoints=https
- traefik.http.services.nitter.loadbalancer.server.port=8080
networks:
- internal
- traefik_public
redis:
image: redis:6-alpine
command: redis-server --save 60 1 --loglevel warning
volumes:
- /var/data/nitter/redis:/data
networks:
- internal
networks:
traefik_public:
external: true
internal:
driver: overlay
ipam:
config:
- subnet: 172.16.24.0/24
```
--8<-- "reference-networks.md"
!!! question "Shouldn't we back up Redis?"
I'm not sure exactly what Redis is used for, but Nitter is read-only, so what's to back up? I expect that Redis is simply used for caching, so that content you've already seen via Nitter can be re-loaded faster. The `--save 60 1` argument tells Redis to save a snapshot every 60 seconds, so it's probably not a big deal to just back up Redis's data with your existing backup of `/var/data` (*you do backup your data, right?*)
## Serving
### Launch Nitter!
Launch the Nitter stack by running ```docker stack deploy nitter -c <path -to-docker-compose.yml>```, then browse to the URL you chose above, and you should be able to start viewing / searching Twitter privately and anonymously!
### Now what?
Now that you have a Nitter instance, you could try one of the following ideas:
:one: Setup RSS feeds for users you enjoy following, and read their tweets in your [RSS reader][miniflux]<br/>
:two: Setup RSS feeds for useful searches, and follow the search results in your [RSS reader][tiny-tiny-rss]<br/>
:three: Use a browser add-on like "[libredirect](https://addons.mozilla.org/en-US/firefox/addon/libredirect/)", to automatically redirect any links from twitter.com to your Nitter instance
## Summary
What have we achieved? We have our own instance of Nitter[^1], and we can anonymously and privately consume Twitter without being subject to advertising or tracking. We can even consume Twitter content via RSS, and no unhinged billionaires can lock us out of the API!
!!! summary "Summary"
Created:
* [X] Our own Nitter instance, safe from meddling :rocket: billionaires!
[^1]: Since Nitter is private and read-only anyway, this recipe doesn't take into account any sort of authentication using [Traefik Forward Auth](/docker-swarm/traefik-forward-auth/). If you wanted to protect your Nitter instance behind either Traefik Forward Auth or [Authelia][authelia], you'll just need to add the appropriate `traefik.http.routers.nitter.middlewares` label.
--8<-- "recipe-footer.md"

5
docs/recipes/template.md
View File

@@ -2,11 +2,12 @@
description: Neat one-sentence description of recipe for social media previews
recipe: Recipe Name
title: Short, punchy title for search engine results / social previews
image: /images/<recipe name>.png
---
# <///RECIPE NAME>
# {{ page.meta.recipe }} on Docker Swarm
![Linx Screenshot](../images/linx.png){ loading=lazy }
![Screenshot of {{ page.meta.recipe }}]({{ page.meta.image }}){ loading=lazy }
[Linx](https://github.com/andreimarcu/linx-server) is self-hosted file/media-sharing service, which features:

1
docs/reference/networks.md
View File

@@ -35,6 +35,7 @@ In order to avoid IP addressing conflicts as we bring swarm networks up/down, we
| [MiniFlux](/recipes/miniflux/) | 172.16.22.0/24 |
| [Gitlab Runner](/recipes/gitlab-runner/) | 172.16.23.0/24 |
| [Bookstack](/recipes/bookstack/) | 172.16.33.0/24 |
| [Nitter](/recipes/nitter/) | 172.16.33.0/24 |
| [Swarmprom](/recipes/swarmprom/) | 172.16.34.0/24 |
| [Realms](/recipes/realms/) | 172.16.35.0/24 |
| [ElkarBackup](/recipes/elkarbackup/) | 172.16.36.0/24 |

1
mkdocs.yml
View File

@@ -145,6 +145,7 @@ nav:
- Munin: recipes/munin.md
- NextCloud: recipes/nextcloud.md
- NightScout: recipes/nightscout.md
- Nitter: recipes/nitter.md
- Nomie: recipes/nomie.md
- OpenLDAP: recipes/openldap.md
- OwnTracks: recipes/owntracks.md