iCloud-Docker 项目使用教程

iCloud-Docker 项目使用教程

icloud-drive-dockerDockerized iCloud Client - make a local copy of your iCloud documents and photos, and keep it automatically up-to-date.项目地址:https://gitcode.com/gh_mirrors/ic/icloud-drive-docker

1. 项目的目录结构及介绍

iCloud-Docker 项目的目录结构如下：

icloud-drive-docker/
├── README.md
├── docker-compose.yml
├── env.icloud
├── requirements.txt
├── run-ci.sh
├── run-in-env.sh
└── src/
    ├── config.py
    ├── sync.py
    └── utils.py

目录结构介绍

• README.md: 项目说明文档，包含项目的基本信息和使用方法。
• docker-compose.yml: Docker Compose 配置文件，用于定义和运行多容器 Docker 应用程序。
• env.icloud: 环境变量文件，包含 iCloud 账号和密码等信息。
• requirements.txt: 项目依赖的 Python 包列表。
• run-ci.sh: 用于持续集成的脚本。
• run-in-env.sh: 用于在虚拟环境中运行项目的脚本。
• src/: 项目源代码目录。
  • config.py: 配置文件处理模块。
  • sync.py: 同步 iCloud 数据的主要逻辑模块。
  • utils.py: 工具函数模块。

2. 项目的启动文件介绍

项目的启动文件主要是 docker-compose.yml 和 run-in-env.sh。

docker-compose.yml

docker-compose.yml 文件定义了如何启动和管理 Docker 容器。以下是文件的主要内容：

version: "3.4"
services:
  icloud:
    image: mandarons/icloud-drive
    environment:
      - PUID=<insert the output of `id -u $user`>
      - GUID=<insert the output of `id -g $user`>
    env_file:
      - env.icloud # should contain ENV_ICLOUD_PASSWORD=<password>
    container_name: icloud
    restart: unless-stopped
    volumes:
      - /etc/timezone:/etc/timezone:ro
      - /etc/localtime:/etc/localtime:ro
      - ./icloud:/icloud
      - ./config:/config

run-in-env.sh

run-in-env.sh 脚本用于在虚拟环境中运行项目。以下是脚本的主要内容：

#!/bin/bash

# 设置虚拟环境
python3 -m venv venv
source venv/bin/activate

# 安装依赖
pip install -r requirements.txt

# 运行项目
python src/sync.py

3. 项目的配置文件介绍

项目的配置文件主要是 env.icloud 和 config.py。

env.icloud

env.icloud 文件包含了 iCloud 账号和密码等环境变量。以下是文件的示例内容：

ENV_ICLOUD_USERNAME=your_icloud_username
ENV_ICLOUD_PASSWORD=your_icloud_password

config.py

config.py 文件用于处理配置信息。以下是文件的示例内容：

import os

class Config:
    def __init__(self):
        self.username = os.getenv('ENV_ICLOUD_USERNAME')
        self.password = os.getenv('ENV_ICLOUD_PASSWORD')
        self.config_file_path = os.getenv('ENV_CONFIG_FILE_PATH', '/config/config.yaml')

    def get_config(self):
        return {
            'username': self.username,
            'password': self.password,
            'config_file_path': self.config_file_path
        }

通过以上配置文件，项目可以读取 iCloud 账号和密码，并加载配置文件路径。

icloud-drive-dockerDockerized iCloud Client - make a local copy of your iCloud documents and photos, and keep it automatically up-to-date.项目地址:https://gitcode.com/gh_mirrors/ic/icloud-drive-docker