diff --git a/docs/assets/icon.webp b/docs/assets/icon.webp new file mode 100644 index 0000000..298f971 Binary files /dev/null and b/docs/assets/icon.webp differ diff --git a/docs/v2.0/deploy/assets/initial-1.png b/docs/v2.0/deploy/assets/initial-1.png new file mode 100644 index 0000000..d205590 Binary files /dev/null and b/docs/v2.0/deploy/assets/initial-1.png differ diff --git a/docs/v2.0/deploy/assets/initial-2.png b/docs/v2.0/deploy/assets/initial-2.png new file mode 100644 index 0000000..24a0c48 Binary files /dev/null and b/docs/v2.0/deploy/assets/initial-2.png differ diff --git a/docs/v2.0/deploy/assets/initial-3.png b/docs/v2.0/deploy/assets/initial-3.png new file mode 100644 index 0000000..eb4f4ab Binary files /dev/null and b/docs/v2.0/deploy/assets/initial-3.png differ diff --git a/docs/v2.0/deploy/assets/initial-4.png b/docs/v2.0/deploy/assets/initial-4.png new file mode 100644 index 0000000..09c5a85 Binary files /dev/null and b/docs/v2.0/deploy/assets/initial-4.png differ diff --git a/docs/v2.0/deploy/assets/initial-5.png b/docs/v2.0/deploy/assets/initial-5.png new file mode 100644 index 0000000..1fa767d Binary files /dev/null and b/docs/v2.0/deploy/assets/initial-5.png differ diff --git a/docs/v2.0/deploy/cli.md b/docs/v2.0/deploy/cli.md new file mode 100644 index 0000000..c712afc --- /dev/null +++ b/docs/v2.0/deploy/cli.md @@ -0,0 +1,107 @@ +# CLI Configuration Options + +Portainer can be easily tuned using CLI flags. + +## Admin password +### From the command line +Portainer allows you to specify a bcrypt encrypted password from the command line for the admin account. You need to generate the bcrypt encrypted password first. + +You can generate the encrypted password with the following command if you have installed apache2-utils package: + +
$ htpasswd -nb -B admin "your-password" | cut -d ":" -f 2
+ +If you system don't have the mentioned package, you can run a container to run the command: + +
docker run --rm httpd:2.4-alpine htpasswd -nbB admin "your-password" | cut -d ":" -f 2
+ +To specify the admin password from the command line, start Portainer with the --admin-password flag: + +
docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce --admin-password='$2y$05$8oz75U8m5tI/xT4P0NbSHeE7WyRzOWKRBprfGotwDkhBOGP/u802u'
+ +### Inside a file +You can also store the plaintext password inside a file and use the --admin-password-file flag: + +Add your password to a file running the following command: + +
$ echo -n mypassword > /tmp/portainer_password
+ +Now you can start the Portainer container running: + +
$ docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/portainer_password:/tmp/portainer_password portainer/portainer-ce --admin-password-file /tmp/portainer_password
+ +This works well with Docker Swarm and Docker secrets too: + +
$ echo -n mypassword | docker secret create portainer-pass -
+ +
$ docker service create \
+  --name portainer \
+  --secret portainer-pass \
+  --publish 9000:9000 \
+  --publish 8000:8000 \
+  --replicas=1 \
+  --constraint 'node.role == manager' \
+  --mount type=bind,src=/var/run/docker.sock,dst=/var/run/docker.sock \
+  portainer/portainer-ce \
+  --admin-password-file '/run/secrets/portainer-pass' \
+  -H unix:///var/run/docker.sock
+ +Note: This will automatically create an administrator account called admin with the specified password. + +## Hiding specific 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): + +
$ docker run -d --label owner=acme nginx
+ +To hide this container, simply add the -l owner=acme option on the CLI when starting Portainer: + +
$ docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce -l owner=acme
+ +Note that the -l flag can be repeated multiple times to specify multiple labels: + +
$ docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce -l owner=acme -l service=secret
+ +## 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 (it must be exactly 155px by 55px) using the --logo flag: + +
$ docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce --logo "https://www.docker.com/sites/all/themes/docker/assets/images/brand-full.svg"
+ +## Use your own templates + +Portainer allows you to rapidly deploy containers using App Templates. + +By default Portainer templates will be used but you can also define your own templates. + +Note: at the moment, templates are only loaded once at first Portainer startup. If you already deployed a Portainer instance and want to use your own templates after this, you’ll need to clear any existing templates (default templates) via the HTTP API. + +Using the --templates flag you can specify an URL where the template file can be accessed via HTTP. + +
$ docker run -d -p 9000:9000 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock portainer/portainer-ce --templates http://my-host.my-domain/templates.json
+ +Suggestion: You can host yours templates files in [Github](https://www.github.com) + +## Available flags + +The following CLI flags are available: + +* --admin-password: Specify a bcrypt hashed password for the admin user +* --admin-password-file: Path to the file containing the password for the admin user +* --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) +* --edge-compute: Automatically enable edge-compute features +* --hide-label, -l: Hide containers with a specific label in the UI +* --host, -H: Docker daemon endpoint +* --logo: URL to a picture to be displayed as a logo in the UI, use Portainer logo if not specified +* --snapshot-interval: Time interval between two endpoint snapshot jobs expressed as a string, e.g. 30s, 5m, 1h… as supported by the time.ParseDuration method (default: 5m) +* --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) +* --templates, -t: URL to templates (apps) definitions +* --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) +* --tlsverify: TLS support (default: false) +* --tunnel-port: Specify an alternate tunnel port to use with the Edge agent. Use --tunnel-port 8001 with -p 8001:8001 to make the Edge agent communicate on port 8001 \ No newline at end of file diff --git a/docs/v2.0/deploy/initial.md b/docs/v2.0/deploy/initial.md new file mode 100644 index 0000000..5e952fa --- /dev/null +++ b/docs/v2.0/deploy/initial.md @@ -0,0 +1,35 @@ +# Initial screen after installation + +Once you deploy Portainer and head your browser to http://ip-server:9000, you will see the following screens. + +## Set Password Admin + +The first thing to do is set a password for the admin user. This password needs to be at least eight characters long. + +![admin_password](assets/initial-1.png) + +## Collection of statics + +We anonymously collect information about how Portainer is used. You can disable this option, but we recommend leaving it activated. This will help us understand how our users use Portainer and improve it. + +You can read more about our privacy policy [here](https://www.portainer.io/documentation/in-app-analytics-and-privacy-policy/) + +You can leave enable or disable doing a click in the checkbox: + +![statics](assets/initial-2.png) + +## Connect Portainer to the container environment + +If you installed [Portainer in Kubernetes](/v2.0/deploy/linux/#deploy-portainer-in-kubernetes) you would choose Kubernetes, but if you [installed in Docker](/v2.0/deploy/linux/#deploy-portainer-in-docker), you may want choose manage the local Docker environment. + +![kubernetes-initial](assets/initial-3.png) + +![docker-initial](assets/initial-4.png) + +Once that is decided, do a click in connect. If everything works as expected, you will see the Portainer homepage. + +![portainer-initial](assets/initial-5.png) + +## Notes + +Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. \ No newline at end of file diff --git a/docs/v2.0/deploy/linux.md b/docs/v2.0/deploy/linux.md index a5c2241..c4011a0 100644 --- a/docs/v2.0/deploy/linux.md +++ b/docs/v2.0/deploy/linux.md @@ -55,7 +55,7 @@ Portainer is comprised of two elements, the Portainer Server, and the Portainer Note that the recommended deployment mode when using Swarm is using the Portainer Agent. -To see the requeriments, please, visit the page of [requirements](v2.0/deploy/requeriments.md) +To see the requeriments, please, visit the page of [requirements](/v2.0/deploy/requeriments.md) ### Docker Standalone @@ -86,4 +86,4 @@ Deploy Portainer Agent on a remote LINUX Swarm Cluster as a Swarm Service, run t ## Notes -Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. \ No newline at end of file +Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. diff --git a/docs/v2.0/deploy/requirements.md b/docs/v2.0/deploy/requirements.md new file mode 100644 index 0000000..d7b8b7e --- /dev/null +++ b/docs/v2.0/deploy/requirements.md @@ -0,0 +1,35 @@ +# Requeriments + +In this article, you will find information about the supported platforms and Docker versions. + +## Supported Platforms + +Portainer can be deployed on the following platforms: + +- Linux amd64 +- Linux arm +- Linux arm64 +- Linux ppc64le +- Linux s390x +- Windows amd64 +- Darwin amd64 + +## Supported Docker Versions + +The required Docker version to have full support is 1.9.1 or newest. Docker 1.9 is partially supported. Older versions than indicated here, are not supported. + +## Supported Docker Swarm + +Portainer is compatible with the following versions of Docker Swarm: v1.2.3 + +## Supported Kubernetes versions + +The following versions of Kubernetes are fully supported: + +- 1.16 +- 1.17 +- 1.18 + +## Notes + +Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. \ No newline at end of file diff --git a/docs/v2.0/deploy/ssl.md b/docs/v2.0/deploy/ssl.md new file mode 100644 index 0000000..2fa0dfd --- /dev/null +++ b/docs/v2.0/deploy/ssl.md @@ -0,0 +1,13 @@ +# Secure Portainer using SSL + +By default, Portainer’s web interface and API is exposed over HTTP. This is not secured, it’s recommended to enable SSL in a production environment. + +To do so, you can use the following flags --ssl, --sslcert and --sslkey: + +
$ docker run -d -p 443:9000 -p 8000:8000 --name portainer --restart always -v /var/run/docker.sock:/var/run/docker.sock -v ~/local-certs:/certs -v portainer_data:/data portainer/portainer-ce --ssl --sslcert /certs/portainer.crt --sslkey /certs/portainer.key
+ +Now, you can navigate to https://$ip-docker-host + +## Notes + +Do you think that is missing something here? Contribute with this admin guide forking the repo [Portainer-Docs](https://github.com/portainer/portainer-docs) and propose changes. \ No newline at end of file diff --git a/docs/v2.0/deploy/windows10.md b/docs/v2.0/deploy/windows10.md index 6c1e700..34abdd6 100644 --- a/docs/v2.0/deploy/windows10.md +++ b/docs/v2.0/deploy/windows10.md @@ -42,7 +42,7 @@ Portainer is comprised of two elements, the Portainer Server, and the Portainer Note that the recommended deployment mode when using Swarm is using the Portainer Agent. -To see the requeriments, please, visit the page of [requirements](v2.0/deploy/requeriments.md) +To see the requeriments, please, visit the page of [requirements](/v2.0/deploy/requeriments.md) ### Docker Standalone in WSL2 diff --git a/docs/v2.0/requirements.md b/docs/v2.0/requirements.md deleted file mode 100644 index e69de29..0000000 diff --git a/mkdocs.yml b/mkdocs.yml index 067fe97..25e05af 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -5,12 +5,12 @@ nav: - Portainer CE 2.0: - Deploying Portainer: - 'Requirements' : 'v2.0/deploy/requirements.md' - - 'CLI options' : 'v2.0/deploy/clioptions.md' + - 'CLI options' : 'v2.0/deploy/cli.md' - 'Deploying on Linux' : 'v2.0/deploy/linux.md' - 'Deploying on Windows Server' : 'v2.0/deploy/windowsserver.md' - 'Deploying on Windows 10' : 'v2.0/deploy/windows10.md' - 'Using SSL with Portainer' : 'v2.0/deploy/ssl.md' - - 'Initial Setup' : 'v2.0/deploy/initialsetup.md' + - 'Initial Setup' : 'v2.0/deploy/initial.md' - Adding Endpoints: - 'Local Endpoint' : 'v2.0/endpoints/local.md' - 'Deploy and connect Portainer agent in Docker' : 'v2.0/endpoints/docker.md' @@ -43,6 +43,7 @@ theme: features: - instant logo: assets/logo.png + favicon: assets/icon.webp name: material palette: primary: light-blue @@ -51,12 +52,12 @@ repo_url: https://github.com/portainer/portainer-docs extra: social: - icon: fontawesome/brands/twitter - link: https://twitter.com/squidfunk + link: https://twitter.com/portainerio - icon: fontawesome/brands/linkedin - link: https://twitter.com/squidfunk + link: https://www.linkedin.com/company/portainer/ - icon: fontawesome/brands/youtube - link: https://twitter.com/squidfunk + link: https://www.youtube.com/channel/UC7diMJcrULjDseq5yhSUZgg - icon: fontawesome/brands/facebook - link: https://twitter.com/squidfunk + link: https://www.facebook.com/portainerio/ - icon: fontawesome/brands/reddit - link: https://twitter.com/squidfunk + link: https://reddit.com/r/portainer