feat(general): update docs to match 1.11.1 release

docs/source/conf.py

@@ -57,9 +57,9 @@ author = u'Portainer.io'
 # built documents.
 #
 # The short X.Y version.
-version = u'1.11.0'
+version = u'1.11.1'
 # The full version, including alpha/beta/rc tags.
-release = u'1.11.0'
+release = u'1.11.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -133,7 +133,7 @@ html_theme = 'alabaster'
 # The name for this set of Sphinx documents.
 # "<project> v<release> documentation" by default.
 #
-# html_title = u'Portainer v1.11.0'
+# html_title = u'Portainer v1.11.1'
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
 #

docs/source/configuration.rst

@@ -56,12 +56,13 @@ Available flags
 
 The following CLI flags are available:
 
-* ``--host``, ``-H``: Docker daemon endpoint (default: ``unix:///var/run/docker.sock``)
+* ``--host``, ``-H``: Docker daemon endpoint
 * ``--bind``, ``-p``: Address and port to serve Portainer (default: ``:9000``)
+* ``--data``, ``-d``: Directory where Portainer data will be stored (default: ``/data`` on Linux, ``C:\data`` on Windows)
 * ``--tlsverify``: TLS support (default: ``false``)
-* ``--tlscacert``: Path to the CA (default: ``/certs/ca.pem``)
-* ``--tlscert``: Path to the TLS certificate file (default: ``/certs/cert.pem``)
-* ``--tlskey``: Path to the TLS key (default: ``/certs/key.pem``)
+* ``--tlscacert``: Path to the CA (default: ``/certs/ca.pem`` on Linux, `C:\certs\ca.pem` on Windows)
+* ``--tlscert``: Path to the TLS certificate file (default: ``/certs/cert.pem``, `C:\certs\cert.pem` on Windows)
+* ``--tlskey``: Path to the TLS key (default: ``/certs/key.pem``, `C:\certs\key.pem` on Windows)
 * ``--hide-label``, ``-l``: Hide containers with a specific label in the UI
 * ``--logo``: URL to a picture to be displayed as a logo in the UI, use Portainer logo if not specified
 * ``--templates``, ``-t``: URL to templates (apps) definitions (default: ``https://raw.githubusercontent.com/portainer/templates/master/templates.json``)

docs/source/deployment.rst

@@ -4,11 +4,16 @@ Deployment
 
 Portainer is built to run on Docker and is really simple to deploy.
 
-**Note**: the following instructions target Docker for Linux, if your target is Docker for Windows please use the
-``portainer/portainer:windows`` Docker image instead of the ``portainer/portainer`` Docker image.
+**Note**: the following instructions target Docker for Linux (also works on Mac), if you want to use Portainer on another platform please change the `portainer/portainer` image accordingly:
+
+* Docker **on** Windows (different that Docker **for** Windows): `portainer/portainer:windows`
+* ARM: `portainer/portainer:arm`
+* ARM64: `portainer/portainer:arm64`
 
 Portainer deployment scenarios can be executed on both platforms unless specified.
 
+Note for Windows users: Docker **for** Windows is different than Docker **on** Windows, please ensure your installation type before starting.
+
 Quick start
 ===========
 
@@ -32,7 +37,7 @@ After your first authentication, Portainer will ask you information about the Do
 
 You'll have the following choices:
 
-* Manage the local engine where Portainer is running (you'll need to bind mount the Docker socket via `-v /var/run/docker.sock:/var/run/docker.sock` on the Docker CLI)
+* (**LINUX ONLY**) Manage the local engine where Portainer is running (you'll need to bind mount the Docker socket via `-v /var/run/docker.sock:/var/run/docker.sock` on the Docker CLI)
 * Manage a remote Docker engine, you'll just have to specify the url to your Docker endpoint, give it a name and TLS info if needed
 
 Declare initial endpoint via CLI
@@ -85,7 +90,7 @@ If your Docker engine is protected using TLS, you'll need to ensure that you hav
 
 You can upload the required files via the Portainer UI or use the ``--tlsverify`` flag on the CLI.
 
-Portainer will try to use the following paths to the files specified previously:
+Portainer will try to use the following paths to the files specified previously (on Linux, see the configuration section for details about Windows):
 
 * CA: ``/certs/ca.pem``
 * certificate: ``/certs/cert.pem``
@@ -106,7 +111,7 @@ You can also use the ``--tlscacert``, ``--tlscert`` and ``--tlskey`` flags if yo
 Persist Portainer data
 ======================
 
-By default, Portainer will store its data inside the container in the `/data` folder (this can be changed via CLI, see configuration).
+By default, Portainer will store its data inside the container in the `/data` folder on Linux (`C:\data` on Windows, this can be changed via CLI, see configuration).
 
 You'll need to persist Portainer data to keep your changes after restart/upgrade of the Portainer container. You can use a bind mount
 to persist the data on the Docker host folder:
@@ -115,6 +120,12 @@ to persist the data on the Docker host folder:
 
   $ docker run -d -p 9000:9000 -v /path/on/host/data:/data portainer/portainer
 
+On Windows:
+
+.. code-block:: powershell
+
+  $ docker run -d -p 9000:9000 -v C:\ProgramData\Portainer:C:\data portainer/portainer:windows
+
 
 Without Docker
 ==============
@@ -126,8 +137,8 @@ Download and extract the binary to a location on disk:
 .. code-block:: bash
 
   $ cd /opt
-  $ wget https://github.com/portainer/portainer/releases/download/1.11.0/portainer-1.11.0-linux-amd64.tar.gz
-  $ tar xvpfz portainer-1.11.0-linux-amd64.tar.gz
+  $ wget https://github.com/portainer/portainer/releases/download/1.11.1/portainer-1.11.1-linux-amd64.tar.gz
+  $ tar xvpfz portainer-1.11.1-linux-amd64.tar.gz
 
 Then just use the portainer binary as you would use CLI flags with Docker.
 

docs/source/templates.rst

@@ -57,7 +57,7 @@ The Docker image associated to the template. The image tag **must** be included.
 This field is **mandatory**.
 
 ``registry``
----------
+------------
 
 The registry where the Docker image is stored. If not specified, Portainer will use the Dockerhub as the default registry.