From 44af4b769be61043c7cc210813908a004d2910e8 Mon Sep 17 00:00:00 2001 From: Yohan Boniface Date: Thu, 29 Jun 2023 15:33:20 +0200 Subject: [PATCH] Proofreading settings.md --- docs/settings.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/docs/settings.md b/docs/settings.md index 298f45b7..5679e8c8 100644 --- a/docs/settings.md +++ b/docs/settings.md @@ -7,13 +7,21 @@ The Django settings reference is here: https://docs.djangoproject.com/en/4.2/ref Here are a few relevent settings for uMap. +## Usage + +Those settings should either: + +- be in `/etc/umap/umap.conf`, which uMap will try to load by default +- be in a random place on your server, which is then reference with the + `UMAP_SETTINGS` env var +- be declared as env vars directly, for simple ones (string/boolean/list) #### ALLOWED_HOSTS The hosts that uMap expects. `ALLOWED_HOSTS = ['umap.mydomain.org']` -Can be set through env var too: `ALLOWED_HOSTS=umap.mydomain.org` +Can be set through env var too: `ALLOWED_HOSTS=umap.mydomain.org,u.mydomain.org` #### DEBUG @@ -57,7 +65,7 @@ Must be defined to something unique and secret. The final URL of you instance, including the protocol: -`SITE_URL="http://umap.org"` +`SITE_URL=http://umap.org` #### SHORT_SITE_URL @@ -102,7 +110,7 @@ Eg.: `USER_URL_FIELD = "pk"` #### UMAP_ALLOW_ANONYMOUS -Should uMap allows user without an account to create maps. +Should uMap allows user without an account to create maps (default is False). Can be set through env var: `UMAP_ALLOW_ANONYMOUS=1`