TiddlyWiki#

TiddlyWiki a unique non-linear notebook for capturing, organizing and sharing complex information

amd64
arm64
armv7

Information#

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

SETUP#

Enabling tiddlywiki#

Command:#

vlab set tiddlywiki.enable True

File alteration:#

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

eg.

tiddlywiki
enable: True

Finalising changes:#

run: vlab update_one service=tiddlywiki

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

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set tiddlywiki.https_only True

File alteration:#

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

eg.

tiddlywiki
https_only: True
Finalising changes:#

run: vlab update_one service=tiddlywiki

AUTH#

Default: False
Options: True/False

Command:#

vlab set tiddlywiki.auth True

File alteration:#

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

eg.

tiddlywiki
auth: True
Finalising changes:#

run: vlab update_one service=tiddlywiki

DOMAIN#

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

Command:#

vlab set tiddlywiki.domain tiddlywiki.com

File alteration:#

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

eg.

tiddlywiki
domain: tiddlywiki.com
Finalising changes:#

run: vlab update_one service=tiddlywiki

SUBDOMAIN#

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

Command:#

vlab set tiddlywiki.subdomain media

File alteration:#

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

eg.

tiddlywiki
subdomain: media
Finalising changes:#

run: vlab update_one service=tiddlywiki

VERSION#

Default: latest
NOTE: Ensure that the version exists

Command:#

vlab set tiddlywiki.version 2.7

File alteration:#

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

eg.

tiddlywiki
version: 2.7
Finalising changes:#

run: vlab update_one service=tiddlywiki

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.