redsunlib/README.md
2020-11-22 20:22:51 -08:00

2.3 KiB

Libreddit

An alternative private front-end to Reddit

Libre + Reddit = Libreddit

  • 🚀 Fast: written in Rust for blazing fast speeds and safety
  • ☁️ Light: no javascript, no ads, no tracking
  • 🕵 Private: all requests are proxied through the server, including media
  • 🔒 Safe: does not rely on Reddit's OAuth-requiring APIs
  • 📱 Responsive: works great on mobile!

Think Invidious but for Reddit. Watch your cat videos without being watched.

Screenshot

Status

  • Hosting

    • Instances
      • Clearnet instance
      • .onion instance
    • Cargo deployment
    • Docker deployment
  • Subreddits

    • Title
    • Description
    • Posts
      • Post sorting
  • Posts

    • Flairs
    • Comments
      • Comment sorting
      • Nested comments
    • UTC post date
    • Image thumbnails
    • Embedded images
      • Proxied images
    • Reddit-hosted video
      • Proxied video
  • Users

    • Username
    • Karma
    • Description
    • Post history
      • Post sorting
    • Comment history
      • Comment sorting
  • Search

    • Post aggregating
    • Comment aggregating
    • Result sorting

Instances

Deploy an Instance

Once installed, deploy Libreddit (unless you're using Docker) by running:

libreddit

Specify a custom address for the server by passing the -a or --address argument:

libreddit --address=0.0.0.0:8111

A) Cargo

Make sure Rust stable is installed along with cargo, Rust's package manager.

cargo install libreddit

B) Docker

Deploy the Docker image of Libreddit:

docker run -d --name libreddit -p 8080:8080 spikecodes/libreddit

Deploy using a different port (in this case, port 80):

docker run -d --name libreddit -p 80:8080 spikecodes/libreddit

C) AUR

Libreddit is available from the Arch User Repository as libreddit-git.

Install:

yay -S libreddit-git

Building

git clone https://github.com/spikecodes/libreddit
cd libreddit
cargo run