⚠️ This repository is not maintained anymore. You might want to have a look at m0wer's fork.

Run TiddlyWiki 5 via docker.

Prerequisites

Install docker.

Quickstart

sudo docker run -d -p 8080:8080 mazzolino/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 folder for the volume.

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

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

Auth

Default auth is user / wiki

Simply provide the USERNAME and PASSWORD env variables to customise.

Other settings

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

To serve the tiddlywiki at a non-root prefix path set the SERVE_URI environment variable: this variable ''must'' start with a forward slash character. The tiddlywiki will be served by the container at http:///${SERVE_URI} - the container initialization script takes care of setting the required host configuration tiddler.