Nodejs pomelo-admin 详细配置文档

Nodejs pomelo-admin 详细配置文档

请问有没有详细的使用pomelo-admin 配置实例…

4 回复

Nodejs Pomelo-Admin 详细配置文档

Pomelo-Admin 是一个强大的工具,用于管理和监控基于 Pomelo 框架的游戏服务器。本文将详细介绍如何配置和使用 Pomelo-Admin。

安装

首先,确保你已经安装了 Node.js 和 npm。然后,通过以下命令安装 Pomelo-Admin:

npm install pomelo-admin --save

基本配置

创建一个基本的配置文件 admin.json

{
  "admin": {
    "port": 3014,
    "host": "localhost",
    "servers": [
      {
        "id": "game-server-1",
        "name": "Game Server 1",
        "type": "game",
        "addr": "localhost:8001"
      }
    ]
  }
}

在这个配置文件中:

  • port: 指定 Admin 管理服务监听的端口。
  • host: 指定 Admin 管理服务监听的主机地址。
  • servers: 列出所有需要管理的服务器,每个服务器包含 id, name, type, 和 addr 属性。

启动 Admin 服务

创建一个启动脚本 start-admin.js

const path = require('path');
const pomelo = require('pomelo');

// 加载配置文件
pomelo.init(path.resolve(__dirname, 'admin.json'), (err, app) => {
  if (err) {
    console.error(err);
    return;
  }

  // 启动 Admin 服务
  app.admin.start((err) => {
    if (err) {
      console.error(err);
      return;
    }
    console.log('Admin service started on port 3014');
  });
});

使用 Admin 服务

启动 Admin 服务:

node start-admin.js

此时,Admin 服务将在 localhost:3014 上运行,并可以管理配置中的游戏服务器。

示例请求

你可以使用 curl 或 Postman 发送请求来与 Admin 服务交互。例如,获取所有服务器的信息:

curl http://localhost:3014/admin/server

响应可能类似于:

[
  {
    "id": "game-server-1",
    "name": "Game Server 1",
    "type": "game",
    "addr": "localhost:8001"
  }
]

结论

通过上述步骤,你可以成功配置和启动 Pomelo-Admin 服务,并开始管理和监控你的游戏服务器。Pomelo-Admin 提供了许多高级功能,如日志查看、统计信息等,可以根据需要进一步探索和配置。


话说,pomelo 的文档很全啊

https://github.com/NetEase/pomelo/wiki/_pages

大家都不看github 上面的 wiki的吗?

当然可以。pomelo-admin 是用于管理 Pomelo 游戏服务器的一个模块。它提供了一系列的工具来帮助监控和管理你的游戏服务器。以下是如何配置 pomelo-admin 的详细步骤及示例代码。

安装

首先确保你已经安装了 pomelopomelo-admin

npm install pomelo --save
npm install pomelo-admin --save

配置

  1. 创建一个配置文件(例如 admin.js)来初始化 pomelo-admin 模块。

    const admin = require('pomelo-admin');
    const path = require('path');
    
    module.exports = function (app) {
      return new admin.Admin({
        host: '127.0.0.1', // 管理端主机地址
        port: 3131,        // 管理端端口号
        secret: 'your-secret-key', // 与客户端通信时使用的密钥
        heartbeatTimeout: 5000, // 心跳超时时间
        timeout: 3000,         // 请求超时时间
        path: path.join(__dirname, '../logs'), // 日志目录
        dumpDir: path.join(__dirname, '../dumps') // 内存转储目录
      });
    };
    
  2. 注册 pomelo-admin 到 Pomelo 应用程序中

    在你的应用程序入口文件(例如 app.js 或者 server.js)中,你需要将 pomelo-admin 注册到应用中:

    const app = require('pomelo').createApp();
    const admin = require('./admin'); // 引入上面创建的配置文件
    
    app.configure(admin); // 注册 admin 中间件
    
  3. 启动应用

    运行你的应用并启动 pomelo-admin 服务:

    node server.js
    

使用

  • 你可以通过 http://127.0.0.1:3131/admin/ 访问 pomelo-admin 的 Web 界面。
  • 也可以通过 API 来管理服务器,例如获取当前在线用户列表或执行命令。

示例 API 调用

  • 获取所有连接的客户端信息:

    curl -X GET http://127.0.0.1:3131/admin/client
    
  • 执行命令(例如重启特定服务):

    curl -X POST -H "Content-Type: application/json" -d '{"command":"restart","params":{"service":"connector"}' http://127.0.0.1:3131/admin/command
    

以上就是如何配置和使用 pomelo-admin 的详细步骤。希望对你有所帮助!

回到顶部