diff options
| author | Ben Busby <contact@benbusby.com> | 2022-07-27 13:50:23 -0600 |
|---|---|---|
| committer | Ben Busby <contact@benbusby.com> | 2022-07-27 13:53:33 -0600 |
| commit | a6dabe8bf308b660f7a26e5d2dc702c69b9b5210 (patch) | |
| tree | 9e5249672a3a2265c576e4ed0dddab04822b9871 /README.md | |
| parent | 7045b62ccf3460284fa31cf4e082cb8b7ff3a1de (diff) | |
| download | farside-a6dabe8bf308b660f7a26e5d2dc702c69b9b5210.tar.gz | |
Make conn values and services path configurable at runtime
Connection values (such as redis server port and the port to run farside
on) as well as the services json file to use can now be set via
environment variables:
FARSIDE_PORT sets the port for Farside to run on
FARSIDE_REDIS_PORT sets the redis server port for Farside to use
FARSIDE_SERVICES_JSON sets the services json file for Farside to use
This partially addresses the move towards de-listing Cloudflare
instances by default by allowing different services json files to be
used with different redis servers.
See #43
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 5 insertions, 2 deletions
@@ -63,8 +63,8 @@ Farside's routing is very minimal, with only the following routes: particular service with the specified path - Ex: `/libreddit/r/popular` would navigate to `<libreddit instance URL>/r/popular` - - If the service provided is actually a URL to a "parent" service - (i.e. "youtube.com" instead of "piped" or "invidious"), Farside + - If the service provided is actually a URL to a "parent" service + (i.e. "youtube.com" instead of "piped" or "invidious"), Farside will determine the correct frontend to use for the specified URL. - Note that a path is not required. `/libreddit` for example will still redirect the user to a working libreddit instance @@ -108,3 +108,6 @@ request per second per IP. | 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`) | |