Forever 项目技术文档

1. 安装指南

安装 Forever

Forever 是一个简单的 CLI 工具，用于确保给定的脚本持续运行（即“永远”运行）。你可以通过 npm 全局安装 Forever。

$ [sudo] npm install forever -g

注意： 如果你计划在代码中以编程方式使用 Forever，你应该安装 forever-monitor。

$ cd /path/to/your/project
$ [sudo] npm install forever-monitor

2. 项目的使用说明

命令行使用

你可以使用 Forever 来持续运行脚本（无论是用 Node.js 编写的还是其他语言编写的）。

示例：

$ forever start app.js

选项

你可以通过 forever --help 查看所有可用选项。以下是一些常用选项：

• start: 启动脚本作为守护进程。
• stop: 停止指定的守护进程。
• stopall: 停止所有运行的 Forever 脚本。
• restart: 重启指定的守护进程。
• restartall: 重启所有运行的 Forever 脚本。
• list: 列出所有运行的 Forever 脚本。
• logs: 列出所有 Forever 进程的日志文件。

JSON 配置文件

除了通过命令行传递脚本路径和选项外，你还可以传递 Forever 一个 JSON 文件，其中包含这些选项。例如：

{
    "uid": "app",
    "append": true,
    "watch": true,
    "script": "index.js",
    "sourceDir": "/home/myuser/app",
    "logFile": "/home/myuser/logs/forever.log",
    "outFile": "/home/myuser/logs/out.log",
    "errFile": "/home/myuser/logs/error.log"
}

你可以通过以下命令启动应用：

$ forever start ./forever/development.json

在代码中使用

Forever 模块提供了一些有用的方法，可以在你的代码中使用。每个方法返回一个 EventEmitter 实例，当操作完成时会触发相应的事件。

示例：

const forever = require('forever');

forever.startDaemon('app.js', {
    'uid': 'app',
    'logFile': 'forever.log',
    'outFile': 'out.log',
    'errFile': 'error.log'
});

3. 项目 API 使用文档

forever.load(config)

同步设置 Forever 模块的配置。配置选项包括：

• root: 存放所有默认 Forever 日志文件的目录。
• pidPath: 存放所有 Forever *.pid 文件的目录。
• sockPath: 用于 IPC 的套接字目录。
• loglength: forever tail 返回的日志数量。
• columns: 当 format 为 true 时显示的列。
• debug: 是否以调试模式运行。
• stream: 日志是否会被流式传输。

forever.start(file, options)

启动一个脚本并使用 Forever 管理。options 对象是 forever-monitor 期望的选项。

forever.startDaemon(file, options)

以守护进程方式启动一个脚本。options 对象是 forever-monitor 期望的选项。

forever.stop(index)

停止指定索引的 Forever 守护进程脚本。索引与 forever.list() 返回的索引相同。

forever.stopAll(format)

停止所有当前运行的 Forever 脚本。format 参数是一个布尔值，指示返回的值是否应根据配置的列进行格式化。

4. 项目安装方式

全局安装

$ [sudo] npm install forever -g

项目内安装

$ cd /path/to/your/project
$ [sudo] npm install forever-monitor

通过以上步骤，你可以轻松安装并使用 Forever 来管理你的脚本，确保它们持续运行。