NodeJS based TiddlyWiki 5 Docker image.
Find a file
Brett O'Donnell 93b30fcea0
allow extra options via environment variables
For example, when using https://github.com/OokTech/TW5-Bob you need the option `--wsserver`.  This will allow you to do `EXTRAOPTIONS=--wsserver`.
2023-01-14 15:42:21 +10:30
.github/workflows ci(docker): setup qemu 2021-11-26 21:13:44 +03:00
Dockerfile chore(Dockerfile): Remove unnecessary expose 2022-07-16 15:16:16 +08:00
init-and-run-wiki allow extra options via environment variables 2023-01-14 15:42:21 +10:30
LICENSE add license (GPLv3) 2021-11-26 19:45:48 +03:00
README.md feat(init-and-run-wiki): Support path-prefix listen parameter 2022-07-16 16:15:03 +08:00

TiddliWiki 5 Docker image

Run TiddlyWiki 5 via Docker.

Forked from djmaze/tiddlywiki-docker.

The Docker image is available at m0wer/tiddlywiki - Docker Hub.

Available Docker Images at DockerHub

Image Name Tag TiddyWiki Version
m0wer/tiddlywiki latest 5.2.0
m0wer/tiddlywiki v[X] [X]
m0wer/tiddlywiki test ?

Prerequisites

  • Docker.

Quickstart

docker run -d -p 8080:8080 m0wer/tiddlywiki

Now TiddlyWiki should be running on http://localhost:8080.

Keeping the data

The container uses a Docker volume to save the wiki data. In order not to lose sight of that, I recommend using a local directory for the volume.

docker run -d -p 8080:8080 -v $(pwd)/.tiddlywiki:/var/lib/tiddlywiki m0wer/tiddlywiki

In this example, the folder $(pwd)/.tiddlywiki is used for the data.

Authentication

Authentication is disabled by default. To enable it, simply provide the USERNAME and PASSWORD environment variables.

Other settings

Limit Node.js memory

If you are in a memory-constrained environment, you can provide the NODE_MEM environment variable to specify the memory ceiling (in MB)

Debug

Set the DEBUG_LEVEL environment variable to debug. For example by passing -e DEBUG_LEVEL=debug option in docker run.

Path prefix

Set the PATH_PREFIX environment variable to customize the path prefix for serving TiddlyWiki. For example by passing -e PATH_PREFIX=\wiki option in docker run. According to this note, please remember to configure the client as well.