algernon/writefreely

writefreely-docker

. .

这是一个Docker镜像，用于https://github.com/writeas/writefreely，其设置方式使其更易于在生产环境中部署，包括初始设置步骤。

概述

该镜像设置为使用SQLite作为数据库，默认不支持MySQL——但您始终可以提供自己的config.ini。配置文件、数据库和生成的密钥都存储在镜像使用的单个卷中，挂载在/data。

该镜像的主要目的是提供单步设置和升级体验，初始设置和任何升级均由镜像本身处理。因此，除非已存在配置文件，否则镜像将创建默认的config.ini，并带有合理的默认值。它还将运行数据库迁移，并在迁移前保存备份（如果不需要迁移，将删除备份）。

重要变更！

自2023年起，镜像以writefreely用户（uid 5000）运行，而非root。现有安装可能需要调整权限以适应此变更。

快速开始

要开始使用，最简单的测试方法是运行以下命令：

shell
docker run -p 8080:8080 -it --rm -v /some/path/to/data:/data \
       algernon/writefreely

然后将浏览器指向http://localhost:8080，您应该能看到WriteFreely已启动并运行。

设置

除非提供的卷已包含config.ini，否则镜像将执行初始设置。可以通过环境变量调整设置，下面列出了相关环境变量。请注意，目前这些环境变量仅在初始设置时使用！如果配置文件已存在，环境变量将被忽略。

环境变量

• WRITEFREELY_BIND_HOST和WRITEFREELY_BIND_PORT决定WriteFreely绑定的主机和端口。默认分别为0.0.0.0和8080。
• WRITEFREELY_SITE_NAME是网站标题。默认值为“A Writefreely blog”。
• WRITEFREELY_SINGLE_USER、WRITEFREELY_OPEN_REGISTRATION、WRITEFREELY_MIN_USERNAME_LEN、WRITEFREELY_MAX_BLOG、WRITEFREELY_FEDERATION、WRITEFREELY_PUBLIC_STATS、WRITEFREELY_PRIVATE、WRITEFREELY_LOCAL_TIMELINE和WRITEFREELY_USER_INVITES均对应config.ini中名称相似的设置。有关它们的更多信息，请参见WriteFreely文档。
• WRITEFREELY_ADMIN_USER和WRITEFREELY_ADMIN_PASSWORD将用于自动创建管理员用户（如果指定）。如果任一缺失，将不会创建管理员用户。

构建参数

• WRITEFREELY_UID设置构建期间创建的writefreely用户（和组）的默认ID。默认值为5000，仅在构建期间使用。
• WRITEFREELY_VERSION控制镜像构建所基于的Writefreely版本。默认值为v0.15.1，可以是任何标签或分支。
• WRITEFREELY_FORK设置要使用的分支（如果有）。默认值为writefreely/writefreely，目前必须是GitHub仓库。
• WRITEFREELY_REF（如果设置）指定克隆后检出的引用。目的是补充WRITEFREELY_VERSION，如果需要克隆非标签、非分支版本的Writefreely。默认值为空字符串。