From cdce91024125dc1ed59fe9ae629eac8c35b1e952 Mon Sep 17 00:00:00 2001 From: Eli Ribble Date: Thu, 18 Dec 2025 03:36:32 -0700 Subject: [PATCH] Document the required env vars --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 7df02a02..15d4bd1e 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,18 @@ go build . ## Running +You'll need a number of environment variables for configuring things; + + * ARCGIS_CLIENT_ID - The client ID for ArcGIS oauth, configured with esri. + * ARCGIS_CLIENT_SECRET - The client secret for ArcGIS oauth, configured with esri. + * BASE_URL - The URL the site is hosted at, used for forming callback URLs. Should be complete like 'https://foo.bar' + * BIND - The address and port to bind to. Use ':9001' for 'any address, port 9001' + * ENVIRONMENT - either 'PRODUCTION' or 'DEVELOPMENT'. It's used to set things like oauth token length. + * MAPBOX_TOKEN - The token to use with mapbox which is important for rendering maps. + * POSTGRES_DSN - The DSN for connecting to the postgres database. + * FIELDSEEKER_SCHEMA_DIRECTORY - The directory to write fieldseeker schema files for debugging. + * USER_FILES_DIRECTORY - The directory for writing uploaded user data files (audio, images). + ```sh > BASE_URL=https://sync.nidus.cloud ARCGIS_CLIENT_ID=foo ARCGIS_CLIENT_SECRET=bar POSTGRES_DSN='postgresql://?host=/var/run/postgresql&dbname=nidus-sync' ./nidus-sync ```