moritzf/fiduswriter

docker-fiduswriter

https://github.com/fiduswriter/fiduswriter 是一款协作在线写作工具。本Docker镜像严格遵循Ubuntu官方安装手册构建。

DockerHub上的构建与标签

Docker上的构建标签遵循以下模式，通过项目https://github.com/moritzfl/docker-fiduswriter%E7%9A%84%E5%8F%98%E6%9B%B4%E8%87%AA%E5%8A%A8%E8%A7%A6%E5%8F%91%EF%BC%88%22develop%22%E7%94%B1%E6%8F%90%E4%BA%A4%E8%A7%A6%E5%8F%91%EF%BC%8C%E5%85%B6%E4%BB%96%E9%80%9A%E8%BF%87%E5%8F%91%E5%B8%83%E8%A7%A6%E5%8F%91%EF%BC%89%EF%BC%9A

• latest：FidusWriter的最新发布版或预发布版（对应最新的"release-[版本号]"或"prerelease-[版本号]"）
• latest-stable：FidusWriter的最新稳定发布版（对应最新的"release-[版本号]"）
• release-[版本号]：FidusWriter的稳定发布版（与FidusWriter仓库的"release"版本一致）
• prerelease-[版本号]：FidusWriter的潜在不稳定预发布版（与FidusWriter仓库的"prerelease"版本一致）
• develop：每次提交后的开发构建版

如何使用该镜像

若需允许从localhost以外的URL访问，需修改/data/configuration.py中的ALLOWED_HOSTS配置项。建议将数据目录映射到主机目录，以实现数据持久化和便捷配置（遵循以下步骤）。

在配置邮件服务器前（同样通过/data/configuration.py），用户注册所需的邮件及链接会输出到容器的日志流中。

为持久化数据，需确保主机映射目录对执行用户（fiduswriter，UID/GID为999）有写权限，可通过以下命令实现：

$ sudo chown -R 999:999 /host/directory

（将/host/directory替换为主机上的有效目录）

运行FidusWriter（可省略-v /host/directory:/data，但会失去数据持久化）：

$ docker run -d -v /host/directory:/data -p 8000:8000 --name moritzf-fiduswriter moritzf/fiduswriter:latest

（将/host/directory替换为主机上的有效目录）

若需创建管理员账户，可附加容器到终端并执行以下命令：

$ python3 manage.py createsuperuser

如何通过Docker Compose使用

本仓库包含docker-compose.yaml文件，描述了使用PostgreSQL数据库的类生产环境。可通过以下命令获取依赖并生成Fidus Writer镜像：

docker-compose pull
docker-compose build

这会将所有构建时依赖安装到镜像中。需配置以下文件以适应容器：

mkdir -p /data
cp env/fiduswriter.env.example env/fiduswriter.env
cp env/postgres.env.example env/postgres.env
cp env/configuration.py.example data/configuration.py

最终只需调整*.env文件即可。configuration.py文件与默认配置的区别在于它从上述文件的环境变量中读取配置，若设置不明确可参考应用文档。

然后启动应用：

docker-compose up -d

首次运行后需做最后调整：注册邮件默认从example.com发送，需修改站点配置。

首先创建超级用户：

docker-compose exec app fiduswriter createsuperuser

然后登录/admin修改站点配置。fiduswriter setup期间创建的默认Django站点名为example.com，django-allauth会用它发送邮件。需将其改为生产环境值。

该配置可在/admin/sites/site/（仅超级用户可访问）中修改：将域名改为实例可访问的地址，显示名称改为所需名称。至此Fidus Writer部署完成。

如有疑问，请在项目issues中留言。