Clean up and document env vars

Author: ChrisPenner

README.md

@@ -74,6 +74,43 @@ It details Share's required environment variables and shows how it expects to be
 
 If you have any questions about self hosting, feel free to ask in our [Discord server](https://unison-lang.org/discord).
 
+### Dependencies
+
+Share currently requires a Postgres instance and access to a Redis server.
+
+### Environment Variables
+
+There are a number of environment variables Share requires.
+See `local.env` for example values which are used for local development.
+
+- `SHARE_API_ORIGIN`: The URL where the share server is accessible on the web.
+- `SHARE_SERVER_PORT`: Which port the server should bind to on startup. This may differ from `SHARE_API_ORIGIN` if you're using a reverse proxy.
+- `SHARE_REDIS`: The URL of the redis server.
+- `SHARE_POSTGRES`: The URL of the postgres server.
+- `SHARE_HMAC_KEY`: A secret key used for cryptographic signing. This should be at least 32 characters long.
+- `SHARE_DEPLOYMENT`: The deployment environment. One of: `local`, `staging`, `prod`.
+- `SHARE_POSTGRES_CONN_TTL`: The maximum time a connection to the postgres server should be kept alive.
+- `SHARE_POSTGRES_CONN_MAX`: The maximum number of connections to the postgres server.
+- `SHARE_SHARE_UI_ORIGIN`: The URL where the Share UI is publicly accessible.
+- `SHARE_CLOUD_UI_ORIGIN`: The URL where the Unison Cloud UI is publicly accessible.
+- `SHARE_HOMEPAGE_ORIGIN`: The URL where the Unison homepage is publicly accessible. If you are self-hosting you can set this to any URL you like.
+- `SHARE_CLOUD_HOMEPAGE_ORIGIN`: The URL where the Unison Cloud homepage is publicly accessible. If you are self-hosting you can set this to any URL you like.
+- `SHARE_LOG_LEVEL`: Minimum level of logging to emit, One of: `DEBUG`, `INFO`, `ERROR`, `USERERROR`.
+- `SHARE_COMMIT`: The git commit hash the share server was built from. This is passed along in error reports
+- `SHARE_MAX_PARALLELISM_PER_DOWNLOAD_REQUEST`: How many concurrent workers may serve a single UCM pull. The recommended value for this will depend on the number of cores on your machine, but between 5-8 is a reasonable number.
+- `SHARE_MAX_PARALLELISM_PER_UPLOAD_REQUEST`: How many concurrent workers may serve a single UCM push. The recommended value for this will depend on the number of cores on your machine, but between 5-8 is a reasonable number.
+- `SHARE_ZENDESK_API_USER`: The username to use for the Zendesk API.
+- `SHARE_ZENDESK_API_TOKEN`: The token to use for the Zendesk API.
+- `SHARE_GITHUB_CLIENTID`: The client ID for the GitHub OAuth application which will be used to authenticate users with the Share server.
+- `SHARE_GITHUB_CLIENT_SECRET`: The client secret for the GitHub OAuth application which will be used to authenticate users with the Share server.
+- (optional) `SHARE_SENTRY_DSN`: The URL of the Sentry instance to send error reports to. You may leave this unset.
+
+### Database initialization
+
+Share doesn't currently use any tools for managing database migrations (sorry). To initialize your database, you must run all the **timestamped** migration files inside `./sql`.
+
+We plan to transition to a more robust solution in the future.
+
 ## Updating unison dependencies
 
 ```sh

docker/docker-compose.yml

@@ -45,23 +45,15 @@ services:
       retries: 3
     ports:
       - "5424:5424"
-      - "5425:5425"
-      - "5426:5426"
 
     environment:
       # Placeholder values for development
       - SHARE_API_ORIGIN=http://share-api
       - SHARE_SERVER_PORT=5424
-      - SHARE_ADMIN_PORT=5425
-      - SHARE_CLIENT_HOSTNAME=0.0.0.0
-      - SHARE_CLIENT_PORT=5426
       - SHARE_REDIS=redis://redis:6379
       - SHARE_POSTGRES=postgresql://postgres:sekrit@postgres:5432
       - SHARE_HMAC_KEY=test-key-test-key-test-key-test-key-
       - SHARE_DEPLOYMENT=local
-      - SHARE_IP=share-api
-      - SHARE_AWS_CREDENTIAL_URL=invalid
-      - AWS_REGION=invalid
       - SHARE_POSTGRES_CONN_TTL=30
       - SHARE_POSTGRES_CONN_MAX=10
       - SHARE_SHARE_UI_ORIGIN=http://localhost:1234
@@ -76,8 +68,6 @@ services:
       - SHARE_ZENDESK_API_TOKEN=bad-password
       - SHARE_GITHUB_CLIENTID=invalid
       - SHARE_GITHUB_CLIENT_SECRET=invalid
-      - AWS_ACCESS_KEY_ID=invalid
-      - AWS_SECRET_ACCESS_KEY=invalid
 
     links:
       - redis

docker/share-entrypoint.sh

@@ -4,14 +4,6 @@ set -ex
 
 echo SHARE_REDIS: "$SHARE_REDIS"
 
-if [ -n "$NOMAD_PORT_enlil_tcp" ]; then
-    export SHARE_CLIENT_PORT="$NOMAD_PORT_enlil_tcp"
-fi
-
-if [ -n "$NOMAD_IP_enlil_tcp" ]; then
-    export SHARE_CLIENT_HOSTNAME="$NOMAD_IP_enlil_tcp"
-fi
-
 if [ -n "$NOMAD_PORT_enlil_http" ]; then
     export SHARE_SERVER_PORT="$NOMAD_PORT_enlil_http"
 fi

local.env

@@ -3,12 +3,8 @@
 # Stub environment 
 
 export SHARE_DEPLOYMENT=local
-export SHARE_IP=share-api
 export SHARE_API_ORIGIN=http://localhost:5424
 export SHARE_SERVER_PORT=5424
-export SHARE_ADMIN_PORT=5425
-export SHARE_AWS_CREDENTIAL_URL="invalid"
-export AWS_REGION="invalid"
 export SHARE_REDIS=redis://localhost:6379
 export SHARE_POSTGRES=postgresql://postgres:sekrit@localhost:5432
 export SHARE_POSTGRES_CONN_TTL=30
@@ -28,5 +24,3 @@ export SHARE_ZENDESK_API_USER="[email protected]"
 export SHARE_ZENDESK_API_TOKEN="bad-password"
 export SHARE_GITHUB_CLIENTID="invalid"
 export SHARE_GITHUB_CLIENT_SECRET="invalid"
-export AWS_ACCESS_KEY_ID="invalid"
-export AWS_SECRET_ACCESS_KEY="invalid"