Open Paperless 项目使用教程

1. 项目目录结构及介绍

Open Paperless 项目的目录结构如下：

• contrib: 贡献者相关文件
• docs: 项目文档
• mayan: 与 Mayan EDMS 相关的文件
• requirements: 项目依赖文件
• .gitignore: Git 忽略文件
• .gitlab-ci.yml: GitLab CI/CD 配置文件
• .travis.yml: Travis CI 配置文件
• CODE_OF_CONDUCT.md: 项目行为准则
• CODE_OF_MERIT.md: 项目功绩准则
• CONTRIBUTING.md: 贡献指南
• Dockerfile: Docker 容器构建文件
• HISTORY-mayan.rst: Mayan EDMS 的历史记录
• HISTORY.rst: 项目历史记录
• LICENSE: 项目许可证
• MANIFEST.in: 包含文件列表
• Makefile: Makefile 文件
• README.md: 项目自述文件
• README.rst: 项目自述文件（reStructuredText 格式）
• __init__.py: 初始化文件
• circus-docker.ini: Circus Docker 配置文件
• circus.ini: Circus 配置文件
• docker-compose.yml: Docker Compose 配置文件
• generate_setup.py: 生成 setup.py 文件的脚本
• manage.py: 管理脚本
• removals.txt: 移除文件列表
• requirements.txt: 项目依赖文件
• run.sh: 运行脚本
• setup.cfg: 设置配置文件
• setup.py: 设置文件
• setup.py.tmpl: 设置文件模板
• setup.sh: 设置脚本
• tox.ini: Tox 配置文件

2. 项目的启动文件介绍

项目的启动主要依赖于 run.sh 脚本。该脚本用于启动项目服务。以下是 run.sh 脚本的主要内容：

#!/bin/bash

# 设置环境变量
export DJANGO_SETTINGS_MODULE='openpaperless.settings'
export SECRET_KEY='your-secret-key-here'
export DEBUG='on'

# 启动服务
python manage.py runserver 0.0.0.0:8000

在实际使用中，你需要替换 SECRET_KEY 为你自己生成的密钥，并确保 DEBUG 设置符合你的需求。

3. 项目的配置文件介绍

项目的配置主要通过 settings.py 文件进行。以下是 settings.py 文件的一些关键配置：

# Django 设置模块
# ...

# 数据库配置
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    }
}

# 应用列表
INSTALLED_APPS = [
    # ...
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # ...
]

# 中间件配置
MIDDLEWARE = [
    # ...
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    # ...
]

# 静态文件配置
STATIC_URL = '/static/'

# ...

在此文件中，你可以配置数据库连接、应用列表、中间件以及其他 Django 设置。请确保所有的配置都是正确的，以便项目能正常运行。