elasticdog/tiddlywiki

TiddlyWiki Docker镜像文档

镜像概述和主要用途

TiddlyWiki 是一款自包含的JavaScript wiki，作为非线性笔记本用于捕捉、组织和分享复杂信息。本Docker镜像用于将TiddlyWiki以Node.js应用模式运行，相比单文件版本，该模式显著改进了同步和保存功能。

核心功能和特性

• 自包含架构：基于JavaScript构建，无需外部数据库，独立运行
• Node.js运行模式：提供更可靠的同步机制和文件保存功能
• CLI兼容性：完整支持tidlywiki命令行工具的所有功能
• 数据持久化：预定义/tiddlywiki数据卷，支持通过卷或绑定挂载实现数据持久化
• 网络可访问：暴露8080端口，支持通过HTTP服务器接口访问wiki
• 权限控制：支持通过--user参数控制文件所有权，避免权限冲突

支持的标签及Dockerfile链接

• https://github.com/elasticdog/tiddlywiki-docker/blob/master/5/Dockerfile
• https://github.com/elasticdog/tiddlywiki-docker/blob/3e4df0f8a33db4fac6724ada969705c1622a5af0/5/Dockerfile
• https://github.com/elasticdog/tiddlywiki-docker/blob/5368ab2480dd98dfdbd611e6344e2d6e3c389369/5/Dockerfile
• https://github.com/elasticdog/tiddlywiki-docker/blob/a29642cab96186390b6866e45f56cd74807c39ba/5/Dockerfile
• https://github.com/elasticdog/tiddlywiki-docker/blob/2ead91df276b99724e795c96cdd59e26c367d8d9/5/Dockerfile
• https://github.com/elasticdog/tiddlywiki-docker/blob/fdac15a3a930365c98e3474492465e77e0148c55/5/Dockerfile

使用场景和适用范围

• 个人知识管理系统
• 项目文档协作平台
• 研究笔记和资料整理工具
• 小型团队内部知识库
• 需要本地运行且数据持久化的轻量级wiki应用

详细使用方法和配置说明

本镜像设计用于模拟tidlywiki CLI可执行程序的功能。以下是详细使用指南：

基本使用验证

可通过以下命令验证镜像功能并查看TiddlyWiki版本：

bash
docker run -it --rm elasticdog/tiddlywiki --version

使用注意事项

端口发布

Dockerfile默认暴露容器内8080端口。运行HTTP服务器时，必须将绑定地址指定为0.0.0.0（而非默认的127.0.0.1），否则主机无法访问容器内服务。

数据持久化

若需持久化wiki数据，需通过卷(volumes)或绑定挂载(bind mounts)将数据导出容器外。容器内预定义数据卷路径为/tiddlywiki（默认工作目录）。

权限管理

使用绑定挂载时，容器内进程会修改主机文件系统。建议通过--user参数指定用户ID和组ID，确保文件所有权正确。

部署示例

交互式运行示例

适用于需要手动执行CLI命令的场景，创建如下包装脚本（tiddlywiki-docker）：

bash
#!/usr/bin/env bash

docker run --interactive --tty --rm \
    --publish 127.0.0.1:8080:8080 \
    --mount "type=bind,source=${PWD},target=/tiddlywiki" \
    --user "$(id -u):$(id -g)" \
    elasticdog/tiddlywiki \
    "$@"

使用步骤：

1. 初始化包含服务器组件的新wiki：

   bash
   chmod +x tiddlywiki-docker
   ./tiddlywiki-docker mynewwiki --init server
   

   输出：Copied edition 'server' to mynewwiki

2. 启动TiddlyWiki服务器：

   bash
   ./tiddlywiki-docker mynewwiki --listen host=0.0.0.0
   

   输出：Serving on 0.0.0.0:8080（按Ctrl+C停止）

3. 通过浏览器访问http://localhost:8080编辑wiki

后台运行示例

适用于需要长期运行服务器的场景，创建如下包装脚本（tiddlywiki-serve）：

bash
#!/usr/bin/env bash

readonly WIKIFOLDER=$1

docker run --detach --rm \
    --name tiddlywiki \
    --publish 127.0.0.1:8080:8080 \
    --mount "type=bind,source=${PWD},target=/tiddlywiki" \
    --user "$(id -u):$(id -g)" \
    elasticdog/tiddlywiki \
    "$WIKIFOLDER" \
    --listen host=0.0.0.0

使用步骤：

1. 启动后台服务器：

   bash
   chmod +x tiddlywiki-serve
   ./tiddlywiki-serve mynewwiki
   

   输出容器ID（如9b76d1be260f9e19406cbdec9f5dd4d087ce87d81f345da4eb6d23723e928043）

2. 查看运行状态：

   bash
   docker ps --latest
   

3. 通过浏览器访问http://localhost:8080编辑wiki

4. 停止服务器：

   bash
   docker stop tiddlywiki
   

Docker Compose配置示例

创建docker-compose.yml文件实现更便捷的部署：

yaml
version: '3'

services:
  tiddlywiki:
    image: elasticdog/tiddlywiki:latest
    container_name: tiddlywiki
    restart: unless-stopped
    ports:
      - "127.0.0.1:8080:8080"
    volumes:
      - ./mynewwiki:/tiddlywiki/mynewwiki
    user: "${UID}:${GID}"
    command: mynewwiki --listen host=0.0.0.0

使用步骤：

1. 初始化wiki（首次运行）：

   bash
   UID=$(id -u) GID=$(id -g) docker-compose run --rm tiddlywiki mynewwiki --init server
   

2. 启动服务：

   bash
   UID=$(id -u) GID=$(id -g) docker-compose up -d
   

3. 停止服务：

   bash
   docker-compose down
   

注意：更复杂的示例脚本可参考https://github.com/elasticdog/tiddlywiki-docker/tree/master/contrib%E3%80%82

贡献指南

TiddlyWiki Docker项目欢迎社区贡献。贡献前请阅读https://github.com/elasticdog/tiddlywiki-docker/blob/master/CONTRIBUTING.md%E3%80%82

许可协议

tiddlywiki-docker采用MIT许可协议授权。

版权所有 © 2018–2021, Aaron Bull Schaefer。