mirrors/farside
1
0
Fork 0
mirror of https://github.com/benbusby/farside.git synced 2025-06-08 02:16:36 +00:00
Code Wiki Activity

update readme

Browse source
This commit is contained in:
mithereal 2022-07-30 19:07:33 -07:00
parent ca1e96470d
commit b73a8b4a4b
3 changed files with 7 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -3,6 +3,7 @@
[![Latest Release](https://img.shields.io/github/v/release/benbusby/farside?label=Release)](https://github.com/benbusby/farside/releases) [![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) [![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) [![Elixir CI](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml/badge.svg)](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml)
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)
A redirecting service for FOSS alternative frontends. A redirecting service for FOSS alternative frontends.
@ -14,6 +15,10 @@ available public instances for a particular service, while also helping to
distribute traffic more evenly across all instances and avoid performance distribute traffic more evenly across all instances and avoid performance
bottlenecks and rate-limiting. bottlenecks and rate-limiting.
## Heroku deploy
To load custom services, you must paste a base64 encoded string into the FARSIDE_SERVICES_JSON field
you can encode your json at https://www.base64encode.org
## Demo ## Demo
Farside's links work with the following structure: `farside.link/<service>/<path>` Farside's links work with the following structure: `farside.link/<service>/<path>`

2
app.json
View file

@ -7,7 +7,7 @@
"env": { "env": {
"MIX_ENV": "prod", "MIX_ENV": "prod",
"FARSIDE_SERVICES_JSON": { "FARSIDE_SERVICES_JSON": {
"description": "The json of services available", "description": "The base64(json) of services available (https://www.base64encode.org)",
"value": "", "value": "",
"required": false "required": false
} }

2
lib/farside/application.ex
View file

@ -62,7 +62,7 @@ defmodule Farside.Application do
data data
false -> false ->
services_json_data Base.decode64!(services_json_data)
end end
{:ok, json} = Jason.decode(reply) {:ok, json} = Jason.decode(reply)