Portainer
/
portainer-docs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(configuration): document deprecated flags

pull/27/head
Anthony Lapenna 2017-06-01 10:26:02 +02:00
parent c59dba9ed2
commit 303d54ea0a
1 changed files with 18 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
docs/source/configuration.rst
View File

@ -39,6 +39,9 @@ To specify the admin password from the command line, start Portainer with the ``
Hiding specific containers
==========================
**Deprecation notice**: the ``-l`` flag is deprecated and will be remove in future versions. Use the settings section in Portainer UI
to manage hidden containers.
Portainer allows you to hide containers with a specific label by using the ``-l`` flag.
For example, take a container started with the label *owner=acme* (note that this is an example label, you can define your own labels):
@ -62,6 +65,9 @@ Note that the ``-l`` flag can be repeated multiple times to specify multiple lab
Use your own logo
=================
**Deprecation notice**: the ``--logo`` flag is deprecated and will be remove in future versions. Use the settings section in Portainer UI
to change the logo.
You do not like our logo? Want to make Portainer more corporate? Don't worry, you can easily switch for an external logo (it must be exactly 155px by 55px) using the ``--logo`` flag:
.. code-block:: bash
@ -71,6 +77,9 @@ You do not like our logo? Want to make Portainer more corporate? Don't worry, yo
Use your own templates
======================
**Deprecation notice**: the ``--templates`` flag is deprecated and will be remove in future versions. Use the settings section in Portainer UI
to change templates.
Portainer allows you to rapidly deploy containers using App Templates.
By default `Portainer templates <https://raw.githubusercontent.com/portainer/templates/master/templates.json>`_ will be used but you can also define your own templates.
@ -110,9 +119,6 @@ The following CLI flags are available:
* ``--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``)
* ``--no-analytics``: Disable analytics (default: ``false``)
* ``--no-auth``: Disable internal authentication mechanism (default: ``false``)
* ``--external-endpoints``: Enable external endpoint management by specifying the path to a JSON endpoint source in a file
@ -121,3 +127,12 @@ The following CLI flags are available:
* ``--ssl``: Secure Portainer instance using SSL (default: ``false``)
* ``--sslcert``: Path to the SSL certificate used to secure the Portainer instance (default: ``/certs/portainer.crt``, ``C:\certs\portainer.crt`` on Windows)
* ``--sslkey``: Path to the SSL key used to secure the Portainer instance (default: ``/certs/portainer.key``, ``C:\certs\portainer.key`` on Windows)
Deprecated flags
================
The following CLI flags are deprecated and should not be used anymore:
* ``--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``)