From c775072b3d2d20cf65ec0c4625dc61377d2f4442 Mon Sep 17 00:00:00 2001
From: Edward Loveall <edward@edwardloveall.com>
Date: Sat, 15 Jan 2022 16:27:43 -0500
Subject: [PATCH] Add instructions for Lucky config variables

The most common is "How do I set my custom domain" (answer: APP_DOMAIN)
but this also requires setting LUCKY_ENV=production which requires
SECRET_KEY_BASE, DATABASE_URL, and PORT
---
 README.md              | 13 +++++++++++++
 config/route_helper.cr |  2 --
 2 files changed, 13 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index b6368d1..754715c 100644
--- a/README.md
+++ b/README.md
@@ -32,6 +32,19 @@ To run with mounted config from local fs:
 $ docker run -it --rm -v `pwd`/config/watch.yml:/app/config/watch.yml -p 8080:8080 scribe:latest
 ```
 
+### Configuration
+
+To allow your domain to show up on the homepage, the `APP_DOMAIN` environment variable must be set. Note that this only takes effect if the `LUCKY_ENV` environment variable is also set to `production`.
+
+See the [route_helper](https://git.sr.ht/~edwardloveall/scribe/tree/main/item/config/route_helper.cr) config for the code that powers this feature.
+
+Other configuration needed when in `production` mode:
+
+* PORT: The port Scribe should run on
+* SECRET_KEY_BASE: A 32-bit string. Can be generated with `lucky gen.secret_key`
+* DATABASE_URL: May be any valid postgres url since Scribe doesn't use a database
+  * Example: `postgres://does@not/matter`
+
 ## Project goals
 
 I believe that Medium is a bad actor on the web. They offer a [bad reading experience](https://twitter.com/BretFisher/status/1206766086961745920). Writing there [benefits Medium](https://www.manton.org/2016/01/15/silos-as-shortcuts.html) more than the author. Counter to their promise of a wider reach, [they offer worse SEO](https://pawelurbanek.com/medium-blogging-platform-seo). They use [extortionist business tactics](https://www.cdevn.com/why-medium-actually-sucks/). Finally, they want to [centralize the currently decentralized world of blogging](http://scripting.com/liveblog/users/davewiner/2016/01/20/0900.html).
diff --git a/config/route_helper.cr b/config/route_helper.cr
index 6fff745..c047ef5 100644
--- a/config/route_helper.cr
+++ b/config/route_helper.cr
@@ -1,9 +1,7 @@
 Lucky::RouteHelper.configure do |settings|
   if LuckyEnv.production?
-    # Example: https://my_app.com
     settings.base_uri = ENV.fetch("APP_DOMAIN")
   else
-    # Set domain to the default host/port in development/test
     settings.base_uri = "http://localhost:#{Lucky::ServerSettings.port}"
   end
 end