redlib README

项目的 README,来自 github.com/redlib-org/redlib。合并为一个 markdown 文件:README.md。

Redlib

An alternative private front-end to Reddit, with its origins in Libreddit.

screenshot


10-second pitch: Redlib is a private front-end like Invidious but for Reddit. Browse the coldest takes of r/unpopularopinion without being tracked.


Table of Contents

  1. Redlib
  2. Instances
  3. About
  4. Comparison
  5. Deployment
  6. Configuration

Instances

[!TIP] 🔗 Want to automatically redirect Reddit links to Redlib? Use LibRedirect or Privacy Redirect!

An up-to-date table of instances is available in Markdown and machine-readable JSON.

Both files are part of the redlib-instances repository. To contribute your self-hosted instance to the list, see the redlib-instances README.

For information on instance uptime, see the Uptime Robot status page.


About

[!NOTE] Find Redlib on 💬 Matrix, 🐋 Quay.io, :octocat: GitHub, and 🦊 GitLab.

Redlib hopes to provide an easier way to browse Reddit, without the ads, trackers, and bloat. Redlib was inspired by other alternative front-ends to popular services such as Invidious for YouTube, Nitter for Twitter, and Bibliogram for Instagram.

Redlib currently implements most of Reddit's (signed-out) functionalities but still lacks a few features.

Built with

How is it different from other Reddit front ends?

Teddit

Teddit is another awesome open source project designed to provide an alternative frontend to Reddit. There is no connection between the two, and you're welcome to use whichever one you favor. Competition fosters innovation and Teddit's release has motivated me to build Redlib into an even more polished product.

If you are looking to compare, the biggest differences I have noticed are:

Libreddit

While originating as a fork of Libreddit, the name "Redlib" was adopted to avoid legal issues, as Reddit only allows the use of their name if structured as "XYZ For Reddit".

Several technical improvements have also been made, including:


Comparison

This section outlines how Redlib compares to Reddit in terms of speed and privacy.

Speed

Last tested on January 12, 2024.

Results from Google PageSpeed Insights (Redlib Report, Reddit Report).

Performance metric Redlib Reddit
Speed Index 0.6s 1.9s
Performance Score 100% 64%
Time to Interactive 2.8s 12.4s

Privacy

Reddit

Logging: According to Reddit's privacy policy, they "may [automatically] log information" including:

Location: The same privacy policy goes on to describe that location data may be collected through the use of:

Cookies: Reddit's cookie notice documents the array of cookies used by Reddit including/regarding:

Redlib

For transparency, I hope to describe all the ways Redlib handles user privacy.

Server


Deployment

This section covers multiple ways of deploying Redlib. Using Docker is recommended for production.

For configuration options, see the Configuration section.

Docker

Docker lets you run containerized applications. Containers are loosely isolated environments that are lightweight and contain everything needed to run the application, so there's no need to rely on what's installed on the host.

Container images for Redlib are available at quay.io, with support for amd64, arm64, and armv7 platforms.

Docker Compose

[!IMPORTANT] These instructions assume the Compose plugin has already been installed. If not, follow these instructions on the Docker Docs for how to do so.

Copy compose.yaml and modify any relevant values (for example, the ports Redlib should listen on).

Start Redlib in detached mode (running in the background):

docker compose up -d

Stream logs from the Redlib container:

docker logs -f redlib

Docker CLI

Deploy Redlib:

docker pull quay.io/redlib/redlib:latest
docker run -d --name redlib -p 8080:8080 quay.io/redlib/redlib:latest

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

docker pull quay.io/redlib/redlib:latest
docker run -d --name redlib -p 80:8080 quay.io/redlib/redlib:latest

If you're using a reverse proxy in front of Redlib, prefix the port numbers with 127.0.0.1 so that Redlib only listens on the host port locally. For example, if the host port for Redlib is 8080, specify 127.0.0.1:8080:8080.

Stream logs from the Redlib container:

docker logs -f redlib

Podman

Podman lets you run containerized applications in a rootless fashion. Containers are loosely isolated environments that are lightweight and contain everything needed to run the application, so there's no need to rely on what's installed on the host.

Container images for Redlib are available at quay.io, with support for amd64, arm64, and armv7 platforms.

Quadlets

[!IMPORTANT] These instructions assume that you are on a systemd based distro with podman. If not, follow these instructions on podman's website for how to do so. It also assumes you have used loginctl enable-linger <username> to enable the service to start for your user without logging in.

Copy the redlib.container and .env.example files to .config/containers/systemd/ and modify any relevant values (for example, the ports Redlib should listen on, renaming the .env file and editing its values, etc.).

To start Redlib either reboot or follow the instructions below:

Notify systemd of the new files

systemctl --user daemon-reload

Start the newly generated service file

systemctl --user start redlib.service

You can check the status of your container by using the following command:

systemctl --user status redlib.service

Binary

If you're on Linux, you can grab a binary from the newest release from GitHub.

Download the binary using Wget:

wget https://github.com/redlib-org/redlib/releases/download/v0.40.0/redlib

Make the binary executable and change its ownership to root:

sudo chmod +x redlib && sudo chown root:root redlib

Copy the binary to /usr/bin:

sudo cp ./redlib /usr/bin/redlib

Deploy Redlib to 0.0.0.0:8080:

redlib

[!IMPORTANT] If you're proxying Redlib through NGINX (see issue #122), add

proxy_http_version 1.1;

to your NGINX configuration file above your proxy_pass line.

Running as a systemd service

You can use the systemd service available in contrib/redlib.service (install it on /etc/systemd/system/redlib.service).

That service can be optionally configured in terms of environment variables by creating a file in /etc/redlib.conf. Use the contrib/redlib.conf as a template. You can also add the REDLIB_DEFAULT__{X} settings explained above.

When "Proxying using NGINX" where the proxy is on the same machine, you should guarantee nginx waits for this service to start. Edit /etc/systemd/system/redlib.service.d/reverse-proxy.conf:

[Unit]
Before=nginx.service

Building from source

To deploy Redlib with changes not yet included in the latest release, you can build the application from source.

git clone https://github.com/redlib-org/redlib && cd redlib
cargo run

Replit/Heroku

[!WARNING] These are free hosting options, but they are not private and will monitor server usage to prevent abuse. If you need a free and easy setup, this method may work best for you.

Run on Repl.it Deploy

launchd (macOS)

If you are on macOS, you can use the launchd service available in contrib/redlib.plist.

Install it with cp contrib/redlib.plist ~/Library/LaunchAgents/.

Load and start it with launchctl load ~/Library/LaunchAgents/redlib.plist.


Configuration

You can configure Redlib further using environment variables. For example:

REDLIB_DEFAULT_SHOW_NSFW=on redlib
REDLIB_DEFAULT_WIDE=on REDLIB_DEFAULT_THEME=dark redlib -r

You can also configure Redlib with a configuration file named redlib.toml. For example:

REDLIB_DEFAULT_WIDE = "on"
REDLIB_DEFAULT_USE_HLS = "on"

[!NOTE] If you're deploying Redlib using the Docker CLI or Docker Compose, environment variables can be defined in a .env file, allowing you to centralize and manage configuration in one place.

To configure Redlib using a .env file, copy the .env.example file to .env and edit it accordingly.

If using the Docker CLI, add --env-file .env to the command that runs Redlib. For example:

docker run -d --name redlib -p 8080:8080 --env-file .env quay.io/redlib/redlib:latest

If using Docker Compose, no changes are needed as the .env file is already referenced in compose.yaml via the env_file: .env line.

Command Line Flags

Redlib supports the following command line flags:

Instance settings

Assign a default value for each instance-specific setting by passing environment variables to Redlib in the format REDLIB_{X}. Replace {X} with the setting name (see list below) in capital letters.

Name Possible values Default value Description
SFW_ONLY ["on", "off"] off Enables SFW-only mode for the instance, i.e. all NSFW content is filtered.
BANNER String (empty) Allows the server to set a banner to be displayed. Currently this is displayed on the instance info page.
ROBOTS_DISABLE_INDEXING ["on", "off"] off Disables indexing of the instance by search engines.
PUSHSHIFT_FRONTEND String undelete.pullpush.io Allows the server to set the Pushshift frontend to be used with "removed" links.
PORT Integer 0-65535 8080 The internal port Redlib listens on.
ENABLE_RSS ["on", "off"] off Enables RSS feed generation.
FULL_URL String (empty) Allows for proper URLs (for now, only needed by RSS)

Default user settings

Assign a default value for each user-modifiable setting by passing environment variables to Redlib in the format REDLIB_DEFAULT_{Y}. Replace {Y} with the setting name (see list below) in capital letters.

Name Possible values Default value
THEME ["system", "light", "dark", "black", "dracula", "nord", "laserwave", "violet", "gold", "rosebox", "gruvboxdark", "gruvboxlight", "tokyoNight", "icebergDark", "doomone", "libredditBlack", "libredditDark", "libredditLight"] system
FRONT_PAGE ["default", "popular", "all"] default
LAYOUT ["card", "clean", "compact"] card
WIDE ["on", "off"] off
POST_SORT ["hot", "new", "top", "rising", "controversial"] hot
COMMENT_SORT ["confidence", "top", "new", "controversial", "old"] confidence
BLUR_SPOILER ["on", "off"] off
SHOW_NSFW ["on", "off"] off
BLUR_NSFW ["on", "off"] off
USE_HLS ["on", "off"] off
HIDE_HLS_NOTIFICATION ["on", "off"] off
AUTOPLAY_VIDEOS ["on", "off"] off
SUBSCRIPTIONS +-delimited list of subreddits (sub1+sub2+sub3+...) (none)
HIDE_AWARDS ["on", "off"] off
DISABLE_VISIT_REDDIT_CONFIRMATION ["on", "off"] off
HIDE_SCORE ["on", "off"] off
HIDE_SIDEBAR_AND_SUMMARY ["on", "off"] off
FIXED_NAVBAR ["on", "off"] on
REMOVE_DEFAULT_FEEDS ["on", "off"] off

Forward Proxies

Redlib supports proxy usage using the standard HTTP_PROXY and HTTPS_PROXY environment variables. Use ALL_PROXY to set both at the same time (which you want to do).

Security

This project uses BoringSSL, built from source with patches from the wreq project. Certificates are validated against the embedded trust store from Mozilla.

Building

Since Redlib uses boring-sys2, to build Redlib you will need to build BoringSSL from source.

Linux/MacOS

Refer to the boringssl documentation for dependencies.

Windows

Install MSVC, which you likely already have for Rust.

# Make sure to update your PATH, some of the installers don't do that by default (hense -i, interactive mode).
winget install -i Kitware.CMake
winget install -i NASM.NASM
winget install -i LLVM.LLVM

# For tests.
winget install GoLang.Go

redlib (redlib-org/redlib)

正在搜索数据库…

这是什么?Redlib 是 Reddit 的私有前端,理念与 YouTube 的 Invidious 相似,让你无需广告、追踪器或 JavaScript 即可浏览 Reddit。
这是浏览器扩展,还是需要我自己托管的程序?它是一个用 Rust 编写的自托管 Web 服务器,你需要自行部署并通过它浏览;它不是浏览器扩展,而且会通过自身代理所有 Reddit 请求(包括媒体文件)。
我要怎样才能跑起一个实例?推荐的方式是使用 Docker:复制 compose.yaml,修改端口,然后以分离模式运行;预构建的容器镜像也发布在 Quay.io 上,GitHub Releases 中还提供 Linux 二进制文件。
运行它需要 Docker 或 Rust 吗?由于官方提供了容器镜像,Docker 或 Podman 是最简单的途径;你也可以用 Rust 从源码构建,或直接下载预编译的 Linux 二进制文件。
部署时有哪些需要注意的坑?文档中提到的 --redirect-https 命令行参数已明确不再有效;如果你将 Redlib 放在 NGINX 后面,则需要额外配置代理请求头,以避免出现问题。
支持哪些平台和架构?官方 Docker/Podman 镜像支持 amd64、arm64 和 armv7;提供带有 systemd 服务文件的 Linux 二进制文件;macOS 则通过 launchd 服务得到支持。
Redlib 会记录关于我的任何信息吗?在正式环境(二进制、Docker 或官方实例)中,Redlib 不记录任何内容;只有调试版本会记录获取的帖子 ID 以便排查问题,而它设置的任何 Cookie 都不会跨站,也不包含任何个人数据。
为什么这个项目叫 Redlib,而不是 Libreddit?它最初是 Libreddit 的分支,后来改名为 Redlib,因为 Reddit 只允许以“XYZ For Reddit”的结构使用其名称,原名称可能带来法律风险。
Redlib 如何避免被 Reddit 限流?它使用 OAuth 令牌伪装,模仿官方 Android 应用的客户端,每 24 小时刷新一次身份验证令牌,并发送类似 Android 的 HTTP 请求头,以降低被封锁的可能性。
它的速度与直接使用 Reddit 相比如何?根据 README 中的 Google PageSpeed 结果,Redlib 的性能得分为 100%,速度指数为 0.6 秒;而 Reddit 的得分为 64%,速度指数为 1.9 秒。
它与另一个 Reddit 前端 Teddit 有何不同?Redlib 采用 Reddit 现代化重新设计后的外观,而 Teddit 更接近旧版 Reddit 的设计;Redlib 使用 Rust 编写并借助 Hyper HTTP 库来提升速度,除此之外两个项目没有其他关联。
大小
2.6 MB
星标
4K
时长
2年
提交 · 90 天