Cockpit#

Cockpit Cockpit admin interface package for configuring and troubleshooting a system

Information#

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

SETUP#

Enabling cockpit#

Command:#

vlab set cockpit.enable True

File alteration:#

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

eg.

cockpit
enable: True

Finalising changes:#

run: vlab update_one service=cockpit

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, cockpit 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=cockpit to complete the changes

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set cockpit.https_only True

File alteration:#

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

eg.

cockpit
https_only: True
Finalising changes:#

run: vlab update_one service=cockpit

AUTH#

Default: False
Options: True/False

Command:#

vlab set cockpit.auth True

File alteration:#

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

eg.

cockpit
auth: True
Finalising changes:#

run: vlab update_one service=cockpit

DOMAIN#

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

Command:#

vlab set cockpit.domain cockpit.com

File alteration:#

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

eg.

cockpit
domain: cockpit.com
Finalising changes:#

run: vlab update_one service=cockpit

SUBDOMAIN#

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

Command:#

vlab set cockpit.subdomain media

File alteration:#

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

eg.

cockpit
subdomain: media
Finalising changes:#

run: vlab update_one service=cockpit

VERSION#

Default: None NOTE: Ensure that the version exists

Command:#

vlab set cockpit.version 2.7

File alteration:#

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

eg.

cockpit
version: 2.7
Finalising changes:#

run: vlab update_one service=cockpit

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.