diff --git a/README.md b/README.md index 49e3ed2..232f704 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -
-Farside +
+Farside
-
- +
+ [![Latest Release](https://img.shields.io/github/v/release/benbusby/farside?label=Release)](https://github.com/benbusby/farside/releases) [![MIT License](https://img.shields.io/github/license/benbusby/earthbound-themes.svg)](http://opensource.org/licenses/MIT) [![Elixir CI](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml/badge.svg)](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml) - +
A redirecting service for FOSS alternative frontends. @@ -25,6 +25,79 @@ Farside's links work with the following structure: `farside.link// + + Service + Page + Farside Link + + + Libreddit + /r/popular + https://farside.link/libreddit/r/popular + + + Teddit + /r/popular + https://farside.link/teddit/r/popular + + + Nitter + User Profile + https://farside.link/nitter/josevalim + + + Invidious + Home Page + https://farside.link/invidious + + + Piped + Video Page + https://farside.link/piped/watch?v=eBGIQ7ZuuiU + + + Bibliogram + User Profile + https://farside.link/bibliogram/u/kbdfans + + + Whoogle + Search "Elixir" + https://farside.link/whoogle/search?q=elixir&lang_interface=en + + + SearX + Search "Redis" + https://farside.link/searx/search?q=redis + + + SearXNG + Search "EFF" + https://farside.link/searxng/search?q=EFF + + + SimplyTranslate + Translate "hola" + https://farside.link/simplytranslate/?engine=google&text=hola + + + Lingva + Translate "bonjour" + https://farside.link/lingva/auto/en/bonjour + + + Rimgo + View photo album + https://farside.link/rimgo/a/H8M4rcp + + + Scribe + View Medium post + https://farside.link/scribe/@ftrain/big-data-small-effort-b62607a43a8c + + + | Service | Page | Farside Link | | -- | -- | -- | | [Libreddit](https://github.com/spikecodes/libreddit) | /r/popular | https://farside.link/libreddit/r/popular @@ -41,7 +114,7 @@ For example: | [Rimgo](https://codeberg.org/video-prize-ranch/rimgo) | View photo album | https://farside.link/rimgo/a/H8M4rcp | [Scribe](https://sr.ht/~edwardloveall/scribe/) | View Medium post | https://farside.link/scribe/@ftrain/big-data-small-effort-b62607a43a8c -This table doesn't include all available services. For a complete list of supported frontends, see: https://farside.link +Note: This table doesn't include all available services. For a complete list of supported frontends, see: https://farside.link Farside also accepts URLs to "parent" services, and will redirect to an appropriate front end service, for example: @@ -125,9 +198,25 @@ goes against what Farside is trying to solve. Use at your own discretion. ### Environment Variables -| Name | Purpose | -| -- | -- | -| FARSIDE_TEST | If enabled, bypasses the instance availability check and adds all instances to the pool. | -| FARSIDE_PORT | The port to run Farside on (default: `4001`) | -| FARSIDE_REDIS_PORT | The Redis server port to use (default: `6379`, same as the default for Redis) | -| FARSIDE_SERVICES_JSON | The "services" JSON file to use for selecting instances (default: `services.json`) | + + + + + + + + + + + + + + + + + + + + + +
NamePurpose
FARSIDE_TESTIf enabled, bypasses the instance availability check and adds all instances to the pool.
FARSIDE_PORTThe port to run Farside on (default: `4001`)
FARSIDE_REDIS_PORTThe Redis server port to use (default: `6379`, same as the default for Redis)
FARSIDE_SERVICES_JSONThe "services" JSON file to use for selecting instances (default: `services.json`)