Gleipnir/nidus-sync
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Document the required env vars

Browse source
This commit is contained in:
Eli Ribble 2025-12-18 03:36:32 -07:00
parent 2d514aac31
commit cdce910241
1 changed files with 12 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -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
```