hedgedoc#

hedgedoc The best platform to write and share markdown

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: 1.7.1-alpine

SETUP#

Enabling hedgedoc#

Command:#

vlab set hedgedoc.enable True

File alteration:#

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

eg.

hedgedoc enable: True

Finalising changes:#

run: vlab update_one service=hedgedoc

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

ACCESS#

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

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set hedgedoc.https_only True

File alteration:#

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

eg.

hedgedoc
https_only: True
Finalising changes:#

run: vlab update_one service=hedgedoc

AUTH#

Default: False
Options: True/False

Command:#

vlab set hedgedoc.auth True

File alteration:#

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

eg.

hedgedoc
auth: True
Finalising changes:#

run: vlab update_one service=hedgedoc

DOMAIN#

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

Command:#

vlab set hedgedoc.domain hedgedoc.com

File alteration:#

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

eg.

hedgedoc
domain: hedgedoc.com
Finalising changes:#

run: vlab update_one service=hedgedoc

SUBDOMAIN#

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

Command:#

vlab set hedgedoc.subdomain media

File alteration:#

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

eg.

hedgedoc
subdomain: media
Finalising changes:#

run: vlab update_one service=hedgedoc

VERSION#

Default: 1.7.1-alpine
NOTE: Ensure that the version exists

Command:#

vlab set hedgedoc.version 2.7

File alteration:#

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

eg.

hedgedoc
version: 2.7
Finalising changes:#

run: vlab update_one service=hedgedoc

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.