From a7c30453db30ac864875e921d4bd191fca3c9937 Mon Sep 17 00:00:00 2001 From: allegroai <> Date: Sun, 5 Jan 2020 09:19:37 +0200 Subject: [PATCH] Update documentation --- README.md | 12 ++++++------ docs/faq.md | 10 +++++----- docs/install_linux_mac.md | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 281be35..7b3f694 100644 --- a/README.md +++ b/README.md @@ -108,12 +108,12 @@ To restart the **trains-server**, you must first stop the containers, and then r ```bash docker-compose down - docker-compose -f docker-compose-unified.yml up + docker-compose -f docker-compose.yml up ``` ## Upgrading -**trains-server** releases are also reflected in the [docker compose configuration file](https://github.com/allegroai/trains-server/blob/master/docker-compose-unified.yml). +**trains-server** releases are also reflected in the [docker compose configuration file](https://github.com/allegroai/trains-server/blob/master/docker-compose.yml). We strongly encourage you to keep your **trains-server** up to date, by keeping up with the current release. **Note**: The following upgrade instructions use the Linux OS as an example. @@ -143,16 +143,16 @@ To upgrade your existing **trains-server** deployment: ``` -1. Download the latest `docker-compose-unified.yml` file. +1. Download the latest `docker-compose.yml` file. ```bash - curl https://raw.githubusercontent.com/allegroai/trains-server/master/docker-compose-unified.yml -o docker-compose-unified.yml + curl https://raw.githubusercontent.com/allegroai/trains-server/master/docker-compose.yml -o docker-compose.yml ``` 1. Spin up the docker containers, it will automatically pull the latest **trains-server** build ```bash - docker-compose -f docker-compose-unified.yml pull - docker-compose -f docker-compose-unified.yml up + docker-compose -f docker-compose.yml pull + docker-compose -f docker-compose.yml up ``` **\* If something went wrong along the way, check our FAQ: [Common Docker Upgrade Errors](https://github.com/allegroai/trains-server/blob/master/docs/faq.md#common-docker-upgrade-errors).** diff --git a/docs/faq.md b/docs/faq.md index ac5efb8..9ec9258 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -101,9 +101,9 @@ To launch **trains-server** on macOS: git clone https://github.com/allegroai/trains-server.git cd trains-server -1. Run `docker-compose` with the unified docker image. +1. Run `docker-compose` with the docker compose file. - docker-compose -f docker-compose-unified.yml up + docker-compose -f docker-compose.yml up Your server is now running on [http://localhost:8080](http://localhost:8080) @@ -146,7 +146,7 @@ Restart *trains-server* by first stopping the Docker containers and then restart ```bash docker-compose down - docker-compose up -f docker-compose-unified.yml + docker-compose up -f docker-compose.yml ``` **Note**: If you are using a different docker-compose YAML file, specify that file. @@ -287,12 +287,12 @@ from working correctly. You can check for port conflicts in the logs in `/opt/trains/log`. -If a port conflict occurs, change the MongoDB and / or Elastic ports in the `docker-compose-unified.yml`, +If a port conflict occurs, change the MongoDB and / or Elastic ports in the `docker-compose.yml`, and then run the Docker compose commands to restart the **trains-server** instance. To change the MongoDB and / or Elastic ports for **trains-server**: -1. Edit the `docker-compose-unified.yml` file. +1. Edit the `docker-compose.yml` file. 1. In the `services/trainsserver/environment` section, add the following environment variable(s): diff --git a/docs/install_linux_mac.md b/docs/install_linux_mac.md index 7b20019..d9cd136 100644 --- a/docs/install_linux_mac.md +++ b/docs/install_linux_mac.md @@ -80,11 +80,11 @@ To launch **trains-server** on Linux or macOS: 1. Download the **trains-server** docker-compose YAML file. cd /opt/trains - curl https://raw.githubusercontent.com/allegroai/trains-server/master/docker-compose-unified.yml -o docker-compose-unified.yml + curl https://raw.githubusercontent.com/allegroai/trains-server/master/docker-compose.yml -o docker-compose.yml 1. Run `docker-compose` with the downloaded configuration file. - sudo docker-compose -f docker-compose-unified.yml up + sudo docker-compose -f docker-compose.yml up Your server is now running on [http://localhost:8080](http://localhost:8080) and the following ports are available: