nicolaw/tiddlywiki

tiddlywiki

TiddlyWiki 5 Docker镜像，用于便捷部署和运行个人维基系统。

支持的标签

• 5.3.6、5.3.6-node20.18-alpine3.19、latest
• 5.2.2、5.2.2-node17.9-alpine3.15
• 5.2.0、5.2.0-node17.0-alpine3.13
• 5.1.23、5.1.23-node14.18.1-alpine3.14
• 5.1.22、5.1.22-node14.9.0-alpine3.12

镜像支持以下架构：amd64、arm/v6、arm/v7、arm64、ppc64le、s390x。

环境要求

1. 安装Docker。参考Docker官方安装文档获取帮助。对于希望快速安装且不特别关注安全性的Linux用户，可直接运行以下命令： curl -fsSL get.docker.com | sudo bash

2. 如需实现TiddlyWiki开机自启，需运行支持systemd的较新Linux发行版（例如Ubuntu 12或更早版本默认不支持systemd）。

手动执行

console
$ docker run -p 8080:8080 --name mywiki nicolaw/tiddlywiki

打开浏览器访问 http://localhost:8080 即可使用TiddlyWiki。

如需让容器持续运行直至显式停止（使用docker stop或docker kill命令），可执行以下命令（持久化存储数据）：

console
$ mkdir ~/tiddlywiki
$ docker run \
    -p 8080:8080 -d --restart unless-stopped --name mywiki \
    -v ~/tiddlywiki:/var/lib/tiddlywiki \
    nicolaw/tiddlywiki

Systemd服务配置

项目源码仓库中提供了systemd服务单元文件（参见：[***]

console
$ sudo mkdir /etc/tiddlywiki/
$ sudo cp tiddlywiki.service /etc/systemd/system/mywiki.service
$ sudo cp tiddlywiki.conf /etc/tiddlywiki/mywiki.conf
$ sudo systemctl daemon-reload
$ sudo systemctl start mywiki.service

查看TiddlyWiki服务状态或监控日志：

console
$ sudo systemctl status mywiki.service
$ sudo journalctl -f -u mywiki.service

数据存储

容器将Tiddler数据存储在/var/lib/tiddlywiki目录，默认使用***Docker卷。通过指定卷挂载路径，可将数据持久化到本地文件系统：

console
$ docker run --rm -p 8080:8080 -v ~/wikidata:/var/lib/tiddlywiki --name mywiki nicolaw/tiddlywiki

使用systemd服务时，Docker卷名称与服务名称相同（默认mywiki.service）。如需查看数据存储路径，可执行：docker volume inspect mywiki.service。如需自定义挂载路径，可修改/etc/tiddlywiki/mywiki.conf中的TW_DOCKERVOLUME（及可选的TW_DOCKERUID、TW_DOCKERGID）配置，并重启服务：

console
$ sudo vi /etc/tiddlywiki/mywiki.conf
$ sudo systemctl restart mywiki.service

身份验证

默认用户名为anonymous，无密码。可通过环境变量TW_USERNAME和TW_PASSWORD启用密码验证：

console
$ docker run -p 8080:8080 -e "TW_USERNAME=$USER" -e "TW_PASSWORD=hunter2" --name mywiki nicolaw/tiddlywiki

使用systemd服务时，修改/etc/tiddlywiki/mywiki.conf中的TW_USERNAME和TW_PASSWORD配置并重启服务：

console
$ sudo vi /etc/tiddlywiki/mywiki.conf
$ sudo systemctl restart mywiki.service

可配置变量

更多配置说明参见官方文档：

• [***]
• [***]

ini
TW_WIKINAME=mywiki          # 维基名称
TW_USERNAME=janedoe         # 用户名
TW_PASSWORD=                # 密码（留空表示无需密码）
TW_PORT=8080                # 服务端口
TW_ROOTTIDDLER=$:/core/save/all  # 根Tiddler
TW_RENDERTYPE=text/plain    # 渲染类型
TW_SERVETYPE=text/html      # 服务类型
TW_HOST=0.0.0.0             # 绑定地址
TW_PATHPREFIX=              # 路径前缀

以下变量用于调整NodeJS运行参数（适用于低内存环境）：

ini
NODE_MEM=400                # NodeJS最大内存限制（MB）
NODE_OPTIONS=               # 其他NodeJS选项

仅在使用systemd服务时生效的变量（独立运行容器时无效）：

ini
TW_DOCKERVOLUME=/home/janedoe/tiddlywiki  # 数据挂载路径
TW_DOCKERUID=0              # 运行用户UID
TW_DOCKERGID=0              # 运行用户GID

Docker Compose配置

高级用户可通过docker-compose基于Git源码仓库构建自定义镜像，控制以下Dockerfile构建参数：

• TW_VERSION - 从NPM安装的TiddlyWiki上游版本（[***]
• BASE_IMAGE - 基础镜像（需包含node解释器）
• USER - 运行TiddlyWiki进程的Unix用户或UID

项目Makefile（[***]

示例docker-compose配置片段：

yaml
tiddlywiki:
  container_name: tiddlywiki
  image: nicolaw/tiddlywiki
  build:
    context: https://gitlab.com/nicolaw/tiddlywiki.git
    args:
      TW_VERSION: 5.2.2
      USER: 501
      BASE_IMAGE: 17.9-alpine3.15

使用项目提供的docker-compose.yaml（[***]

console
$ docker-compose up -d
Starting tiddlywiki ... done

Packer AWS AMI构建

项目提供Packer HCL定义（[***] EC2 AMI：

console
$ packer init .
$ packer build .

公共AWS AMI可通过所有者账号ID172306058616在eu-west-2（伦敦）区域获取：

console
$ aws ec2 describe-images \
  --region eu-west-2 --owners 172306058616 \
  --filters 'Name=name,Values=tiddlywiki-*' 'Name=architecture,Values=x86_64' \
  --query 'sort_by(Images, &CreationDate)[-1].ImageId' --output text
ami-00e143acd635f8693

该AMI默认监听80端口，数据存储在/home/ec2-user/tiddlywiki。修改/etc/tiddlywiki/tiddlywiki.conf配置后，通过以下命令重启服务：

console
$ systemctl restart tiddlywiki.service

作者

Nicola Worthington <>
网站：[]
项目地址：[***]

许可证

MIT许可证

版权所有 (c) 2018-2022 Nicola Worthington

特此授予获得本软件及相关文档文件（以下简称“软件”）副本的任何人免费使用软件的权利，包括但不限于使用、复制、修改、合并、出版、分发、再许可和/或销售软件副本的权利，并允许向其提供软件的人这样做，但须符合以下条件：

上述版权声明和本许可声明应包含在软件的所有副本或主要部分中。

本软件按“原样”提供，不提供任何明示或暗示的担保，包括但不限于对适销性、特定用途适用性和非侵权性的担保。在任何情况下，作者或版权持有人均不对因软件或软件的使用或其他交易而产生的任何索赔、损害或其他责任承担责任，无论是合同诉讼、侵权诉讼还是其他诉讼。<|FCResponseEnd|>===SHORT_DESC=== 基于NodeJS的TiddlyWiki 5 Docker镜像，提供便捷的个人维基部署方案，支持多架构和持久化存储，可通过Docker快速启动并配置访问权限。 ===FULL_DESC===

tiddlywiki

TiddlyWiki 5 Docker镜像，用于快速部署功能丰富的个人维基系统，支持跨平台架构和灵活的配置选项。

支持的标签

• 5.3.6、5.3.6-node20.18-alpine3.19、latest
• 5.2.2、5.2.2-node17.9-alpine3.15
• 5.2.0、5.2.0-node17.0-alpine3.13
• 5.1.23、5.1.23-node14.18.1-alpine3.14
• 5.1.22、5.1.22-node14.9.0-alpine3.12

镜像支持架构：amd64、arm/v6、arm/v7、arm64、ppc64le、s390x。

环境要求

1. 安装Docker：参考Docker官方安装文档。Linux用户可快速安装：

   console
   curl -fsSL get.docker.com | sudo bash
   

2. 开机自启要求：需运行支持systemd的Linux发行版（如Ubuntu 12及更早版本默认不支持）。

手动执行

临时运行

console
$ docker run -p 8080:8080 --name mywiki nicolaw/tiddlywiki

通过浏览器访问 http://localhost:8080 即可使用。

持久化运行

如需容器持续运行并保留数据：

console
$ mkdir ~/tiddlywiki
$ docker run \
    -p 8080:8080 -d --restart unless-stopped --name mywiki \
    -v ~/tiddlywiki:/var/lib/tiddlywiki \
    nicolaw/tiddlywiki

Systemd服务配置

通过systemd实现开机自启，支持多实例管理和配置自定义。

安装服务

console
$ sudo mkdir /etc/tiddlywiki/
$ sudo cp tiddlywiki.service /etc/systemd/system/mywiki.service
$ sudo cp tiddlywiki.conf /etc/tiddlywiki/mywiki.conf
$ sudo systemctl daemon-reload
$ sudo systemctl start mywiki.service

服务管理

console
# 查看状态
$ sudo systemctl status mywiki.service
# 查看日志
$ sudo journalctl -f -u mywiki.service

数据存储

默认存储

数据默认存储于容器内/var/lib/tiddlywiki，使用***Docker卷。

持久化配置

通过卷挂载将数据保存至本地：

console
$ docker run --rm -p 8080:8080 -v ~/wikidata:/var/lib/tiddlywiki --name mywiki nicolaw/tiddlywiki

Systemd环境下的数据管理

systemd服务使用与服务名同名的Docker卷（如mywiki.service），查看路径：

console
$ docker volume inspect mywiki.service

修改配置文件/etc/tiddlywiki/mywiki.conf中的TW_DOCKERVOLUME可自定义挂载路径。

身份验证

基本认证配置

通过环境变量设置用户名密码：

console
$ docker run -p 8080:8080 -e "TW_USERNAME=$USER" -e "TW_PASSWORD=your_password" --name mywiki nicolaw/tiddlywiki

Systemd环境配置

编辑配置文件启用认证：

console
$ sudo vi /etc/tiddlywiki/mywiki.conf
# 取消注释并修改 TW_USERNAME 和 TW_PASSWORD
$ sudo systemctl restart mywiki.service

可配置变量

核心运行参数

ini
TW_WIKINAME=mywiki               # 维基名称
TW_USERNAME=anonymous            # 访问用户名
TW_PASSWORD=                     # 访问密码（留空禁用认证）
TW_PORT=8080                     # 服务端口
TW_ROOTTIDDLER=$:/core/save/all  # 根Tiddler路径
TW_RENDERTYPE=text/plain         # 渲染类型
TW_SERVETYPE=text/html           # 服务响应类型
TW_HOST=0.0.0.0                  # 绑定地址
TW_PATHPREFIX=                   # URL路径前缀

资源限制

ini
NODE_MEM=400                     # NodeJS内存限制（MB，低内存环境适用）
NODE_OPTIONS=                    # 额外NodeJS参数

Systemd专用参数

ini
TW_DOCKERVOLUME=/path/to/data    # 数据挂载路径
TW_DOCKERUID=0                   # 运行用户UID
TW_DOCKERGID=0                   # 运行用户GID

Docker Compose配置

支持通过docker-compose构建自定义镜像，控制构建参数：

• TW_VERSION：TiddlyWiki版本（NPM源）
• BASE_IMAGE：基础镜像（需含NodeJS）
• USER：运行用户/UID

示例配置

yaml
tiddlywiki:
  container_name: tiddlywiki
  image: nicolaw/tiddlywiki
  build:
    context: https://gitlab.com/nicolaw/tiddlywiki.git
    args:
      TW_VERSION: 5.2.2
      USER: 501
      BASE_IMAGE: 17.9-alpine3.15

启动服务

console
$ docker-compose up -d

Packer AWS AMI构建

提供Packer配置用于构建AWS EC2 AMI，支持快速部署云实例。

构建命令

console
$ packer init .
$ packer build .

公共AMI

可通过所有者账号172306058616在eu-west-2区域获取公共AMI：

console
$ aws ec2 describe-images \
  --region eu-west-2 --owners 172306058616 \
  --filters 'Name=name,Values=tiddlywiki-*' 'Name=architecture,Values=x86_64' \
  --query 'sort_by(Images, &CreationDate)[-1].ImageId' --output text

作者

Nicola Worthington <>
项目主页：[]
代码仓库：[***]

许可证

MIT许可证

版权所有 (c) 2018-2022 Nicola Worthington

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.