https://github.com/djmaze/tiddlywiki-docker

Run TIddlyWiki 5 via Docker
https://github.com/djmaze/tiddlywiki-docker

Last synced: 27 days ago
JSON representation

Run TIddlyWiki 5 via Docker

• Host: GitHub
• URL: https://github.com/djmaze/tiddlywiki-docker
• Owner: djmaze
• License: mit
• Created: 2014-05-18T22:30:07.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2021-11-26T18:02:07.000Z (about 3 years ago)
• Last Synced: 2024-12-08T20:41:32.960Z (about 1 month ago)
• Language: Shell
• Size: 14.6 KB
• Stars: 113
• Watchers: 8
• Forks: 83
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
*:warning: This repository is not maintained anymore. You might want to have a look at [m0wer's fork](https://github.com/m0wer/tiddlywiki-docker).*

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](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](https://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with%2520the%2520client-server%2520edition.html) 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.