libreddit/README.md

53 lines
1.3 KiB
Markdown
Raw Normal View History

2020-08-12 03:44:43 +02:00
# Libreddit
2020-10-11 21:29:03 +02:00
> An alternative private front-end to Reddit
2020-08-13 23:03:59 +02:00
2020-10-11 21:29:03 +02:00
Libre + Reddit = Libreddit
2020-08-12 03:44:43 +02:00
- 🚀 Fast: written in Rust for blazing fast speeds and safety
2020-10-11 21:29:03 +02:00
- ☁️ Light: no javascript, no ads, no tracking
2020-08-12 03:44:43 +02:00
- 🕵 Private: ~~all~~ most requests are proxied through the server (images are still loaded from Reddit)
- 🔒 Safe: does not rely on Reddit's closed APIs
- 📱 Responsive: works great on mobile!
Think Invidious but for Reddit. Watch your cat videos without being watched.
**Note**: Libreddit is still a WIP.
2020-10-11 21:29:03 +02:00
## Screenshot
2020-10-12 02:47:07 +02:00
![](https://i.ibb.co/SfFHDhh/image.png)
2020-10-11 21:29:03 +02:00
2020-08-12 03:44:43 +02:00
## Instances
2020-08-13 23:03:59 +02:00
- [libreddit.spike.codes](https://libreddit.spike.codes) 🇺🇸
2020-08-12 03:44:43 +02:00
## Deploy an Instance
### A) Manual
2020-10-12 02:47:07 +02:00
Make sure you have [Rust](https://rust-lang.org) installed first or else `cargo` commands won't work. Libreddit uses Rocket for the web server and as of now, Rocket requires Rust Nightly.
2020-08-12 03:44:43 +02:00
```
rustup default nightly
```
Deploy using these commands:
```
git clone https://github.com/spikecodes/libreddit.git
cd libreddit
cargo run
```
2020-10-11 21:29:03 +02:00
### B) Docker
2020-08-12 03:44:43 +02:00
2020-10-11 21:29:03 +02:00
Deploy the Docker image of Libreddit:
```
2020-10-11 21:40:15 +02:00
docker run -d --name libreddit -p 8000:8000 spikecodes/libreddit
2020-10-11 21:29:03 +02:00
```
2020-08-12 03:44:43 +02:00
2020-10-11 21:29:03 +02:00
Deploy using a different port (in this case, port 80):
```
2020-10-11 21:40:15 +02:00
docker run -d --name libreddit -p 80:8000 spikecodes/libreddit
2020-10-11 21:29:03 +02:00
```