From 138934f30ce3ac0cb49fb5b1e1e434dc3b8c3d0b Mon Sep 17 00:00:00 2001 From: Ayaka Date: Fri, 21 Jun 2024 23:49:37 +1200 Subject: [PATCH] change resource links and container links --- README.md | 82 ++++++++----------------------------------------------- 1 file changed, 11 insertions(+), 71 deletions(-) diff --git a/README.md b/README.md index 468c57f..78662ac 100644 --- a/README.md +++ b/README.md @@ -29,8 +29,6 @@ - [Binary](#binary) - [Running as a systemd service](#running-as-a-systemd-service) - [Building from source](#building-from-source) - - [Replit/Heroku/Glitch](#replit-heroku-glitch) - - [launchd (macOS)](#launchd-macos) 6. [Configuration](#configuration) - [Instance settings](#instance-settings) - [Default user settings](#default-user-settings) @@ -39,8 +37,8 @@ # Instances -> [!TIP] -> 🔗 **Want to automatically redirect Reddit links to Redlib? Use [LibRedirect](https://github.com/libredirect/libredirect) or [Privacy Redirect](https://github.com/SimonBrazell/privacy-redirect)!** +> [!WARNING] +> 🔗 **Currently public Redsunlib instance are not available, consider using a [redlib](https://github.com/redlib-org/redlib-instances/blob/main/instances.md) instance if you are not comfortable running your own** An up-to-date table of instances is available in [Markdown](https://github.com/redlib-org/redlib-instances/blob/main/instances.md) and [machine-readable JSON](https://github.com/redlib-org/redlib-instances/blob/main/instances.json). @@ -158,7 +156,7 @@ For configuration options, see the [Configuration section](#Configuration). [Docker](https://www.docker.com) 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. -Docker images for Redlib are available at [quay.io](https://quay.io/repository/redlib/redlib), with support for `amd64`, `arm64`, and `armv7` platforms. +Docker images for Redsunlib are available at our [Gitea container registry](https://git.stardust.wtf/iridium/-/packages/container/redsunlib/latest), currently only with support for `amd64`, if you need `arm64`, or `armv7` platforms you can either build Redsunlib yourself or open an [issue](https://git.stardust.wtf/iridium/redsunlib/issues) :) ### Docker Compose @@ -184,15 +182,15 @@ docker logs -f redlib Deploy Redlib: ```bash -docker pull quay.io/redlib/redlib:latest -docker run -d --name redlib -p 8080:8080 quay.io/redlib/redlib:latest +docker pull git.stardust.wtf/iridium/redsunlib:latest +docker run -d --name redlib -p 8080:8080 git.stardust.wtf/iridium/redsunlib:latest ``` Deploy using a different port on the host (in this case, port 80): ```bash -docker pull quay.io/redlib/redlib:latest -docker run -d --name redlib -p 80:8080 quay.io/redlib/redlib:latest +docker pull git.stardust.wtf/iridium/redsunlib:latest +docker run -d --name redlib -p 80:8080 git.stardust.wtf/iridium/redsunlib: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`. @@ -205,19 +203,7 @@ docker logs -f redlib ## Binary -If you're on Linux, you can grab a binary from [the newest release](https://github.com/redlib-org/redlib/releases/latest) from GitHub. - -Download the binary using [Wget](https://www.gnu.org/software/wget/): - -```bash -wget https://github.com/redlib-org/redlib/releases/download/v0.31.0/redlib -``` - -Make the binary executable and change its ownership to `root`: - -```bash -sudo chmod +x redlib && sudo chown root:root redlib -``` +Currently binaries are not supplied at this moment but will be at some point in the future but can be [built from source](#building-from-source) Copy the binary to `/usr/bin`: @@ -261,59 +247,13 @@ 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. +To deploy Redsunlib with changes not yet included in the latest release, you can build the application from source. ```bash -git clone https://github.com/redlib-org/redlib && cd redlib +git clone https://git.stardust.wtf/iridium/redsunlib && cd redsunlib 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](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/redlib-org/redlib) - -## launchd (macOS) - -If you are on macOS, you can use the [launchd](https://en.wikipedia.org/wiki/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 @@ -343,7 +283,7 @@ REDLIB_DEFAULT_USE_HLS = "on" > If using the Docker CLI, add ` --env-file .env` to the command that runs Redlib. For example: > > ```bash -> docker run -d --name redlib -p 8080:8080 --env-file .env quay.io/redlib/redlib:latest +> docker run -d --name redlib -p 8080:8080 --env-file .env git.stardust.wtf/iridium/redsunlib: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.