From b73a8b4a4bdb9117a3d010a25a305e5cbe228737 Mon Sep 17 00:00:00 2001 From: mithereal Date: Sat, 30 Jul 2022 19:07:33 -0700 Subject: [PATCH] update readme --- README.md | 5 +++++ app.json | 2 +- lib/farside/application.ex | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 48c5050..b3352e1 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,7 @@ [![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) + [![Deploy](https://www.herokucdn.com/deploy/button.svg)](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//` diff --git a/app.json b/app.json index 20a6559..5f30a15 100644 --- a/app.json +++ b/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 } diff --git a/lib/farside/application.ex b/lib/farside/application.ex index bd35335..b32bfac 100644 --- a/lib/farside/application.ex +++ b/lib/farside/application.ex @@ -62,7 +62,7 @@ defmodule Farside.Application do data false -> - services_json_data + Base.decode64!(services_json_data) end {:ok, json} = Jason.decode(reply)