Vivumlab Docs#

Docusaurus v2 VivumLab Docs

amd64
arm64
armv7

Information#

Docker Image: vivumlab/docusaurus
Current Image Version: 1.0.4

SETUP#

Enabling docs#

Command:#

vlab set docs.enable True

File alteration:#

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

eg.

docs
enable: True

Finalising changes:#

run: vlab update_one service=docs

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 !!!

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

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set docs.https_only True

File alteration:#

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

eg.

docs
https_only: True
Finalising changes:#

run: vlab update_one service=docs

AUTH#

Default: False
Options: True/False

Command:#

vlab set docs.auth True

File alteration:#

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

eg.

docs
auth: True
Finalising changes:#

run: vlab update_one service=docs

DOMAIN#

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

Command:#

vlab set docs.domain docs.com

File alteration:#

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

eg.

docs
domain: docs.com
Finalising changes:#

run: vlab update_one service=docs

SUBDOMAIN#

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

Command:#

vlab set docs.subdomain media

File alteration:#

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

eg.

docs
subdomain: media
Finalising changes:#

run: vlab update_one service=docs

VERSION#

Default: 1.0.4
NOTE: Ensure that the version exists

Command:#

vlab set docs.version 2.7

File alteration:#

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

eg.

docs
version: 2.7
Finalising changes:#

run: vlab update_one service=docs

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.