From c98243b4c1921a16518261f70160ed3863b63ee7 Mon Sep 17 00:00:00 2001 From: Qaiser Abbasi Date: Wed, 9 May 2018 20:48:32 +0200 Subject: [PATCH] Add 'portainer' as container name in code listings --- docs/source/deployment.rst | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/source/deployment.rst b/docs/source/deployment.rst index 04ca7c5..8642a1d 100644 --- a/docs/source/deployment.rst +++ b/docs/source/deployment.rst @@ -13,7 +13,7 @@ Deploying Portainer is as simple as: .. code-block:: bash - $ docker run -d -p 9000:9000 --restart always -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer + $ docker run -d -p 9000:9000 --name portainer --restart always -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer Voilà, you can now access Portainer by pointing your web browser at ``http://DOCKER_HOST:9000`` @@ -27,7 +27,7 @@ Ensure you replace ``DOCKER_HOST`` with the address of the Docker host where Por .. code-block:: bash - $ docker run -d --privileged -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer + $ docker run -d --privileged -p 9000:9000 --name portainer -v /var/run/docker.sock:/var/run/docker.sock -v /opt/portainer:/data portainer/portainer You'll then be prompted to specify a new password for the ``admin`` account. After specifying your password, @@ -62,7 +62,7 @@ You can specify the initial endpoint you want Portainer to manage via the CLI, u .. code-block:: bash - $ docker run -d -p 9000:9000 portainer/portainer -H tcp://: + $ docker run -d -p 9000:9000 --name portainer portainer/portainer -H tcp://: Ensure you replace ``REMOTE_HOST`` and ``REMOTE_PORT`` with the address/port of the Docker engine you want to manage. @@ -70,7 +70,7 @@ You can also bind mount the Docker socket to manage a local Docker engine (**not .. code-block:: bash - $ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer -H unix:///var/run/docker.sock + $ docker run -d -p 9000:9000 --name portainer -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer -H unix:///var/run/docker.sock Connect to a Swarm cluster ========================== @@ -84,7 +84,7 @@ As simple as: .. code-block:: bash - $ docker run -d -p 9000:9000 portainer/portainer -H tcp://:2375 + $ docker run -d -p 9000:9000 --name portainer portainer/portainer -H tcp://:2375 Alternatively, if you're using swarm mode, you can also deploy it as a service in your cluster: @@ -115,13 +115,13 @@ You must ensure these files are present in the container using a bind mount: .. code-block:: bash - $ docker run -d -p 9000:9000 -v /path/to/certs:/certs portainer/portainer -H tcp://: --tlsverify + $ docker run -d -p 9000:9000 --name portainer -v /path/to/certs:/certs portainer/portainer -H tcp://: --tlsverify You can also use the ``--tlscacert``, ``--tlscert`` and ``--tlskey`` flags if you want to change the default path to the CA, certificate and key file respectively: .. code-block:: bash - $ docker run -d -p 9000:9000 -v /path/to/certs:/certs portainer/portainer -H tcp://: --tlsverify --tlscacert /certs/myCa.pem --tlscert /certs/myCert.pem --tlskey /certs/myKey.pem + $ docker run -d -p 9000:9000 --name portainer -v /path/to/certs:/certs portainer/portainer -H tcp://: --tlsverify --tlscacert /certs/myCa.pem --tlscert /certs/myCert.pem --tlskey /certs/myKey.pem Persist Portainer data ====================== @@ -133,13 +133,13 @@ to persist the data on the Docker host folder: .. code-block:: bash - $ docker run -d -p 9000:9000 -v /path/on/host/data:/data portainer/portainer + $ docker run -d -p 9000:9000 --name portainer -v /path/on/host/data:/data portainer/portainer On Windows: .. code-block:: none - $ docker run -d -p 9000:9000 -v C:\ProgramData\Portainer:C:\data portainer/portainer + $ docker run -d -p 9000:9000 --name portainer -v C:\ProgramData\Portainer:C:\data portainer/portainer If you deployed Portainer as a Docker Swarm service: @@ -163,7 +163,7 @@ To do so, you can use the following flags ``--ssl``, ``--sslcert`` and ``--sslke .. code-block:: bash - $ docker run -p 443:9000 -v ~/local-certs:/certs portainer/portainer --ssl --sslcert /certs/portainer.crt --sslkey /certs/portainer.key + $ docker run -p 443:9000 --name portainer -v ~/local-certs:/certs portainer/portainer --ssl --sslcert /certs/portainer.crt --sslkey /certs/portainer.key You can use the following commands to generate the required files: