diff --git a/Configuration.md b/Configuration.md index 78f43c0..01e0ac3 100644 --- a/Configuration.md +++ b/Configuration.md @@ -1 +1,56 @@ -Configuration \ No newline at end of file +# Portainer configuration + +Portainer can be tuned using CLI flags. + +## Use your own logo + +You do not like our logo? Want to make Portainer more corporate? Don't worry, you can easily switch for an external logo using the `--logo` flag: + +```shell +$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer --logo "https://www.docker.com/sites/all/themes/docker/assets/images/brand-full.svg" +``` + +## Hiding specific containers + +Portainer allows you to hide container with a specific label by using the `-l` flag. + +For example, take a container started with the label `owner=acme`: +```shell +$ docker run -d --label owner=acme nginx +``` + +Simply add the `-l owner=acme` option on the CLI when starting Portainer: +```shell +$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer -l owner=acme +``` + +## Use your own 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. + +Add the `--templates` flag and specify the external location of your templates when starting Portainer: + +```shell +$ docker run -d -p 9000:9000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer --templates http://my-host.my-domain/templates.json +``` + +For more information about hosting your own template definitions and the format, see: https://github.com/portainer/templates + +## Available flags + +The following flags are available: + +* `--host`, `-H`: Docker daemon endpoint (default: `"unix:///var/run/docker.sock"`) +* `--bind`, `-p`: Address and port to serve Portainer (default: `":9000"`) +* `--data`, `-d`: Path to the data folder (default: `"."`) +* `--assets`, `-a`: Path to the assets (default: `"."`) +* `--swarm`, `-s`: Docker Swarm cluster / swarm-mode support (default: `false`) +* `--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`) +* `--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 +* `--templates`, `-t`: URL to templates (apps) definitions \ No newline at end of file