selfhosted-apps-docker/portainer/readme.md

# Portainer in docker

###### guide by example

![logo](https://i.imgur.com/QxnuB1g.png)

# Purpose

Web UI for overview and management of docker environment.

* [Official site](https://www.portainer.io)
* [Github](https://github.com/portainer/portainer)
* [DockerHub image used](https://hub.docker.com/r/portainer/portainer/)

Portainer is a lightweight management web UI, that allows to easily manage
docker containers, networks, volumes, images,... the work.

In my use it is mostly information tool, rather than a management tool.

# Files and directory structure

```
/home/
└── ~/
    └── docker/
        └── portainer/
            ├── portainer-data/
            ├── .env
            └── docker-compose.yml
```

* `portainer-data/` - a directory where portainer stores its peristent data
* `.env` - a file containing environmental variables for docker compose
* `docker-compose.yml` - a docker compose file, telling docker
  how to build the containers

You only need to provide the files.</br>
The directory is created by docker compose on the first run.

# docker-compose

`docker-compose.yml`
```yml
version: '2'

services:
  portainer:
    image: portainer/portainer
    container_name: portainer
    hostname: portainer
    command: -H unix:///var/run/docker.sock
    restart: unless-stopped
    env_file: .env
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
      - ./portainer-data:/data

networks:
  default:
    external:
      name: $DEFAULT_NETWORK
```

`.env`
```bash
# GENERAL
MY_DOMAIN=example.com
DEFAULT_NETWORK=caddy_net
TZ=Europe/Bratislava
```

# reverse proxy

Caddy v2 is used, details
[here](https://github.com/DoTheEvo/selfhosted-apps-docker/tree/master/caddy_v2).</br>

`Caddyfile`
```
portainer.{$MY_DOMAIN} {
    reverse_proxy portainer:9000
}
```

# Update

[Watchtower](https://github.com/DoTheEvo/selfhosted-apps-docker/tree/master/watchtower)
updates the image automatically.

Manual image update:

- `docker-compose pull`</br>
- `docker-compose up -d`</br>
- `docker image prune`

# Backup and restore

#### Backup

Using [borg](https://github.com/DoTheEvo/selfhosted-apps-docker/tree/master/borg_backup)
that makes daily snapshot of the entire directory.
  
#### Restore

* down the portainer container `docker-compose down`</br>
* delete the entire portainer directory</br>
* from the backup copy back the portainer directory</br>
* start the container `docker-compose up -d`