商务文书数字档案馆系统本地部署及基础功能配置实操指南
一、环境准备
需提前安装Git(克隆源码用)、Python 3.8及以上、pip包管理器,分系统执行对应安装步骤:
Windows系统
1. 下载Git:访问https://git-scm.com/download/win ,下载后默认点击「Next」完成安装;
2. 下载Python:访问https://www.python.org/ftp/python/3.10.11/python-3.10.11-amd64.exe ,安装时必须勾选「Add Python to PATH」选项,完成后重启CMD;
验证安装:打开CMD执行以下命令,返回版本号即为成功:
git --version
python --version
Ubuntu/Debian系统
执行命令批量安装依赖:
sudo apt update && sudo apt install git python3.8 python3-pip -y
验证命令同Windows系统。
二、下载并部署系统源码
克隆轻量商务文书数字档案馆开源源码,执行:
git clone https://github.com/light-tech/business-docs-archive.git
进入项目目录:
cd business-docs-archive
安装项目依赖包:

pip install -r requirements.txt
依赖安装失败解决:执行pip install --upgrade pip后重试上述命令
三、核心配置文件完整修改
打开项目目录下的config.py,替换所有内容为以下代码,所有参数需准确填写:
config.py
import os
BASE_DIR = os.path.abspath(os.path.dirname(__file__))
数据库配置(SQLite无需额外安装,适合本地部署)
DATABASE_URI = f"sqlite:///{os.path.join(BASE_DIR, 'docs.db')}"
文档存储目录(需提前创建,Linux/macOS无需手动操作,Windows需确认权限)
DOC_STORAGE_PATH = os.path.join(BASE_DIR, 'archive_files')
os.makedirs(DOC_STORAGE_PATH, exist_ok=True)
管理员账号(可自定义)
ADMIN_USERNAME = "admin"
ADMIN_PASSWORD = "Admin@123456"
服务端口(若端口被占用可修改为8081等未用端口)
SERVER_PORT = 8080
允许上传的文档格式(按需添加)
ALLOWED_EXTENSIONS = {'pdf', 'docx', 'doc', 'xlsx'}
Windows权限补充:若文档上传失败,右键点击项目文件夹→属性→安全→编辑,勾选「完全控制」权限后应用
四、初始化数据库并创建管理员账号
执行数据库初始化命令,自动创建管理员账号:
python init_db.py
输出「数据库初始化完成,管理员账号已创建」即为成功,无需额外操作。
五、启动系统服务
执行启动命令:
python app.py
输出「服务启动成功,访问地址:http://127.0.0.1:8080」(Windows可替换为http://localhost:8080),表示部署完成。
六、基础功能实操验证
1. 登录系统
打开浏览器访问上述地址,输入管理员账号admin和密码Admin@123456登录。
2. 创建分类与上传文档
点击左侧「文档分类」→「新建分类」,输入分类名称(如「2024年度合同」)后确认;点击「上传文档」,选择本地商务文书(支持PDF/Word/Excel),选择对应分类后点击「确认上传」,系统自动生成唯一归档编号(如HT-2024-001)。
3. 文档检索
在顶部检索框输入关键词(如「合作协议」),点击「检索」,1秒内返回匹配结果,支持按归档编号、上传时间、文档类型过滤。
七、常见问题排查
- 端口被占用:修改config.py中SERVER_PORT为未用端口(如8081),重启服务即可;
- 文档上传失败:确认config.py中ALLOWED_EXTENSIONS包含文档格式,且DOC_STORAGE_PATH有写入权限,Linux执行
chmod 755 archive_files; - 启动报错:确认Python版本≥3.8,执行
python --version核对,若版本过低重新安装对应版本。