updated readme with additional details

README.md

@@ -1,16 +1,67 @@
-# Docker Compose configuration for the installion of Tonic Textual
+# Docker Compose configuration for the installation of Tonic Textual
+Deploying Tonic via docker-compose is a relatively straightforward process. This repository contains an example/template docker-compose.yaml which can be used for this. Note that installation requires access to the Tonic Textual docker container repository. Reach out to support@tonic.ai to get your container repository login credentials.
 
-Note that installation requires access to the Tonic Textual docker container repository.  Reach out to support@tonic.ai to get your container repository login credentials.
+Project structure:
+```
+.
+├── sample.env
+├── docker-compose.yaml
+├── docker-compose-with-gpus.yml
+└── README.md
+```
 
-# Setup
-Rename the sample.env file to .env.  Inside the .env file you'll have to fill in the missing variables in order get Textual running.  The required values you must enter are
+## Configuration
 
-```
-SOLAR_VERSION
-ENVIRONMENT_NAME
-SOLAR_DB_PASSWORD= #<FILL IN>
-SOLAR_SECRET= #<FILL IN>
-SOLAR_STATISTICS_SEED= #<FILL IN>
-```bash
-
-Everything else is optional. Reach out to support@tonic.ai with any questions.
+### .env
+
+Before deploying this setup, you need to rename sample.env to .env and configure the following values, or set the environment variables directly within docker-compose.yaml. Please note that variables outside of the ones referenced below are option. Reach out to support@tonic.ai with any questions.
+
+### Environment Name
+
+* ENVIRONMENT_NAME: E.g. "my-company-name", or if deploying multiple Tonic instances, "my-company-name-dev" or "my-company-name-prod to differentiate instances.
+
+### Version
+
+* SOLAR_VERSION: A specific version tag. Tonic's tag convention is just the release number, e.g. “086. The latest version during installation will be supplied by Tonic.
+
+### Application Database
+
+The connection details for the Postgres metadata/application database which holds Tonic's state (user accounts, workspaces, etc.).
+* SOLAR_DB_HOST
+* SOLAR_DB_PORT
+* SOLAR_DB_DATABASE
+* SOLAR_DB_USERNAME
+* SOLAR_DB_PASSWORD
+
+By default we're deploying a Postgres DB container, so the only field that requires update is the SOLAR_DB_PASSWORD and the Postgres database will be instantiated upon installation. If you’d prefer, you can provide credentials for a standalone database (i.e. RDS Postgres) and update each of these values accordingly.
+
+### Secret
+
+This value gets used to encrypt/decrypt sensitive data in the metadata database
+* SOLAR_SECRET: Any string value is valid
+
+
+### Solar Statistics Seed
+
+ This value is used for cross job consistency 
+*SOLAR_STATISTICS_SEED: Any integer value
+
+
+## Deploy
+
+To run Tonic, execute the docker-compose up -d command from within the directory containing your docker-compose.yaml file.
+
+` $ docker-compose up -d `
+
+
+### Validate the deployment
+
+Use docker ps to check that containers are running:
+
+` $ docker ps `
+
+
+The Tonic UI will be accessible in your browser on port 80 or 443. I.e. from the server at https://localhost:443 or http://localhost, or via the server IP/hostname or domain you are routing to the server.
+Tonic may take a few minutes to fully startup. You can validate that it has fully started up and is in a healthy state by running 
+
+` $ docker logs textual-api `