Haibu 技术文档

本文档将详细说明如何安装和使用 Haibu，以及如何通过 API 与 Haibu 进行交互。

一、安装指南

在开始使用 Haibu 之前，您需要先确保您的环境中已安装了 Node.js。以下为安装 Haibu 的步骤：

[sudo] npm install haibu -g

确保使用全局安装（-g）以便在命令行中全局访问 Haibu。

二、项目使用说明

启动 Haibu 服务

首先，启动 Haibu 服务：

[sudo] node bin/haibu

启动成功后，Haibu 服务将在本地主机的 9002 端口上运行。

使用 Haibu 客户端启动应用

以下示例代码演示了如何使用 Haibu 客户端来启动一个 Node.js 应用：

var haibu = require('haibu');

// 创建一个与 Haibu 服务器通信的客户端
var client = new haibu.drone.Client({
  host: 'localhost',
  port: 9002
});

// 应用程序的 package.json
var app = {
  "user": "marak",
  "name": "test",
  "domain": "devjitsu.com",
  "repository": {
    "type": "git",
    "url": "https://github.com/Marak/hellonode.git"
  },
  "scripts": {
    "start": "server.js"
  }
};

// 尝试启动新应用
client.start(app, function (err, result) {
  if (err) {
    console.log('启动应用错误：' + app.name);
    return console.log(err);
  }

  console.log('成功启动应用：');
  console.log(result);
});

通过 Push 部署应用

首先，进入应用程序目录，然后压缩应用程序文件，并通过 Haibu 的 deploy 接口发送：

cd path/to/your/app
tar -cz . | curl -XPOST -sSNT- localhost:9002/deploy/username/appname

或者，也可以使用以下命令：

tar -czf app.tgz .
curl -XPOST -sSNT app.tgz localhost:9002/deploy/username/appname

确保在应用程序目录中执行 tar 命令，否则可能会将不必要的目录包含在压缩文件中，从而混淆 Haibu。

通过 RESTful Web 服务启动和停止应用

以下是通过 Haibu RESTful API 启动和停止应用程序的示例：

启动应用程序

POST /drones/test/start

请求体：

{
  "start": {
    "user": "marak",
    "name": "test",
    "domain": "devjitsu.com",
    "repository": {
      "type": "git",
      "url": "https://github.com/Marak/hellonode.git"
    },
    "scripts": {
      "start": "server.js"
    }
  }
}

响应

HTTP/1.1 200 OK

停止应用程序

POST /drones/test/stop

请求体：

{
  "stop": {
    "name": "test"
  }
}

响应

HTTP/1.1 200 OK

三、项目 API 使用文档

Haibu 提供了一个 JSON RESTful API，允许您以编程方式管理应用程序。以下是一些基本的 API 操作：

• POST /drones/<app_name>/start：启动指定名称的应用程序。
• POST /drones/<app_name>/stop：停止指定名称的应用程序。

四、项目安装方式

请参考本文档的“安装指南”部分，其中详细介绍了如何通过 npm 全局安装 Haibu。

以上是使用和操作 Haibu 的基本指南。请确保按照上述步骤操作，以便充分利用 Haibu 的功能。