mirror of
https://github.com/benbusby/farside.git
synced 2025-04-19 23:05:56 -04:00
update readme
This commit is contained in:
parent
ca1e96470d
commit
b73a8b4a4b
@ -3,6 +3,7 @@
|
||||
[](https://github.com/benbusby/farside/releases)
|
||||
[](http://opensource.org/licenses/MIT)
|
||||
[](https://github.com/benbusby/privacy-revolver/actions/workflows/elixir.yml)
|
||||
|
||||
[](https://heroku.com/deploy)
|
||||
|
||||
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
|
||||
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
|
||||
|
||||
Farside's links work with the following structure: `farside.link/<service>/<path>`
|
||||
|
2
app.json
2
app.json
@ -7,7 +7,7 @@
|
||||
"env": {
|
||||
"MIX_ENV": "prod",
|
||||
"FARSIDE_SERVICES_JSON": {
|
||||
"description": "The json of services available",
|
||||
"description": "The base64(json) of services available (https://www.base64encode.org)",
|
||||
"value": "",
|
||||
"required": false
|
||||
}
|
||||
|
@ -62,7 +62,7 @@ defmodule Farside.Application do
|
||||
data
|
||||
|
||||
false ->
|
||||
services_json_data
|
||||
Base.decode64!(services_json_data)
|
||||
end
|
||||
|
||||
{:ok, json} = Jason.decode(reply)
|
||||
|
Loading…
x
Reference in New Issue
Block a user