teddit/README.md
Alexander Wong 734b11c926
Added support for Docker, Docker-Compose
- updated config.js template to support environment variables
2020-12-07 12:57:20 -07:00

2.0 KiB
Raw Blame History

teddit

teddit.net

A free and open source alternative Reddit front-end focused on privacy. Inspired by the 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)

Join the teddit discussion room on Matrix: #teddit:matrix.org

XMR: 832ogRwuoSs2JGYg7wJTqshidK7dErgNdfpenQ9dzMghNXQTJRby1xGbqC3gW3GAifRM9E84J91VdMZRjoSJ32nkAZnaCEj

BTC: bc1qlcrmt2pvlh4eq69l3l4h6z5jg74z2m2q3pasan

Instances

https://teddit.net - Official instance

Community instances:

TODO

  • Sort comments in post
  • User attributes
  • Comment and post attributes (e.g. stickies)
  • Subreddit flairs and wikis
  • User trophies
  • “other discussions” feature
  • “Open on reddit” links
  • … 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.

Installation

Docker

Using docker-compose:

docker-compose build
docker-compose up

Manual

  1. Install node.js
  2. Its highly recommended that you install redis-server because it works as a cache for Reddit API calls. If you want to support videos, install ffmpeg
    For example:
    # apt install redis-server ffmpeg
  3. $ git clone https://codeberg.org/teddit/teddit
  4. $ cd teddit
  5. $ npm install --no-optional
  6. Copy config.js.template to config.js and then edit it to suit your environment.
  7. $ npm start

Teddit should be now running.