Portainer#

Portainer is a Docker management interface, for the more advanced user.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: 2.0.1

SETUP#

Enabling portainer#

Command:#

vlab set portainer.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
enable: True

Finalising changes:#

run: vlab update_one service=portainer

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, portainer makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=portainer to complete the changes

ACCESS#

portainer (HTTPS) link: https://portainer.vivumlab.xyz/ portainer (HTTP) link: http://portainer.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set portainer.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
https_only: True
Finalising changes:#

run: vlab update_one service=portainer

AUTH#

Default: False
Options: True/False

Command:#

vlab set portainer.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
auth: True
Finalising changes:#

run: vlab update_one service=portainer

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set portainer.domain portainer.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
domain: portainer.com
Finalising changes:#

run: vlab update_one service=portainer

SUBDOMAIN#

Default: portainer
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set portainer.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
subdomain: media
Finalising changes:#

run: vlab update_one service=portainer

VERSION#

Default: 2.0.1
NOTE: Ensure that the version exists

Command:#

vlab set portainer.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

portainer
version: 2.7
Finalising changes:#

run: vlab update_one service=portainer

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.