Portainer

https://docs.portainer.io
Admin
Portainer is a lightweight UI management platform for Docker, Kubernetes, Docker Swarm, Azure ACI,...
Tokens:130,178
Snippets:2,320
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Deploy Portainer Agent with Host Filesystem Access

Source: https://docs.portainer.io/user/docker/host/setup.md

Example command to start the Portainer Agent with the necessary host filesystem bind mount.

```bash
docker run -d -p 9001:9001 --name portainer_agent --restart=always -v /var/run/docker.sock:/var/run/docker.sock -v /var/lib/docker/volumes:/var/lib/docker/volumes -v /:/host portainer/agent:2.22.0
```

--------------------------------

### Start Portainer with SIEM logging enabled

Source: https://docs.portainer.io/advanced/siem.md

Example command to initialize a Portainer container with Syslog streaming configured for a specific host and port.

```bash
docker run -d -p 8000:8000 -p 9443:9443 \
    --name portainer \
    --restart=always \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v portainer_data:/data \
    portainer/portainer-ee:sts \
    --syslog-address=syslog.mydomain.com \
    --syslog-port=514 \
    --syslog-source-hostname="my-portainer-instance"
```

--------------------------------

### Run container with label

Source: https://docs.portainer.io/advanced/cli.md

Example of starting a container with a specific label for later filtering.

```bash
docker run -d --label owner=acme nginx
```

--------------------------------

### Build and run the project

Source: https://docs.portainer.io/contribute/build.md

Compiles the project and starts the development server.

```makefile
make dev
```

--------------------------------

### Install NVM and Node.js

Source: https://docs.portainer.io/contribute/build/mac.md

Install the Node Version Manager (NVM) and use it to install Node.js version 22.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
```

```bash
nvm install 22
```

--------------------------------

### Install NVM

Source: https://docs.portainer.io/contribute/build/linux.md

Download and install the Node Version Manager (NVM) script.

```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
```

--------------------------------

### Install pnpm

Source: https://docs.portainer.io/contribute/build/linux.md

Use the official installation script to install pnpm on a POSIX system.

```bash
curl -fsSL https://get.pnpm.io/install.sh | sh -
```

--------------------------------

### Example local filesystem path

Source: https://docs.portainer.io/advanced/relative-paths.md

The base path specified for stack deployment.

```text
/mnt/stacks/
```

--------------------------------

### POST /api/users/admin/init

Source: https://docs.portainer.io/api/examples.md

Initializes the Portainer admin account on a fresh installation.

```APIDOC
## POST /api/users/admin/init

### Description
Initializes the admin account on a fresh Portainer installation.

### Method
POST

### Endpoint
<portainer url>/api/users/admin/init

### Request Body
- **Username** (string) - Required - The desired admin username
- **Password** (string) - Required - The desired admin password
```

--------------------------------

### Example Downloaded Filenames

Source: https://docs.portainer.io/admin/environments/add/kube-create/microk8s/offline.md

The expected file structure after downloading the snap packages.

```text
core20_2318.assert
core20_2318.snap
microk8s_6743.assert
microk8s_6743.snap
```

--------------------------------

### Install development dependencies

Source: https://docs.portainer.io/contribute/build.md

Installs necessary project dependencies using the Makefile.

```makefile
make deps
```

--------------------------------

### Deployment Confirmation Output

Source: https://docs.portainer.io/admin/environments/add/swarm/agent.md

Example output returned after executing the deployment command.

```text
Creating network portainer-agent_portainer_agent
Creating service portainer-agent_agent
```

--------------------------------

### Example service output

Source: https://docs.portainer.io/start/upgrade/swarm.md

Sample output showing the current state of Portainer services.

```text
ID             NAME                    MODE         REPLICAS   IMAGE                          PORTS
tb9gtxc647fw   portainer-agent_agent   global       3/3        portainer/agent:2.39.0
m3a3mtuy55ed   portainer_portainer     replicated   1/1        portainer/portainer-ee:2.39.0  *:8000->8000/tcp, *:9000->9000/tcp
```

--------------------------------

### Install Node.js via NVM

Source: https://docs.portainer.io/contribute/build/linux.md

Install Node.js version 22 using the NVM tool.

```bash
nvm install 22
```

--------------------------------

### Initialize Admin Account

Source: https://docs.portainer.io/api/examples.md

Initializes the admin account on a fresh Portainer installation.

```bash
http POST <portainer url>/api/users/admin/init Username="<admin username>" Password="<adminpassword>"
```

--------------------------------

### Install repository dependencies

Source: https://docs.portainer.io/contribute/build/linux.md

Installs the necessary packages to allow apt to use repositories over HTTPS.

```bash
sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common
```

--------------------------------

### Install Wget via apt-get

Source: https://docs.portainer.io/contribute/build/linux.md

Use this command in the terminal to install the Wget package on Debian-based Linux distributions.

```bash
apt-get install wget
```

--------------------------------

### Query documentation via HTTP GET

Source: https://docs.portainer.io/llms.txt

Perform a GET request to the documentation index with 'ask' and 'goal' parameters to receive a direct answer.

```http
GET https://docs.portainer.io/release-notes.md?ask=<question>&goal=<end_goal>
```

--------------------------------

### Verify Docker installation

Source: https://docs.portainer.io/contribute/build/linux.md

Runs the hello-world container to confirm that the Docker daemon is functioning correctly.

```bash
sudo docker run hello-world
```

--------------------------------

### POST /api/endpoints/<ENVIRONMENT_ID>/docker/containers/<CONTAINER_ID>/start

Source: https://docs.portainer.io/api/examples.md

Starts a previously created container.

```APIDOC
## POST /api/endpoints/<ENVIRONMENT_ID>/docker/containers/<CONTAINER_ID>/start

### Description
Starts a container using its unique ID.

### Method
POST

### Endpoint
/api/endpoints/<ENVIRONMENT_ID>/docker/containers/<CONTAINER_ID>/start

### Parameters
#### Path Parameters
- **ENVIRONMENT_ID** (string) - Required - The ID of the environment.
- **CONTAINER_ID** (string) - Required - The ID of the container to start.
```

--------------------------------

### Deploy and verify Portainer deployment

Source: https://docs.portainer.io/advanced/reverse-proxy/nginx.md

Commands to start the services and verify that the containers are running correctly.

```bash
docker-compose up -d
```

```bash
docker ps
```

```text
CONTAINER ID   IMAGE                           COMMAND                  CREATED         STATUS         PORTS                                                           NAMES
8c8f2eac7c9a   portainer/portainer-ee:sts      "/portainer -H unix:…"   4 minutes ago   Up 4 minutes   9000/tcp, 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp, 9443/tcp   portainer_portainer_1
3e7c8b5d71d7   nginxproxy/nginx-proxy          "/app/docker-entrypo…"   4 minutes ago   Up 4 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp                               portainer_nginx-proxy_1
```

--------------------------------

### GET /settings

Source: https://docs.portainer.io/release-notes.md

Retrieves the current Portainer settings, now including OAuth authentication style information.

```APIDOC
## GET /settings

### Description
Retrieve Portainer settings.

### Method
GET

### Endpoint
/settings

### Response
#### Success Response (200)
- **OAuthSettings.AuthStyle** (string) - Added authentication style for OAuth.
```

--------------------------------

### Build and run a template container

Source: https://docs.portainer.io/advanced/app-templates/build.md

Commands to clone the repository, build the image, and start the container to serve the templates.json file.

```bash
git clone https://github.com/portainer/templates.git portainer-templates
cd portainer-templates
# Edit the file templates.json
docker build -t portainer-templates .
docker run -d -p "8080:80" portainer-templates
```

--------------------------------

### Verify Node.js installation

Source: https://docs.portainer.io/contribute/build/mac.md

Check the installed version of Node.js.

```bash
node --version
```

--------------------------------

### Example container list output

Source: https://docs.portainer.io/faqs/troubleshooting/logs-errors-and-debugging/how-can-i-get-the-logs-for-portainer-itself.md

Sample output showing the container ID and image name for Portainer.

```text
CONTAINER ID   IMAGE                          COMMAND                    REATED     STATUS    PORTS                                                                                          NAMES
2c9085c1d664   portainer/portainer-ee:latest  "/portainer"               3 days ago Up 3 days 0.0.0.0:8000->8000/tcp, :::8000->8000/tcp, 0.0.0.0:9443->9443/tcp, :::9443->9443/tcp, 9000/tcp portainer
be84ee30270e   mysql:8.0                      "docker-entrypoint.s…   "  4 days ago Exited (1) 4 days ago                                                                                    mysql
4604a2f5108e   nginx:latest                   "/docker-entrypoint.…"     4 days ago Up 4 days 0.0.0.0:80->80/tcp, :::80->80/tcp                                                              nginx
```

--------------------------------

### Install Docker CE

Source: https://docs.portainer.io/contribute/build/linux.md

Installs the Docker Community Edition engine and CLI tools.

```bash
sudo apt-get install docker-ce docker-ce-cli containerd.io
```

--------------------------------

### Verify pnpm installation

Source: https://docs.portainer.io/contribute/build/mac.md

Check the installed version of pnpm to ensure it is correctly configured.

```bash
pnpm --version
```

--------------------------------

### Deploy Portainer with custom SSL certificates

Source: https://docs.portainer.io/advanced/ssl.md

Use these commands to start Portainer with custom certificates mounted from a local directory. Ensure the certificate file includes the full chain.

```bash
docker run -d -p 9443:9443 -p 8000:8000 \
    --name portainer --restart always \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v portainer_data:/data \
    -v /path/to/your/certs:/certs \
    portainer/portainer-ee:sts \
    --sslcert /certs/portainer.crt \
    --sslkey /certs/portainer.key
```

```bash
docker run -d -p 9443:9443 -p 8000:8000 \
    --name portainer --restart always \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v portainer_data:/data \
    -v /path/to/your/certs:/certs \
    portainer/portainer-ce:sts \
    --sslcert /certs/portainer.crt \
    --sslkey /certs/portainer.key
```

--------------------------------

### Start a container via Portainer API

Source: https://docs.portainer.io/api/examples.md

Starts an existing container using its unique identifier.

```http
http POST <portainer url>/api/endpoints/1/docker/containers/5fc2a93d7a3d426a1c3937436697fc5e5343cc375226f6110283200bede3b107/start \
    X-API-Key:your_access-token
```

--------------------------------

### Enable Corepack and install pnpm

Source: https://docs.portainer.io/contribute/build/mac.md

Use Corepack to enable and install the specific version of pnpm required for the environment.

```bash
corepack enable
```

```bash
corepack use pnpm@10.26.2
```

--------------------------------

### Initialize Docker Swarm Infrastructure

Source: https://docs.portainer.io/advanced/reverse-proxy/traefik.md

Create the necessary overlay networks and volumes before deploying the Swarm stack.

```bash
 docker network create -d overlay agent_network
```

```bash
 docker network create -d overlay public
```

```bash
 docker volume create portainer_data
```

--------------------------------

### Install Portainer via Helm

Source: https://docs.portainer.io/advanced/ssl.md

Install Portainer using Helm, referencing the existing TLS secret for SSL configuration.

```bash
helm install -n portainer portainer portainer/portainer \
    --set tls.existingSecret=portainer-tls-secret \
    --set enterpriseEdition.enabled=true
```

```bash
helm install -n portainer portainer portainer/portainer \
    --set tls.existingSecret=portainer-tls-secret
```

```bash
helm install -n portainer portainer portainer/portainer \
    --set tls.existingSecret=portainer-tls-secret \
    --set service.type=LoadBalancer \
    --set enterpriseEdition.enabled=true
```

```bash
helm install -n portainer portainer portainer/portainer \
    --set tls.existingSecret=portainer-tls-secret \
    --set service.type=LoadBalancer
```

--------------------------------

### Reset helper output examples

Source: https://docs.portainer.io/advanced/reset-admin.md

Expected output logs when the password is successfully updated or a new admin user is created.

```text
2020/06/04 00:13:58 Password successfully updated for user: admin
2020/06/04 00:13:58 Use the following password to login: &_4#\3^5V8vLTd)E"NWiJBs26G*9HPl1
```

```text
2022/08/10 07:36:33 [WARN] Unable to retrieve user with ID 1, will try to create, err: object not found inside the database
2022/08/10 07:36:33 Admin user admin-u0512b3f0v4dqk7o successfully created
2022/08/10 07:36:33 Use the following password to login: Sr#]YL_6D0k8Pd{pA9^|}F32j5J4I=av
```

--------------------------------

### Administrator Only Configuration

Source: https://docs.portainer.io/advanced/app-templates/format.md

Example of setting the administrator_only flag.

```json
{
  "administrator_only": true
}
```

--------------------------------

### Portainer Agent Image

Source: https://docs.portainer.io/admin/environments/add/kube-create/microk8s/offline.md

The required Portainer Agent image for the installation.

```text
docker.io/portainer/agent:{PORTAINER_SERVER_VERSION}
```

--------------------------------

### Example Password Reset Output

Source: https://docs.portainer.io/advanced/reset-admin.md

Expected output format showing the successful password update and the new credentials.

```text
2020/06/04 00:13:58 Password successfully updated for user: admin
2020/06/04 00:13:58 Use the following password to login: &_4#\3^5V8vLTd)E"NWiJBs26G*9HPl1
```

--------------------------------

### Install Docker CE via PowerShell

Source: https://docs.portainer.io/start/install-ce/server/docker/wcs.md

Download and execute the Microsoft-provided script to set up the Windows Container Host Service and Docker.

```powershell
Invoke-WebRequest -UseBasicParsing "https://raw.githubusercontent.com/microsoft/Windows-Containers/Main/helpful_tools/Install-DockerCE/install-docker-ce.ps1" -o install-docker-ce.ps1
.\install-docker-ce.ps1
```

--------------------------------

### Specify StorageClass in Helm

Source: https://docs.portainer.io/start/install/server/kubernetes/baremetal.md

Pass the storage class parameter during Helm installation.

```bash
--set persistence.storageClass=<storage-class-name>
```

--------------------------------

### Start Portainer with admin password file

Source: https://docs.portainer.io/advanced/cli.md

Mount the password file into the container and specify its path using the --admin-password-file flag.

```bash
docker run -d -p 9443:9443 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/portainer_password:/tmp/portainer_password portainer/portainer-ee:sts --admin-password-file /tmp/portainer_password
```

```bash
docker run -d -p 9443:9443 -p 8000:8000 -v /var/run/docker.sock:/var/run/docker.sock -v /tmp/portainer_password:/tmp/portainer_password portainer/portainer-ce:sts --admin-password-file /tmp/portainer_password
```

--------------------------------

### Access Portainer UI

Source: https://docs.portainer.io/start/install/server/docker/wsl.md

The URL to access the Portainer web interface after installation.

```bash
https://localhost:9443
```
Tokens:
Raw