jeff/umap
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Proofreading settings.md

Browse source
This commit is contained in:
Yohan Boniface 2023-06-29 15:33:20 +02:00
parent 24de573053
commit 44af4b769b
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
docs/settings.md
View file

@ -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. 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 #### ALLOWED_HOSTS
The hosts that uMap expects. The hosts that uMap expects.
`ALLOWED_HOSTS = ['umap.mydomain.org']` `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 #### DEBUG
@ -57,7 +65,7 @@ Must be defined to something unique and secret.
The final URL of you instance, including the protocol: The final URL of you instance, including the protocol:
`SITE_URL="http://umap.org"` `SITE_URL=http://umap.org`
#### SHORT_SITE_URL #### SHORT_SITE_URL
@ -102,7 +110,7 @@ Eg.: `USER_URL_FIELD = "pk"`
#### UMAP_ALLOW_ANONYMOUS #### 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` Can be set through env var: `UMAP_ALLOW_ANONYMOUS=1`