This is an unofficial Docker image for running TiddlyWiki 5, a non-linear personal web notebook. The image is built on top of the Node.js runtime and includes the TiddlyWiki server as a dependency.
To use this Docker image, run the following command:
docker run -p 8080:8080 ghcr.io/henry40408/tiddlywiki5:latest
This will start a TiddlyWiki server on port 8080, which you can access by navigating to http://localhost:8080 in your web browser.
You can also mount a volume to persist your TiddlyWiki data, like so:
docker run -p 8080:8080 -v $PWD/wiki:/var/lib/tiddlywiki ghcr.io/henry40408/tiddlywiki5:latestThis will mount the directory $PWD/wiki on your local machine to the /var/lib/tiddlywiki directory inside the Docker container, allowing you to persist your TiddlyWiki data between container runs.
The following environment variables are supported in the Dockerfile:
| Variable | Description | Default Value |
|---|---|---|
USERNAME |
The username to use for TiddlyWiki login. | null |
PASSWORD |
The password to use for TiddlyWiki login. | null |
ANON_USERNAME |
The username to use for anonymous access to TiddlyWiki. | null |
EXTRA_PARAMS |
Additional parameters to pass to the tiddlywiki command. | null |
Please note that the Docker image tagged with latest is a stable release of TiddlyWiki5, which is updated when a new release is created on GitHub. However, Docker images tagged with nightly are built from the latest development code and may not be stable. Use them at your own risk.
I would like to extend my heartfelt gratitude to Jeremy Ruston, the maintainer of TiddlyWiki. I use TiddlyWiki every day and find it remarkably stable and invaluable in enhancing my productivity. Jeremy’s dedication to maintaining this remarkable piece of software is truly commendable, and I am truly grateful for his ongoing efforts and commitment.
This Docker image I am maintaining is unofficial and has been adapted to run on my Raspberry Pi 4 (arm64). It’s my hope that I can continue to maintain this Docker image with the same level of dedication and longevity as Jeremy has maintained TiddlyWiki.
Lastly, I encourage everyone who loves and benefits from the original TiddlyWiki project to consider supporting it financially. If you find value in what Jeremy and the TiddlyWiki community are creating and wish to see it thrive and evolve, please consider donating via the project's Open Collective.
Thank you to everyone involved in the TiddlyWiki project and the broader community for making such impactful contributions to open-source software.
This Docker image is distributed under the MIT License. See the LICENSE file for more details.