From dacdd5e9652cd1dc46d02ac8ce2cb07d11660ba3 Mon Sep 17 00:00:00 2001 From: allegroai <> Date: Thu, 8 Aug 2019 02:00:15 +0300 Subject: [PATCH] Documentation --- README.md | 54 +++++++++++++++++++++++++------------------- docs/docker_setup.md | 2 -- 2 files changed, 31 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 66155a8..9c24831 100644 --- a/README.md +++ b/README.md @@ -80,7 +80,7 @@ For Windows, we recommend installing our pre-built Docker image on a Linux virtu 1. Launch the Docker containers - * Automatically with docker-compose (details: [Linux/Ubuntu](docs/faq.md##ubuntu), [OS X](docs/faq.md#mac-osx)) + * Automatically with docker-compose (details: [Linux/Ubuntu](docs/faq.md#ubuntu), [OS X](docs/faq.md#mac-osx)) ```bash $ docker-compose up @@ -193,18 +193,39 @@ When we release a new version and include a new pre-built Docker image for it, u 1. Shut down and remove each of your Docker instances using the following commands: - sudo docker stop - sudo docker rm -v + * Using Docker-Compose + + ```bash + $ docker-compose up + ``` - The Docker names are (see [Launching Docker Containers](#launch-docker)): + * Manual Docker launching + + sudo docker stop + sudo docker rm -v + + The Docker names are (see [Launching Docker Containers](#launch-docker)): + + * `trains-elastic` + * `trains-mongo` + * `trains-fileserver` + * `trains-apiserver` + * `trains-webserver` - * `trains-elastic` - * `trains-mongo` - * `trains-fileserver` - * `trains-apiserver` - * `trains-webserver` +2. We highly recommend backing up your data directory!. A simple way to do that is using `tar`: -2. Pull the new **trains-server** docker image using the following command: + For example, if your data directory is `/opt/trains`, use the following command: + + sudo tar czvf ~/trains_backup.tgz /opt/trains/data + + This backups all data to an archive in your home directory. + + To restore this example backup, use the following command: + + sudo rm -R /opt/trains/data + sudo tar -xzf ~/trains_backup.tgz -C /opt/trains/data + +3. Pull the new **trains-server** docker image using the following command: sudo docker pull allegroai/trains:latest @@ -212,19 +233,6 @@ When we release a new version and include a new pre-built Docker image for it, u sudo docker pull allegroai/trains:0.10.1 -3. We highly recommend backing up your data directory!. A simple way to do that is using `tar`: - - For example, if your data directory is `/opt/trains`, use the following command: - - sudo tar czvf ~/trains_backup.tgz /opt/trains/data - - This back ups all data to an archive in your home directory. - - To restore this example backup, use the following command: - - sudo rm -R /opt/trains/data - sudo tar -xzf ~/trains_backup.tgz -C /opt/trains/data - 4. Launch the newly released Docker image (see [Launching Docker Containers](#launch-docker)). ## Community & Support diff --git a/docs/docker_setup.md b/docs/docker_setup.md index e3ac0af..2899d75 100644 --- a/docs/docker_setup.md +++ b/docs/docker_setup.md @@ -79,8 +79,6 @@ For CentOS 7, Ubuntu 16.04, Mint 18.3, Ubuntu 18.04 and Mint 19.x, we tested the echo "vm.max_map_count=262144" > /tmp/99-trains.conf sudo mv /tmp/99-trains.conf /etc/sysctl.d/99-trains.conf sudo sysctl -w vm.max_map_count=262144 - -sudo service docker restart ``` For information about setting this parameter on other systems, see the [elastic](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode) documentation.