CherryPy项目中的cherryd工具详解

CherryPy项目中的cherryd工具详解

cherrypy CherryPy is a pythonic, object-oriented HTTP framework. https://cherrypy.dev 项目地址: https://gitcode.com/gh_mirrors/ch/cherrypy

什么是cherryd

cherryd是CherryPy框架提供的一个命令行工具，用于将CherryPy HTTP服务器作为守护进程(daemon)启动。它是CherryPy生态系统中用于生产环境部署的重要组件。

核心功能

cherryd的主要功能包括：

1. 以守护进程方式运行CherryPy服务器
2. 支持多种服务器类型(HTTP/HTTPS、FastCGI、SCGI)
3. 灵活的配置管理
4. 进程ID文件管理
5. Python模块导入控制

基本用法

cherryd的基本命令格式如下：

cherryd [-d] [-f | -s] [-e ENV_NAME] [-p PIDFILE_PATH] [-P DIRPATH] [-c CONFIG_FILE] -i MODULE_NAME

参数详解

服务器类型选项

• -d：以守护进程模式运行
• -f：启动FastCGI服务器而非默认HTTP服务器
• -s：启动SCGI服务器而非默认HTTP服务器

配置相关选项

• -c CONFIG_FILE：指定配置文件路径，可多次使用
• -e ENV_NAME：指定预定义环境配置(staging/production/embedded)

应用导入选项

• -i MODULE_NAME：指定要导入的Python模块(必需参数)
• -P DIRPATH：将目录添加到sys.path开头，可多次使用

进程管理选项

• -p PIDFILE_PATH：指定存储进程ID的文件路径

实际应用示例

典型部署场景

假设我们有一个CherryPy应用需要部署：

1. 创建站点配置文件site.conf：

[global]
server.socket_host = "0.0.0.0"
server.socket_port = 8008
engine.autoreload.on = False

2. 编写启动脚本startup.py：

import cherrypy
import my_controller

cherrypy.log.error_file = '/var/tmp/myapp-error.log'
cherrypy.log.access_file = '/var/tmp/myapp-access.log'

config_root = {'tools.encode.encoding': 'utf-8'}
app_conf = {'/': config_root}
cherrypy.tree.mount(my_controller.Root(), script_name='', config=app_conf)

3. 启动命令：

cherryd -d -c site.conf -i startup -p /var/log/cherrypy/my_app.pid

权限管理最佳实践

当需要绑定低端口(如80)时，必须注意权限管理：

1. 服务器需要以root启动才能绑定低端口
2. 启动后应立即降权到非特权用户

实现方式是在启动代码中添加：

from cherrypy.process.plugins import DropPrivileges
DropPrivileges(cherrypy.engine, umask=022, uid='nobody', gid='nogroup').subscribe()

注意：

• 必须禁用Autoreload插件，因为它会重新执行进程导致权限丢失
• uid/gid可以是用户名/组名或数字ID

预定义环境配置

CherryPy提供了几种内置环境配置：

staging环境

• 关闭自动重载
• 禁用检查器
• 减少日志输出

production环境

• 在staging基础上进一步优化
• 关闭屏幕日志

embedded环境

• 适用于嵌入其他部署栈(如Apache mod_wsgi)
• 禁用信号处理

注意事项

1. cherryd不会自动处理权限降级，需要在应用代码中实现
2. 使用低端口时务必注意安全问题
3. 生产环境应始终使用production环境配置
4. 守护进程模式下需要正确配置日志文件路径

总结

cherryd是CherryPy框架中用于生产环境部署的强大工具，通过合理的配置可以构建稳定可靠的Web服务。掌握其使用方法和最佳实践，能够帮助开发者更好地部署和管理CherryPy应用。

cherrypy CherryPy is a pythonic, object-oriented HTTP framework. https://cherrypy.dev 项目地址: https://gitcode.com/gh_mirrors/ch/cherrypy