2020-11-17 21:44:32 +01:00
|
|
|
# teddit
|
|
|
|
|
|
2020-11-17 22:02:20 +01:00
|
|
|
|
|
|
|
|
[teddit.net](https://teddit.net)
|
|
|
|
|
|
|
|
|
|
|
2020-11-17 21:44:32 +01:00
|
|
|
A free and open source alternative Reddit front-end focused on privacy.
|
|
|
|
|
Inspired by the [Nitter](https://github.com/zedeus/nitter) project.
|
|
|
|
|
|
|
|
|
|
* No JavaScript or ads
|
|
|
|
|
* All requests go through the backend, client never talks to Reddit
|
|
|
|
|
* Prevents Reddit from tracking your IP or JavaScript fingerprint
|
|
|
|
|
* Lightweight (teddit frontpage: ~30 HTTP requests with ~270 KB of data downloaded vs. Reddit frontpage: ~190 requests with ~24 MB)
|
|
|
|
|
|
2020-11-29 13:03:06 +01:00
|
|
|
Join the teddit discussion room on Matrix: [#teddit:matrix.org](https://matrix.to/#/#teddit:matrix.org)
|
2020-11-19 06:55:25 +01:00
|
|
|
|
2020-11-17 21:44:32 +01:00
|
|
|
XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj
|
2020-11-17 21:57:40 +01:00
|
|
|
|
2020-11-17 21:44:32 +01:00
|
|
|
BTC: bc1qlcrmt2pvlh4eq69l3l4h6z5jg74z2m2q3pasan
|
|
|
|
|
|
2020-12-01 16:16:30 +01:00
|
|
|
## Instances
|
|
|
|
|
|
|
|
|
|
[https://teddit.net](https://teddit.net) - Official instance
|
|
|
|
|
|
|
|
|
|
Community instances:
|
|
|
|
|
|
|
|
|
|
* [https://teddit.ggc-project.de](https://teddit.ggc-project.de)
|
|
|
|
|
|
2020-11-18 18:58:59 +01:00
|
|
|
## TODO
|
|
|
|
|
|
|
|
|
|
* Sort comments in post
|
|
|
|
|
* User attributes
|
|
|
|
|
* Comment and post attributes (e.g. stickies)
|
2020-11-30 17:06:10 +01:00
|
|
|
* Subreddit flairs and wikis
|
2020-11-18 18:58:59 +01:00
|
|
|
* User trophies
|
|
|
|
|
* "other discussions" feature
|
|
|
|
|
* ... and lot of other small stuff
|
|
|
|
|
|
|
|
|
|
## Roadmap
|
|
|
|
|
|
|
|
|
|
* Unofficial reddit API through teddit
|
|
|
|
|
* Themes
|
|
|
|
|
* User settings
|
|
|
|
|
* HLS video streaming? (Would require browser JavaScript)
|
|
|
|
|
* Onion site
|
|
|
|
|
* User login, so people can use their Reddit account through teddit to comment and up/downvote posts etc.
|
|
|
|
|
|
2020-11-17 21:44:32 +01:00
|
|
|
## Installation
|
2020-11-17 21:57:40 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
1. Install [node.js](https://nodejs.org/en/)
|
|
|
|
|
For example:
|
|
|
|
|
`# curl -sL https://deb.nodesource.com/setup_14.x | bash - && apt-get install -y nodejs`
|
|
|
|
|
1. Install [redis-server](https://redis.io/) and [ffmpeg](https://ffmpeg.org/)
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
For example:
|
|
|
|
|
`# apt install redis-server ffmpeg`
|
|
|
|
|
Leave ffmpeg out if you don't want video support.
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
1. `$ git clone https://codeberg.org/teddit/teddit`
|
|
|
|
|
1. `$ cd teddit`
|
|
|
|
|
1. `$ npm install --no-optional`
|
2020-12-03 18:14:22 +01:00
|
|
|
1. Edit `config.js.template` to suit your environment. After done, rename it to `config.js`.
|
2020-12-03 18:12:04 +01:00
|
|
|
1. Edit redis.conf file and set maxmemory value to suit your environment (e.g. 75% of your total RAM).
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-11-17 21:44:32 +01:00
|
|
|
`# nano /etc/redis/redis.conf`
|
2020-12-03 18:12:04 +01:00
|
|
|
Add new lines:
|
2020-11-17 21:44:32 +01:00
|
|
|
`maxmemory 2gb`
|
|
|
|
|
`maxmemory-policy volatile-ttl`
|
|
|
|
|
Save and exit.
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
1. Restart redis
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
For example:
|
|
|
|
|
`systemctl restart redis`
|
2020-12-03 18:14:22 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
1. `$ node app.js`
|
2020-11-17 21:57:40 +01:00
|
|
|
|
2020-12-03 18:12:04 +01:00
|
|
|
Teddit should be now running.
|
