README.txt 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  1. ========================================
  2. DMS 文档管理系统 - 使用说明
  3. ========================================
  4. 【系统要求】
  5. - Windows 10/11 (64 位)
  6. - MySQL 8.x(自备,需自行安装并初始化数据库)
  7. -(可选)LibreOffice:用于 Word 文档转 PDF 预览
  8. ------------------------------------------------------------------------
  9. 【首次启动步骤】
  10. ------------------------------------------------------------------------
  11. ■ 步骤 1:准备 MySQL 数据库
  12. 1) 安装 MySQL 8(如已安装可跳过)
  13. 2) 创建数据库(utf8mb4 字符集):
  14. CREATE DATABASE dms CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
  15. 3) 如果发行包内附带 database-init.sql,则导入它:
  16. mysql -u root -p dms < database-init.sql
  17. 这会同时创建表结构并写入示例数据。
  18. 若没有该文件,请向分发者索取(或自行从源码项目执行导出工具生成)。
  19. ■ 步骤 2:修改配置文件
  20. 1) 用记事本(或 VSCode)打开本目录下的 .env 文件
  21. (首次启动会自动从 .env.example 生成)
  22. 2) 修改以下关键项:
  23. DMS_DATABASE_URL=mysql+pymysql://用户名:密码@主机:3306/dms?charset=utf8mb4
  24. DMS_JWT_SECRET=请改成一串随机字符(建议 32 位以上)
  25. ■ 步骤 3:启动服务
  26. 双击 dms-server.exe
  27. 看到控制台输出 "Running on http://127.0.0.1:9345" 即启动成功
  28. ■ 步骤 4:访问系统
  29. 在浏览器打开:http://localhost:9345
  30. ------------------------------------------------------------------------
  31. 【默认登录账号】(仅当导入了示例数据时)
  32. ------------------------------------------------------------------------
  33. 管理员:admin / Admin@1234
  34. 普通用户:user / User@1234
  35. (密码来源于示例数据,可在登录后修改)
  36. ------------------------------------------------------------------------
  37. 【常见问题】
  38. ------------------------------------------------------------------------
  39. Q: 启动后浏览器无法访问?
  40. A: 1) 检查控制台是否有错误信息(特别是数据库连接错误)
  41. 2) 确认 .env 中的 DMS_DATABASE_URL 配置正确
  42. 3) 确认 MySQL 服务已启动
  43. 4) 确认已执行步骤 1 的 SQL 导入
  44. Q: 端口冲突?
  45. A: 编辑 .env,添加一行:
  46. DMS_PORT=9350(或其他端口),重启 exe
  47. Q: Word 文档预览失败?
  48. A: 安装 LibreOffice,并确认 .env 中 DMS_LIBREOFFICE_EXECUTABLE
  49. 路径正确(默认 C:\Program Files\LibreOffice\program\soffice.exe)
  50. 或在 .env 中设置 DMS_OFFICE_PREVIEW_ENABLED=false 关闭该功能。
  51. Q: 上传的文件存储在哪?
  52. A: 程序同级目录的 dms-storage/ 下,请勿删除。
  53. Q: 如何停止服务?
  54. A: 在 dms-server.exe 的控制台窗口按 Ctrl+C,或直接关闭窗口。
  55. ------------------------------------------------------------------------
  56. 【目录结构】
  57. ------------------------------------------------------------------------
  58. dms-server.exe 主程序
  59. _internal/ PyInstaller 运行时依赖(请勿删除)
  60. .env 配置文件(首次启动生成)
  61. .env.example 配置模板
  62. database-init.sql 数据库初始化脚本(如已导出)
  63. dms-storage/ 运行时文件存储目录
  64. README.txt 本说明文件
  65. ========================================