PyShelf: 终端式电子书服务器搭建指南

PyShelf: 终端式电子书服务器搭建指南

pyShelf A simple terminal based ebook server 项目地址: https://gitcode.com/gh_mirrors/py/pyShelf

1. 目录结构及介绍

PyShelf 是一个基于Python的轻量级、无需X窗口服务的终端电子书服务器。以下是其典型项目结构：

pyShelf/
├── gitattributes
├── gitignore
├── pre-commit-config.yaml
├── tern-config.json
├── LICENSE
├── README.md
├── config.json           <!-- 配置文件
├── configure             <!-- 配置脚本
├── docker-compose.yml    <!-- Docker Compose配置文件
├── doxygen.conf          <!-- 文档生成配置
├── importBooks           <!-- 导入书籍脚本
├── pyShelf.py            <!-- 主程序入口
├── pyproject.toml
├── pyrightconfig.json
├── requirements.txt
├── uwsgi.ini
└── uwsgi_params          <!-- uWSGI配置

• LICENSE: 许可证文件，表明项目遵循GPL-3.0。
• README.md: 项目说明文件，包含了安装与快速使用的指南。
• config.json: 存储应用的配置信息，如数据库设置等。
• pyShelf.py: 应用的主要执行文件，启动电子书服务器的关键。
• docker-compose.yml: 使用Docker部署时的编排文件。
• requirements.txt: Python依赖列表，用于环境搭建。
• uwsgi.ini, uwsgi_params: 当不通过Docker运行时，用以配置uWSGI服务。

2. 项目的启动文件介绍

Docker方式启动（推荐）

1. 准备: 确保安装了Docker和Docker Compose。
2. 环境变量: 创建.env文件在项目根目录下，示例内容应包括LOCAL_BOOK_DIR=/path/to/your/ebooks来指定你的电子书存放路径。
3. 执行命令: 在项目根目录下运行以下命令来启动容器。

   docker-compose up -d
   

   -d参数表示以后台模式运行。

自行托管（适用于高级用户）

1. 环境准备: 安装必要的依赖(gcc, python3, pip, postgresql)。
2. 配置: 设置好config.json中的相关配置，特别是数据库连接信息。
3. 安装依赖: 在项目根目录执行pip install -r requirements.txt。
4. 启动: 进入src目录，并使用以下命令启动服务器（确保已创建并正确配置数据库）：

   cd src/ && daphne frontend.asgi:application
   

3. 项目的配置文件介绍

config.json

该文件是PyShelf的核心配置所在，主要字段可能包括：

• LOCAL_BOOK_DIR: 指定本地电子书存储目录。
• DATABASE: 包含PostgreSQL数据库的连接信息，如URL或主机名、端口、用户名、密码等，这是其推荐使用的数据库系统。
• OTHER SETTINGS: 可能还包括其他自定义行为的配置项，如Web界面的默认设置等。

在实际操作中，建议详细阅读项目的官方文档或config.json注释，以获得所有可用配置选项的完整指导。对于更复杂的配置需求，比如调整用户权限、服务器端口等，直接编辑此文件即可实现相应定制。记得在修改配置后重新启动服务使更改生效。

请注意，出于安全考虑，在生产环境中应当妥善保护这些敏感配置信息，避免直接暴露。

pyShelf A simple terminal based ebook server 项目地址: https://gitcode.com/gh_mirrors/py/pyShelf