ClearML/clearml-server
1
0
Fork 0
mirror of https://github.com/clearml/clearml-server synced 2025-06-26 23:15:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation

Browse Source
This commit is contained in:
allegroai 2020-01-02 15:21:35 +02:00
parent 5d279c8c5a
commit 153ed6a7b7
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -48,7 +48,7 @@ The ports 8080/8081/8008 must be available for the **trains-server** services.
For example, to see if port `8080` is in use: For example, to see if port `8080` is in use:
* Linux or Mac OS X: * Linux or macOS:
sudo lsof -Pn -i4 | grep :8080 | grep LISTEN sudo lsof -Pn -i4 | grep :8080 | grep LISTEN
@ -63,7 +63,7 @@ Launch **trains-server** in any of the following formats:
- Pre-built [AWS EC2 AMI](https://github.com/allegroai/trains-server/blob/master/docs/install_aws.md) - Pre-built [AWS EC2 AMI](https://github.com/allegroai/trains-server/blob/master/docs/install_aws.md)
- Pre-built Docker Image - Pre-built Docker Image
- [Linux](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md) - [Linux](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md)
- [Mac OS X](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md) - [macOS](https://github.com/allegroai/trains-server/blob/master/docs/install_linux_mac.md)
- [Windows 10](https://github.com/allegroai/trains-server/blob/master/docs/install_win.md) - [Windows 10](https://github.com/allegroai/trains-server/blob/master/docs/install_win.md)
- Kubernetes - Kubernetes
- [Kubernetes Helm](https://github.com/allegroai/trains-server-helm#prerequisites) - [Kubernetes Helm](https://github.com/allegroai/trains-server-helm#prerequisites)

8
docs/faq.md
View File

@ -6,7 +6,7 @@ Launching **trains-server**
* [Stand alone Linux Ubuntu systems?](#ubuntu) * [Stand alone Linux Ubuntu systems?](#ubuntu)
* [Mac OS X?](#mac-osx) * [macOS?](#mac-osx)
* [Windows 10?](#docker_compose_win10) * [Windows 10?](#docker_compose_win10)
@ -72,11 +72,11 @@ To launch **trains-server** on a stand alone Linux Ubuntu:
Your server is now running on [http://localhost:8080](http://localhost:8080) Your server is now running on [http://localhost:8080](http://localhost:8080)
### How do I launch trains-server on Mac OS X? <a name="mac-osx"></a> ### How do I launch trains-server on macOS? <a name="mac-osx"></a>
To launch **trains-server** on Mac OS X: To launch **trains-server** on macOS:
1. Install [docker for OS X](https://docs.docker.com/docker-for-mac/install/). 1. Install [docker for macOS](https://docs.docker.com/docker-for-mac/install/).
1. Configure [Docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode). 1. Configure [Docker](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#docker-cli-run-prod-mode).

14
docs/install_linux_mac.md
View File

@ -1,18 +1,18 @@
# Launching the **trains-server** Docker in Linux or Mac OS X # Launching the **trains-server** Docker in Linux or macOS
For Linux or Mac OS X, use our pre-built Docker image for easy deployment. The latest Docker images can be found [here](https://hub.docker.com/r/allegroai/trains). For Linux or macOS, use our pre-built Docker image for easy deployment. The latest Docker images can be found [here](https://hub.docker.com/r/allegroai/trains).
For Linux users: For Linux users:
* You must be logged in as a user with sudo privileges. * You must be logged in as a user with sudo privileges.
* Use `bash` for all command-line instructions in this installation. * Use `bash` for all command-line instructions in this installation.
To launch **trains-server** on Linux or Mac OS X: To launch **trains-server** on Linux or macOS:
1. Install Docker. 1. Install Docker.
* Linux - see [Docker for Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/). * Linux - see [Docker for Ubuntu](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
* Mac OS X - see [Docker for OS X](https://docs.docker.com/docker-for-mac/install/). * macOS - see [Docker for macOS](https://docs.docker.com/docker-for-mac/install/).
1. Verify the Docker CE installation. Execute the command: 1. Verify the Docker CE installation. Execute the command:
@ -43,7 +43,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo sysctl -w vm.max_map_count=262144 sudo sysctl -w vm.max_map_count=262144
sudo service docker restart sudo service docker restart
Mac OS X: macOS:
screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty screen ~/Library/Containers/com.docker.docker/Data/vms/0/tty
sysctl -w vm.max_map_count=262144 sysctl -w vm.max_map_count=262144
@ -65,7 +65,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo mkdir -p /opt/trains/config sudo mkdir -p /opt/trains/config
sudo mkdir -p /opt/trains/data/fileserver sudo mkdir -p /opt/trains/data/fileserver
1. For Mac OS X only, open the Docker app, select **Preferences**, and then on the **File Sharing** tab, add `/opt/trains`. 1. For macOS only, open the Docker app, select **Preferences**, and then on the **File Sharing** tab, add `/opt/trains`.
1. Grant access to the Dockers. 1. Grant access to the Dockers.
@ -73,7 +73,7 @@ To launch **trains-server** on Linux or Mac OS X:
sudo chown -R 1000:1000 /opt/trains sudo chown -R 1000:1000 /opt/trains
Mac OS X: macOS:
sudo chown -R $(whoami):staff /opt/trains sudo chown -R $(whoami):staff /opt/trains