redsunlib/README.md

120 lines
2.5 KiB
Markdown
Raw Normal View History

2020-10-26 09:48:44 +13:00
# 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
2020-11-23 17:22:51 +13:00
- 🕵 Private: all requests are proxied through the server, including media
2020-11-22 17:35:42 +13:00
- 🔒 Safe: does not rely on Reddit's OAuth-requiring APIs
2020-10-26 09:48:44 +13:00
- 📱 Responsive: works great on mobile!
Think Invidious but for Reddit. Watch your cat videos without being watched.
## Screenshot
2020-11-25 16:27:12 +13:00
![](https://i.ibb.co/Tgjb3w7/image.png)
2020-10-26 09:48:44 +13:00
## Status
- [x] Hosting
- [x] Instances
- [x] Clearnet instance
- [ ] .onion instance
- [x] Cargo deployment
- [x] Docker deployment
- [x] Subreddits
- [x] Title
- [x] Description
- [x] Posts
- [x] Post sorting
- [x] Posts
2020-11-18 13:56:37 +13:00
- [x] Flairs
2020-10-26 09:48:44 +13:00
- [x] Comments
- [x] Comment sorting
- [ ] Nested comments
- [x] UTC post date
- [x] Image thumbnails
- [x] Embedded images
2020-11-23 17:22:51 +13:00
- [x] Proxied images
2020-10-26 09:48:44 +13:00
- [x] Reddit-hosted video
2020-11-23 17:22:51 +13:00
- [x] Proxied video
2020-10-26 09:48:44 +13:00
- [x] Users
- [x] Username
- [x] Karma
- [x] Description
- [x] Post history
2020-11-24 08:33:43 +13:00
- [x] Comment history
2020-10-26 09:48:44 +13:00
- [ ] Search
- [ ] Post aggregating
- [ ] Comment aggregating
- [ ] Result sorting
## Instances
- [libredd.it](https://libredd.it) 🇺🇸 (Thank you to [YeapGuy](https://github.com/YeapGuy)!)
- [libreddit.spike.codes](https://libreddit.spike.codes) 🇺🇸
## Installation
2020-11-23 16:21:07 +13:00
2020-10-26 17:19:04 +13:00
### A) Cargo
2020-10-26 09:48:44 +13:00
Make sure Rust stable is installed along with `cargo`, Rust's package manager.
```
2020-10-26 17:19:04 +13:00
cargo install libreddit
2020-10-26 09:48:44 +13:00
```
### B) Docker
Deploy the Docker image of Libreddit:
```
2020-10-26 17:03:59 +13:00
docker run -d --name libreddit -p 8080:8080 spikecodes/libreddit
2020-10-26 09:48:44 +13:00
```
Deploy using a different port (in this case, port 80):
```
2020-10-26 17:03:59 +13:00
docker run -d --name libreddit -p 80:8080 spikecodes/libreddit
2020-10-26 09:48:44 +13:00
```
### C) AUR
Libreddit is available from the Arch User Repository as [`libreddit-git`](https://aur.archlinux.org/packages/libreddit-git).
Install:
```
yay -S libreddit-git
```
### D) GitHub Releases
If you're on Linux and none of these methods work for you, you can grab a Linux binary from [the newest release](https://github.com/spikecodes/libreddit/releases/latest).
## 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
```
2020-11-24 15:25:22 +13:00
To disable the media proxy built into Libreddit, run:
```
libreddit --no-default-features
```
## Building from Source
2020-10-26 17:19:04 +13:00
```
git clone https://github.com/spikecodes/libreddit
cd libreddit
cargo run
2020-11-25 16:27:12 +13:00
```