Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
Minor README tweaks for v3 release.
  • Loading branch information
awlayton authored Mar 16, 2021
1 parent 6fb9a75 commit b1b8d9f
Showing 1 changed file with 16 additions and 10 deletions.
26 changes: 16 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,22 +25,22 @@ see [here](oada/).

Download one of our [releases] and start it using [docker-compose].

```shellSession
$ cd folder/containing/release/docker-compose
$ # Will pull the corresponding release images from dockerhub
$ DOMAIN=yourdomain.com docker-compose up -d
```shell
cd folder/containing/release/docker-compose
# Will pull the corresponding release images from dockerhub
DOMAIN=yourdomain.com docker-compose up -d
```

### Running from the git

If you want to contribute, or do other development type things,
you can running straight from our code base.

```shellSession
$ git clone https://github.com/OADA/oada-srvc-docker.git
$ cd oada-srvc-docker
$ # Running up the first time will automatically build the docker images
$ DOMAIN=yourdomain.com docker-compose up -d
```shell
git clone https://github.com/OADA/oada-srvc-docker.git
cd oada-srvc-docker
# Running up the first time will automatically build the docker images
DOMAIN=yourdomain.com docker-compose up -d
```

Note that running from the git is __not__ recommended for production use.
Expand All @@ -60,18 +60,24 @@ in the same directory as the `docker-compose.yml` file.
Any settings in this [override file] will be merged with ours
when running docker-compose.

Additionally, there are various environment variables available:
### Environment variables
Additionally, there are various configuration environment variables available.
Some important ones are:

- DOMAIN: set to the domain name of your API server
(e.g., `oada.mydomain.net`)
- EXTRA_DOMAINS: Additional domains to serve
(e.g., `oada.mydomain.org,oada.myotherdomain.net`)
- DEBUG: set the namespace(s) enabled in [debug]
(e.g., `*:info,*:error,*:warn`)

Rather than trying to always remembering to set your environment variables,
you probably want to use a [.env file] for things like `DOMAIN`.

[releases]: https://github.com/OADA/oada-srvc-docker/releases

[docker-compose]: https://docs.docker.com/compose/
[.env file]: https://docs.docker.com/compose/environment-variables/#substitute-environment-variables-in-compose-files
[arangodb]: https://www.arangodb.com
[kafka]: https://kafka.apache.org
[zookeeper]: https://zookeeper.apache.org
Expand Down

0 comments on commit b1b8d9f

Please sign in to comment.