ClearML/clearml-server
1
0
Fork 0
mirror of https://github.com/clearml/clearml-server synced 2025-01-31 02:46:53 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
allegroai 2020-01-05 09:19:37 +02:00
parent dedac3b2fe
commit a7c30453db
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -108,12 +108,12 @@ To restart the **trains-server**, you must first stop the containers, and then r
```bash ```bash
docker-compose down docker-compose down
docker-compose -f docker-compose-unified.yml up docker-compose -f docker-compose.yml up
``` ```
## Upgrading <a name="upgrade"></a> ## Upgrading <a name="upgrade"></a>
**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. 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. **Note**: The following upgrade instructions use the Linux OS as an example.
@ -143,16 +143,16 @@ To upgrade your existing **trains-server** deployment:
``` ```
</details> </details>
1. Download the latest `docker-compose-unified.yml` file. 1. Download the latest `docker-compose.yml` file.
```bash ```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 1. Spin up the docker containers, it will automatically pull the latest **trains-server** build
```bash ```bash
docker-compose -f docker-compose-unified.yml pull docker-compose -f docker-compose.yml pull
docker-compose -f docker-compose-unified.yml up 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).** **\* 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).**

10
docs/faq.md
View File

@ -101,9 +101,9 @@ To launch **trains-server** on macOS:
git clone https://github.com/allegroai/trains-server.git git clone https://github.com/allegroai/trains-server.git
cd trains-server 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) 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 ```bash
docker-compose down 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. **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`. 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. and then run the Docker compose commands to restart the **trains-server** instance.
To change the MongoDB and / or Elastic ports for **trains-server**: 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): 1. In the `services/trainsserver/environment` section, add the following environment variable(s):

4
docs/install_linux_mac.md
View File

@ -80,11 +80,11 @@ To launch **trains-server** on Linux or macOS:
1. Download the **trains-server** docker-compose YAML file. 1. Download the **trains-server** docker-compose YAML file.
cd /opt/trains 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. 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: Your server is now running on [http://localhost:8080](http://localhost:8080) and the following ports are available: