photonix

环境要求

• 已安装 Docker 与 Docker Compose（README 给出 Compose 安装文档链接）
• 有一个可用于访问 http://localhost:8888/ 的浏览器
• 准备一个用来创建超级用户的用户名和邮箱
• 本机有足够磁盘空间存放照片数据目录

安装与启动步骤

1. 1创建运行目录

   新建 photonix 目录并进入，作为整套服务的运行位置，后续数据都放在这里。

   mkdir photonix
   cd photonix

   复制

2. 2下载 Compose 文件

   从官方仓库拉取示例 docker-compose 文件并重命名为 docker-compose.yml，不要手动改名其他内容。

   curl https://raw.githubusercontent.com/photonixapp/photonix/master/docker/docker-compose.example.yml > docker-compose.yml

   复制

3. 3创建照片目录

   创建容器外的数据卷目录，照片放在这里可被自动检测导入。

   mkdir -p  data/photos

   复制

4. 4启动服务

   该命令会自动拉取并运行所需 Docker 镜像，首次执行耗时较长，请等待镜像下载完成。

   docker-compose up

   复制

5. 5创建管理员账号

   另开一个终端窗口执行，把 USERNAME 替换成你自己的用户名，按提示设置密码。

   docker-compose run photonix python photonix/manage.py createsuperuser --username USERNAME --email example@example.com

   复制

6. 6创建照片库

   同样替换 USERNAME，库名可自定义，例如 My Library，创建后即可开始导入照片。

   docker-compose run photonix python photonix/manage.py create_library USERNAME "My Library"

   复制

7. 7导入照片

   把照片复制到 data/photos 目录，系统会自动检测并立即导入；之后可在 compose 文件里改挂载路径。

8. 8开发模式(可选)

   仅在参与开发时使用，会构建镜像、挂载代码并支持热重载；需先克隆仓库再执行 make。

   git clone git@github.com:photonixapp/photonix.git
   cd photonix
   mkdir -p  data/photos
   make build
   make start

   复制

关键配置

如何确认成功

启动几秒后浏览器打开 http://localhost:8888/ 能正常进入界面，即表示服务运行成功。

常见问题

注意事项

• 项目仍处于开发中，尚未达到 1.0 完整功能，可能存在不可用部分。
• README 明确说明用户需自行负责备份，出现错误时官方不代为恢复。
• 创建用户与照片库目前必须通过命令行完成，暂无网页端注册流程。
• 示例 Compose 文件来自官方仓库 docker/docker-compose.example.yml，请勿随意改动内容以免启动失败。