Docker-Cronicle部署与配置指南

Docker-Cronicle部署与配置指南

项目概述

Docker-Cronicle是基于Cronicle的一个Docker化实现，由soulteary维护，它提供了一个轻量级且美观的Web UI界面，用于管理计划任务（cronjobs）和调度任务。本指南旨在帮助用户了解并部署这个自托管的cron作业解决方案。

1. 项目目录结构及介绍

假设您已经克隆了仓库 https://github.com/soulteary/docker-cronicle.git，典型的项目结构可能看起来像这样：

docker-cronicle/
├── data            # 存放数据、日志和插件的目录，需手动创建或通过Docker卷映射
│   ├── data        # 应用数据存放处
│   ├── logs        # 运行时日志存放处
│   └── plugins     # 插件文件存放处
├── docker-compose.yml  # Docker Compose配置文件，简化部署
├── README.md       # 项目说明文档
└── ...             # 其他潜在的文档或脚本

• data: 此目录用于存放由Cronicle生成的数据、日志以及任何额外的插件。
• docker-compose.yml: 提供了一种便捷的方式来通过Docker Compose启动Cronicle服务。

2. 项目的启动文件介绍

Docker CLI方式

启动Cronicle最直接的方式是通过Docker CLI命令。例如，以下命令展示了如何手动部署Cronicle：

docker run \
    -v /etc/localtime:/etc/localtime:ro \
    -v /etc/timezone:/etc/timezone:ro \
    -v $(pwd)/data/data:/opt/cronicle/data:rw \
    -v $(pwd)/data/logs:/opt/cronicle/logs:rw \
    -v $(pwd)/data/plugins:/opt/cronicle/plugins:rw \
    -p 3012:3012 -d \
    --hostname cronicle \
    --name cronicle \
    soulteary/cronicle

这条命令执行后，Cronicle将在端口3012上运行，并可以通过http://localhost:3012访问其界面，默认用户名和密码均为admin。

Docker Compose方式

对于更复杂的环境或持久化需求，可以使用docker-compose.yml文件：

version: "3"
services:
  cronicle:
    image: soulteary/cronicle:latest
    restart: always
    hostname: cronicle
    ports:
      - 3012:3012
    volumes:
      - ./data/data:/opt/cronicle/data
      - ./data/logs:/opt/cronicle/logs
      - ./data/plugins:/opt/cronicle/plugins

执行docker-compose up -d即可启动服务。

3. 项目的配置文件介绍

Cronicle的配置主要通过环境变量(CRONICLE_*)和在首次启动时加载的JSON配置文件进行。配置文件通常不需要手动编辑，因为大多数设置可通过环境变量覆盖。例如，设置基础应用URL:

-e CRONICLE_base_app_url='http://your-custom-url:3012'

重要的是./data/config.json文件，它可以在容器初次启动时被导入来定制初始配置。若需要后续更新配置，应删除./data/setup_done文件后重启容器，以触发配置重载。

请注意，详细配置选项及其描述应参照Cronicle的官方文档获取最新信息，确保遵循最佳实践和安全准则。

---

以上就是关于Docker-Cronicle的基本部署与配置简介，旨在让开发者和系统管理员能够快速上手并管理他们的定时任务。正确理解和配置这些元素对于成功部署和运维Cronicle至关重要。