{"id":14069732,"url":"https://github.com/m0wer/tiddlywiki-docker","last_synced_at":"2025-07-30T06:32:36.164Z","repository":{"id":45933676,"uuid":"290742194","full_name":"m0wer/tiddlywiki-docker","owner":"m0wer","description":"NodeJS based TiddlyWiki 5 Docker image.","archived":false,"fork":true,"pushed_at":"2023-04-16T18:50:40.000Z","size":61,"stargazers_count":48,"open_issues_count":2,"forks_count":28,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-13T07:16:07.190Z","etag":null,"topics":["docker","knowledge-management","tiddlywiki","tiddlywiki5","wiki","zettelkasten"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/m0wer/tiddlywiki","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"djmaze/tiddlywiki-docker","license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m0wer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-08-27T10:09:58.000Z","updated_at":"2024-06-21T23:45:34.000Z","dependencies_parsed_at":"2023-02-10T21:15:42.170Z","dependency_job_id":null,"html_url":"https://github.com/m0wer/tiddlywiki-docker","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m0wer%2Ftiddlywiki-docker","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m0wer%2Ftiddlywiki-docker/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m0wer%2Ftiddlywiki-docker/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m0wer%2Ftiddlywiki-docker/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m0wer","download_url":"https://codeload.github.com/m0wer/tiddlywiki-docker/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":228102176,"owners_count":17869790,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker","knowledge-management","tiddlywiki","tiddlywiki5","wiki","zettelkasten"],"created_at":"2024-08-13T07:07:10.665Z","updated_at":"2024-12-04T11:30:41.825Z","avatar_url":"https://github.com/m0wer.png","language":"Shell","funding_links":[],"categories":["Shell"],"sub_categories":[],"readme":"# TiddliWiki 5 Docker image\n\nRun TiddlyWiki 5 via Docker.\n\nForked from\n[djmaze/tiddlywiki-docker](https://github.com/djmaze/tiddlywiki-docker).\n\nThe Docker image is available at [m0wer/tiddlywiki - Docker\nHub](https://hub.docker.com/r/m0wer/tiddlywiki).\n\n## Available Docker Images at DockerHub\n\nImage Name       | Tag        | TiddyWiki Version\n-----------------|------------|------------------\nm0wer/tiddlywiki | latest     | 5.2.7\nm0wer/tiddlywiki | v[X]       | [X]\nm0wer/tiddlywiki | test       | ?\n\n## Prerequisites\n\n* Docker.\n\n## Quickstart\n\n```bash\ndocker run -d -p 8080:8080 m0wer/tiddlywiki\n```\n\nNow TiddlyWiki should be running on\n[http://localhost:8080](http://localhost:8080).\n\n## Keeping the data\n\nThe container uses a Docker volume to save the wiki data. In order not\nto lose sight of that, I recommend using a local directory for the volume.\n\n```bash\ndocker run -d -p 8080:8080 -v $(pwd)/.tiddlywiki:/var/lib/tiddlywiki m0wer/tiddlywiki\n```\n\nIn this example, the folder `$(pwd)/.tiddlywiki` is used for the data.\n\n## Authentication\n\nAuthentication is disabled by default. To enable it, simply provide the\n`USERNAME` and `PASSWORD` environment variables.\n\n## Other settings\n\n### Limit Node.js memory\n\nIf you are in a memory-constrained environment, you can provide the\n`NODE_MEM` environment variable to specify the memory ceiling (in MB)\n\n### Debug\n\nSet the `DEBUG_LEVEL` environment variable to `debug`. For example by passing\n`-e DEBUG_LEVEL=debug` option in `docker run`.\n\n### Path prefix\n\nSet the `PATH_PREFIX` environment variable to customize the path prefix for\nserving TiddlyWiki. For example by passing `-e PATH_PREFIX=\\wiki` option in\n`docker run`. According to this [note][path-prefix-note], please remember to\nconfigure the client as well.\n\n[path-prefix-note]: https://tiddlywiki.com/static/Using%2520a%2520custom%2520path%2520prefix%2520with%2520the%2520client-server%2520edition.html\n\n## Docker Compose\n\nTo keep all the docker settings, environment variables and volume data in a folder you can use `docker compose`.\n\nCreate a folder for the project:\n\n```\nmkdir my-tiddlywiki-docker\ncd my-tiddlywiki-docker\n```\n\nCreate a folder for the data:\n\n```\nmkdir tiddlywiki\n```\n\nCreate `docker-compose.yml` with the following contents:\n\n```\nversion: '3'\nservices:\n  tiddlywiki:\n    image: m0wer/tiddlywiki\n    volumes:\n      - ./tiddlywiki:/var/lib/tiddlywiki\n    restart: unless-stopped\n    ports:\n      - 8080:8080\n    #environment:\n    #  - DEBUG_LEVEL=debug\n    #  - PATH_PREFIX=\\wiki\n    #  - NODE_MEM=128\n    #  - USERNAME=test\n    #  - PASSWORD=test\n```\n\nThen run `docker compose up -d`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm0wer%2Ftiddlywiki-docker","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm0wer%2Ftiddlywiki-docker","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm0wer%2Ftiddlywiki-docker/lists"}