用 OpenShip 自建部署平台

本章我们要搭建起 OpenShip 的基本运行环境，并成功启动服务，这样你就能有一个可以使用的自托管部署平台了。

首先，确保你的系统已经安装了 Docker 和 Docker Compose，因为我们将使用它们来简化部署过程。另外，请确认你的机器有足够的资源（至少 4GB 内存）来运行 OpenShip。

我们先下载 OpenShip 的源码到本地。打开终端，执行以下命令：

git clone https://github.com/oblien/openship.git
cd openship

这会克隆项目的仓库并在当前目录下创建一个名为 openship 的文件夹。接着，我们需要构建并启动 OpenShip 服务。继续在终端输入：

docker-compose up -d --build

这条命令会自动拉取所需的镜像、构建应用容器，并以后台模式启动所有服务。首次运行可能需要几分钟时间来完成这些步骤。

如果你遇到权限问题导致无法访问某些端口，尝试在命令前加上 sudo：

sudo docker-compose up -d --build

当看到类似 Creating network "openship_default" with the default driver 和 Successfully tagged openship_web:latest 的信息时，说明构建已经完成并且服务正在后台运行。

为了验证一切正常工作，我们可以查看日志输出：

docker-compose logs -f web

你应该能看到一些关于 Web 应用初始化的日志信息，并最终出现一行表示服务器已启动的消息，比如 [GIN-debug] Listening and serving HTTP on :8080。

最后，打开浏览器访问 http://localhost:8080 。如果一切顺利的话，你会看到 OpenShip 的登录界面或者初始设置页面。

完成后你已经得到了一个正在运行的 OpenShip 实例，并且可以通过浏览器与其交互来进行后续的操作了。

通过 Web 控制台部署项目后，你可以直观地管理和发布你的应用程序。本章将引导你使用 OpenShip 的 Web 界面来创建和部署一个新的项目。

前提条件

确保你已经完成了第一章的内容，并且有一个正在运行的 OpenShip 实例。打开浏览器访问 http://localhost:8080 ，你应该能够看到 OpenShip 的登录界面或初始设置页面。

第一步：注册账户

首先，我们需要注册一个账户以便使用 Web 控制台。

1. 打开 http://localhost:8080 并点击“Sign Up”按钮。
2. 输入用户名、电子邮件地址和密码，然后点击“Create Account”。

完成后你将被重定向到仪表盘页面。

第二步：添加新项目

接下来，我们将添加一个新的项目到 OpenShip 中。

1. 在仪表盘页面，点击右上角的“+ New Project”按钮。
2. 输入项目的名称和描述（例如，“My First Project”），然后选择项目的源代码仓库类型（目前支持 Git）。
3. 如果你选择的是 Git 仓库，请输入仓库 URL 和分支名（默认为 main 或 master）。如果你还没有准备好的仓库，可以稍后再填写。
4. 点击“Create Project”。

完成后你会看到新创建的项目出现在项目列表中。

第三步：配置构建选项

每个项目都需要一些基本的构建配置才能正确地编译和打包。

1. 点击刚刚创建的项目进入详情页。
2. 在左侧导航栏中选择“Build Settings”。
3. 根据你的项目需求填写以下字段：
   • Language: 选择你的项目使用的编程语言（如 Node.js, Python 等）。
   • Build Command: 指定如何构建你的项目（例如 npm run build）。
   • Start Command: 指定如何启动你的应用（例如 node index.js）。
4. 如果有其他高级设置需要调整，可以在相应部分进行修改。
5. 最后点击保存按钮确认更改。

完成后你的项目的构建配置就完成了初步设定。

第四步：连接代码库并触发第一次部署

现在我们准备好将实际的代码推送到 OpenShip 上进行部署了。

1. 回到项目的详情页，在左侧导航栏中选择“Source Code”。

2. 将提供的 SSH 或 HTTPS 地址复制下来，并将其作为远程仓库添加到本地 Git 仓库中。假设你已经有了一个本地 Git 仓库：

   git remote add openship <copied-url>

3. 推送代码到 OpenShip：

   git push openship main

4. 推送完成后，回到 Web 控制台中的“Deployments”标签页。这里可以看到最近一次推送的状态信息以及详细的日志输出。等待一段时间直到状态变为成功或者失败。

如果一切顺利，OpenShip 将会自动检测到新的提交并开始构建过程。完成后你会在控制台中看到应用的相关信息以及外部访问地址。

示例场景

假设你现在有一个简单的 Node.js 应用程序，并希望将其部署到 OpenShip 上供他人访问。按照上述步骤操作之后，你需要做的就是编写好应用代码并通过 Git 提交至关联的远程仓库。每次更新代码并推送时，OpenShip 都会自动重新构建并在指定环境中运行最新版本的应用程序。

本章小结

• 注册账户并登录 OpenShip 的 Web 控制台；
• 添加新项目并配置必要的构建选项；
• 连接代码库并将代码推送到 OpenShip 触发自动部署流程；
• 查看部署进度和结果，在成功后获取应用对外暴露的服务地址；

通过以上步骤，你已经能够在 OpenShip 中利用图形化界面轻松实现项目的初始化与持续集成/持续交付流程。

现在我们要使用 OpenShip 的命令行工具来初始化和部署项目。完成这一步后，你不仅能在本地通过命令行管理你的应用，还能更好地理解每个步骤背后的原理。

前置条件

确保你已经在上一章中完成了以下操作：

• 已经安装了 OpenShip 服务。
• 已经注册并登录到了 OpenShip 的 Web 控制台。
• 已经创建了一个新的项目，并且知道如何连接代码库。
• 有一个可以用来测试的简单应用程序代码库（例如一个 Node.js 应用）。

第一步：安装 OpenShip CLI

首先，我们需要确保已经全局安装了 OpenShip 的命令行工具。打开终端并输入以下命令：

npm i -g openship

如果你没有安装 Node.js 或者 npm，请先安装它们。安装完成后，你可以通过运行 openship --version 来验证是否正确安装了 OpenShip CLI。

第二步：进入项目目录

切换到你要部署的项目的根目录。假设你的项目位于桌面上的一个名为 my-node-app 的文件夹内，你可以这样做：

cd ~/Desktop/my-node-app

第三步：初始化项目

在项目目录下运行以下命令来初始化该项目：

openship init

这个命令会将当前目录下的代码与你在 Web 控制台上创建的项目关联起来。它会在你的项目目录下生成一些配置文件，这些文件包含了 OpenShip 所需的所有信息来识别和构建你的应用。

注意事项：

• 如果你在执行 openship init 时遇到错误提示类似于 "Project not found"，请检查你是否正确地添加了远程仓库 URL，并且该 URL 是否指向正确的 OpenShip 项目。
• 确保你当前所在的目录是项目的根目录，否则可能会导致配置文件生成的位置不正确。

第四步：部署项目

一旦项目被成功初始化，就可以使用下面的命令来进行部署：

openship deploy

这条命令会触发一次完整的部署流程。OpenShip 会根据你的代码自动检测所需的依赖项、构建应用、配置环境变量，并最终将应用部署到指定的目标服务器上。

注意事项：

• 如果在部署过程中出现错误，请仔细查看终端输出的日志信息。通常错误消息会提供足够的线索帮助你定位问题所在。
• 对于第一次部署可能需要花费几分钟的时间来下载所有依赖项并完成构建过程。

示例场景

假设你现在有一个简单的 Node.js 应用程序，并希望通过 OpenShip 的命令行工具将其快速部署到生产环境中去。按照上面的操作步骤进行如下操作：

1. 初始化项目：

   cd ~/Desktop/my-node-app
   openship init

2. 部署项目：

   openship deploy

经过一系列自动化处理后，你应该能够在 Web 控制台中看到这次部署的状态变化，并最终获得一个可以访问的应用地址。

本章小结

• 学习了如何通过 npm 全局安装 OpenShip CLI 工具；
• 掌握了如何在本地项目的根目录下运行 openship init 命令以关联远程仓库；
• 理解了如何使用 openship deploy 命令来触发项目的自动构建和部署流程；
• 获得了实际操作经验，在真实场景中成功地进行了项目的初始化与首次部署；

通过以上步骤，你已经能够熟练地利用 OpenShip 的命令行接口进行项目的管理和自动化部署工作。

配置和管理数据库及存储是我们项目中的重要环节。通过合理配置这些资源，我们可以确保应用的数据持久性和安全性。本章将引导你如何在 OpenShip 中设置和管理数据库以及存储空间。

前置条件

• 你已经在本地安装并启动了 OpenShip 服务。
• 你的项目已经通过 openship init 关联到了远程仓库。
• 你需要有管理员权限来执行以下操作。

第一步：添加数据库支持

首先，我们需要为项目添加一个数据库。OpenShip 支持多种类型的数据库，包括 PostgreSQL、MySQL 和 MongoDB。这里我们以 PostgreSQL 为例。

操作步骤：

1. 打开项目的配置文件 openship.yaml，如果没有这个文件可以通过 openship init 创建。
2. 在 services 下添加一个新的服务来定义你的数据库。

services:
  db:
    type: postgresql
    version: "13"
    environment:
      POSTGRES_DB: myappdb
      POSTGRES_USER: myuser
      POSTGRES_PASSWORD: mypassword

预期结果：保存上述配置后，OpenShip 将会在部署时自动创建一个 PostgreSQL 数据库实例，并使用指定的用户名和密码进行初始化。

第二步：连接应用到数据库

为了让我们的应用程序能够访问新创建的数据库，需要在应用的服务配置中添加相应的环境变量或者配置文件修改。

操作步骤：

1. 修改你的应用程序代码或配置文件，使其能够根据环境变量连接到 PostgreSQL 数据库。
2. 更新 openship.yaml 文件中的应用服务部分，添加对数据库的引用和服务间的网络连接。

services:
  app:
    type: nodejs
    ports:
      - "3000:3000"
    depends_on:
      - db
    environment:
      DB_HOST: db
      DB_NAME: myappdb
      DB_USER: myuser
      DB_PASSWORD: mypassword

预期结果：这样配置之后，在部署过程中 OpenShip 会自动为你的应用服务和数据库服务建立网络连接，并传递必要的环境变量以便应用能够正确地连接到数据库。

第三步：配置存储解决方案

除了数据库之外，很多应用还需要对象存储或其他形式的数据存储来保存用户上传的内容或者其他静态资源。这里我们以 Amazon S3 作为示例来展示如何集成外部存储服务。

操作步骤：

1. 注册并登录 AWS 账户，在 IAM 中创建一个具有 S3 访问权限的新用户，并获取该用户的 Access Key ID 和 Secret Access Key。
2. 回到 openship.yaml 文件，在应用服务的部分添加相关的环境变量用于访问 S3 存储桶。

services:
  app:
    ...
    environment:
      ...
      AWS_ACCESS_KEY_ID: YOUR_AWS_ACCESS_KEY_ID_HERE
      AWS_SECRET_ACCESS_KEY: YOUR_AWS_SECRET_ACCESS_KEY_HERE
      AWS_S3_BUCKET_NAME: your-s3-bucket-name

预期结果：更新后的配置使得你的应用程序可以在运行时通过提供的凭证访问指定的 S3 存储桶来进行数据存取操作。

注意事项：

• 确保敏感信息如密码、密钥等不要硬编码在公开可见的地方，可以考虑使用环境变量注入的方式提高安全性。
• 不同类型的数据库有不同的性能特性与适用场景，请根据具体需求选择合适的类型进行部署。
• 如果你在部署过程中遇到任何问题，请检查日志信息以获取更多调试线索。你可以通过 openship logs 查看实时日志输出。

示例场景：

假设你现在有一个博客系统，并希望为其增加评论功能。为了实现这一点，你需要一个关系型数据库来保存评论内容，并且可能还需要一个对象存储用来存放用户上传的照片和其他媒体文件。基于前面的学习成果，你可以按照以下方式来完成这些任务：

1. 在项目的 openship.yaml 文件中添加一个新的 PostgreSQL 数据库服务。
2. 同样在这个文件中修改你的博客系统的应用服务部分，让其知道如何连接到新增加的数据库。
3. 如果需要的话，在博客系统内部调整代码逻辑以适应新的数据模型设计。
4. 最后别忘了给博客系统加上对 Amazon S3 的集成能力，这样就可以方便地管理用户生成的所有多媒体内容了。

经过以上几个步骤之后，你应该已经成功地完成了博客系统的升级工作，并且所有的数据都会被妥善地存储起来供后续使用了。

本章小结

• 我们学习了如何在 OpenShip 中定义并启动不同类型的数据库实例；
• 掌握了如何使应用程序正确地识别并连接到已有的数据库服务；
• 理解了如何将第三方云存储整合进现有的部署架构当中；
• 获得了一些实践经验，在真实场景中成功地实现了对复杂数据资源的需求覆盖；

现在我们要为你的项目设置域名和 SSL 证书，确保你的应用可以通过安全的 HTTPS 访问。完成这一步后，你的用户可以放心地访问你的网站，而不需要担心中间人攻击。

前置条件

• 你已经在本地或服务器上安装并启动了 OpenShip。
• 你已经有一个注册好的域名，并且能够管理该域名的 DNS 设置。
• 你已经通过 Web 控制台或命令行部署了一个项目。

第一步：配置域名映射

首先，我们需要告诉 OpenShip 我们的项目应该绑定到哪个域名。假设我们的域名为 example.com。

1. 打开你的项目的 openship.yaml 文件。
2. 添加或修改 domains 字段，指定你要使用的域名：

   services:
     app:
       image: my-app-image
       ports:
         - "80:80"
       domains:
         - example.com

第二步：更新 DNS 设置

为了让外部流量能到达你的 OpenShip 服务器，你需要在域名注册商提供的 DNS 管理界面中添加一条 A 记录或者 CNAME 记录。这里我们假设使用的是 A 记录。

1. 登录到你的域名注册商的控制面板。
2. 找到 DNS 管理页面。
3. 添加一个新的 A 记录，指向你的 OpenShip 服务器的 IP 地址：

   Name: @ (表示根域名)
   Type: A
   Value: 你的服务器IP地址 (例如 192.168.1.1)
   TTL: 默认值通常是好选项

第三步：启用 SSL/TLS 加密

OpenShip 内置了 Let's Encrypt 来自动处理 SSL/TLS 证书的申请、安装和续期。因此，一旦你正确配置了域名，OpenShip 就会自动为你颁发证书。

1. 等待几分钟，让 DNS 变更生效。你可以通过查询工具如 MXToolbox 检查记录是否生效。
2. 返回 OpenShip 的 Web 控制台或命令行工具。
3. 查看项目的状态，确认证书已经成功签发：

   openship status

如果一切正常，你会看到类似以下的信息：

Service 'app' is running at https://example.com/
SSL certificate is valid until YYYY-MM-DD.

注意事项

• 如果你在配置过程中遇到 DNS 解析失败的问题，请检查是否有拼写错误或者等待一段时间再试。
• 如果证书没有自动签发，请确保防火墙允许来自 Let's Encrypt 的验证请求（通常是端口 80 和 443）。
• 对于子域名的支持，请确保你也添加了相应的 DNS 记录，并在 openship.yaml 中列出所有需要支持的子域名。

示例场景：

假设你现在有一个在线商城，并希望用户可以直接通过 shop.example.com 访问它。我们可以按照以下步骤来完成这个需求：

1. 在项目的 openship.yaml 文件中添加子域名配置：

   services:
     shop:
       image: my-shop-image
       ports:
         - "80:80"
       domains:
         - shop.example.com

2. 更新 DNS 设置，在注册商后台添加一个指向你服务器 IP 的 A 记录：

   Name: shop
   Type: A
   Value: 你的服务器IP地址 (例如 192.168.1.1)
   TTL: 默认值通常是好选项

3. 等待 DNS 生效后，返回 OpenShip 控制台查看状态，确认证书已签发并且商城可以通过 HTTPS 正常访问。

经过以上几个步骤之后，你应该已经成功地将域名绑定了到你的项目，并且启用了安全的 HTTPS 支持。

本章小结

• 我们学习了如何在 openship.yaml 文件中配置项目所使用的域名；
• 掌握了如何在DNS提供商那里添加必要的A记录或CNAME记录；
• 理解了OpenShip是如何利用Let’s Encrypt来自动处理SSL/TLS证书的申请和维护；
• 在实际案例中实现了将自定义域名绑定到应用并通过HTTPS提供服务的过程；

本章我们要学会如何使用 OpenShip 内置的邮件服务器发送邮件。完成这些步骤后，你就能在自己的项目中轻松集成邮件功能，无需依赖外部邮件服务提供商。

前置条件

确保你已经按照之前的章节成功安装并启动了 OpenShip 服务，并且可以访问 Web 控制台。此外，请确认你的 OpenShip 版本支持内置邮件服务器功能。

第一步：配置邮件服务器设置

首先，我们需要在 OpenShip 中配置邮件服务器的相关信息。打开 openship.yaml 文件，找到或新增以下配置项：

mail:
  enabled: true
  host: smtp.yourdomain.com
  port: 587
  username: your-email@example.com
  password: your-email-password
  secure: false

• enabled: 启用内置邮件服务器。
• host: SMTP 服务器地址。
• port: SMTP 端口号，默认为 587 或者 465。
• username 和 password: 发送邮件所需的用户名和密码。
• secure: 是否启用 TLS 加密连接。

如果你不确定这些信息，可以联系你的邮箱服务商获取详细配置。

第二步：测试邮件发送功能

为了验证邮件服务器是否配置正确，我们可以编写一个简单的脚本来发送一封测试邮件。假设你有一个 Node.js 环境，创建一个新的 JavaScript 文件 send-test-mail.js，内容如下：

const nodemailer = require('nodemailer');

// 创建传输对象
let transporter = nodemailer.createTransport({
    host: 'smtp.yourdomain.com',
    port: 587,
    secure: false, // 如果使用端口465，则设置为true
    auth: {
        user: 'your-email@example.com',
        pass: 'your-email-password'
    }
});

// 邮件选项
let mailOptions = {
    from: '"OpenShip Test" <your-email@example.com>',
    to: 'recipient@example.com', // 收件人地址
    subject: 'Hello ✔',
    text: 'Hello world?',
    html: '<b>Hello world?</b>'
};

// 发送邮件并打印结果
transporter.sendMail(mailOptions, (error, info) => {
    if (error) {
        return console.log(error);
    }
    console.log('Message sent: %s', info.messageId);
});

然后，在终端中运行这个脚本：

node send-test-mail.js

如果一切正常，你会看到类似如下的输出：

Message sent: <some-id@yourdomain.com>

同时收件人应该会收到这封测试邮件。

注意事项与常见问题排查

1. 认证失败: 如果出现错误提示“Authentication failed”，请检查你在 openship.yaml 中填写的用户名和密码是否正确。
2. SMTP 主机不可达: 错误提示“Error connecting to the SMTP host”通常表示无法连接到指定的 SMTP 地址，请确认网络畅通无阻，并且防火墙没有阻止该端口。
3. TLS/SSL 设置不当: 如果启用了加密连接而仍然遇到问题，请尝试切换 secure 参数值或者调整相应的 SSL/TLS 设置。

示例场景：用户注册欢迎信

假设我们正在开发一个电商平台，并希望在新用户注册后自动发送欢迎电子邮件。根据上面的学习成果，我们可以编写一段代码来实现这一需求：

function sendWelcomeEmail(userEmail) {
    let transporter = nodemailer.createTransport({
        host: 'smtp.yourdomain.com',
        port: 587,
        secure: false,
        auth: {
            user: 'your-email@example.com',
            pass: 'your-email-password'
        }
    });

    let mailOptions = {
        from: '"Your Shop Team" <shop-team@yourdomain.com>',
        to: userEmail,
        subject: 'Welcome to Our Shop!',
        text:
            'Hi there,\n\nThank you for signing up with us!\nWe hope you enjoy shopping.\nBest regards,\nThe Shop Team',
        html:
            '<h1>Welcome to Our Shop!</h1><p>Thank you for signing up with us!<br>We hope you enjoy shopping.</p><p>Best regards,<br>The Shop Team</p>'
    };

    transporter.sendMail(mailOptions, function (err, info) {
        if (err) throw err;
        console.log(`Welcome email sent to ${userEmail}`);
    });
}

// 调用函数模拟用户注册后的动作：
sendWelcomeEmail('new-user@example.com');

这样每当有新用户注册时调用上述函数即可触发欢迎信的发送流程。

本章小结

• 我们学习了如何在 OpenShip 中启用并配置内置的邮件服务器；
• 编写了用于测试和实际应用场景中的简单脚本来发送电子邮件；
• 解决了一些常见的配置错误及其排查方法；
• 深入理解了如何利用 OpenShip 提供的服务简化项目的开发过程。

备份和恢复数据是确保项目稳定运行的重要环节。通过本章的学习，你将掌握如何在 OpenShip 中设置定期备份，并能够在需要时快速恢复数据。

前置条件

• 你已经安装并启动了 OpenShip 服务。
• 你的项目已经在 OpenShip 上成功部署并且正常运行。

第一步：检查当前的数据存储位置

首先，我们需要确认 OpenShip 正在使用的数据存储路径。你可以通过以下命令查看配置：

cat ~/.openship/config.yaml

在这个文件中查找 data_dir 字段，它指定了数据存储的位置。默认情况下，这个路径可能是 ~/.openship/data。

第二步：启用定时备份功能

OpenShip 支持通过配置来启用定时备份。编辑上面找到的配置文件：

nano ~/.openship/config.yaml

添加或修改以下字段来设置每日凌晨 2 点执行一次完整备份，并且保留最近 7 天的备份文件：

backup:
  schedule: "0 2 * * *"          # cron 表达式表示每天凌晨 2 点执行
  retention_days: 7              # 保留最近 7 天的备份文件

保存并退出编辑器（在 nano 中按 Ctrl+O 然后回车键保存，再按 Ctrl+X 退出）。

第三步：手动触发一次备份以验证配置是否正确

我们可以手动运行一次备份任务来验证配置是否生效：

openship backup create --now

如果一切顺利，你应该会在控制台看到类似如下的输出信息：

Backup started successfully. Backup ID: abcdef123456...

同时，在之前指定的 data_dir 下会生成一个新的子目录存放这次备份的内容。

第四步：模拟数据丢失情况并尝试恢复

为了确保我们的恢复机制有效工作，我们先创建一些临时数据作为测试对象。假设我们在项目目录下有一个名为 testfile.txt 的文件：

echo "This is a test file." > ~/myproject/testfile.txt

然后故意删除这个文件以模拟数据丢失的情况：

rm ~/myproject/testfile.txt

现在使用刚才创建的那个备份来进行恢复操作：

openship backup restore --id=abcdef123456... --target-dir=~/myproject/

其中 --id 参数后面接的是前面手动创建的那个备份的唯一标识符。等待一段时间直到恢复完成，在终端你会看到如下提示信息：

Restore completed successfully.

最后检查一下被删除的文件是否已经被还原回来：

cat ~/myproject/testfile.txt

如果一切正常的话，你应该能看到之前写入的内容：“This is a test file.”。

常见问题与排查建议

• 无法找到 config.yaml 文件？

  确认你在正确的用户主目录下寻找该文件。如果没有找到，请尝试重新初始化 OpenShip 或者查阅官方文档获取更多帮助。

• cron 表达式设置错误导致没有按时执行？

  可以借助在线工具如 crontab.guru 来验证和调整你的 cron 表达式格式是否正确无误。

• 恢复过程中出现权限不足的问题？

  尝试切换到 root 用户或者赋予目标目录适当的读写权限后再进行恢复操作。

• 找不到指定 ID 的备份记录？

  使用命令 openship backup list 查看所有可用的历史备份列表，并核对想要恢复的具体 ID 是否准确无误。

示例场景

想象一下你现在正在维护一家电商网站的应用程序。由于业务需求不断变化和技术更新迭代频繁，在日常工作中难免会出现各种意外状况导致现有系统中的某些重要资源遭到破坏或遗失。有了上述介绍的功能支持之后，在面对此类紧急情况时就可以从容应对了——只需根据实际情况选择合适的时机触发一次完整的数据快照存档；当后续发现部分关键组件发生故障时，则可以迅速地基于最新的可靠副本将其状态予以重建从而恢复正常运营秩序。

本章小结

• 我们学习了如何在 OpenShip 中启用并配置定时自动化的数据备份策略；
• 掌握了如何手动创建以及列出所有的历史备份数目；
• 对于可能出现的各种异常情况提前做好了预防措施，并掌握了对应的解决办法；
• 最后通过一个贴近实际应用的例子加深了对整个流程的理解和运用能力。

本章我们要解决的问题是如何在 OpenShip 中设置和查看实时监控数据，同时管理应用程序的日志。完成这些任务后，你可以更好地跟踪项目的健康状况和性能表现，及时发现和解决问题。

前置条件

• 已经安装并成功启动了 OpenShip 服务。
• 至少有一个已部署的项目。

第一步：启用实时监控

首先，我们需要确保 OpenShip 的监控功能已经开启。默认情况下，OpenShip 应该会自动收集一些基本的指标信息，但我们可以进一步配置以获取更多详细的数据。

我们先打开 Web 控制台（使用 openship open 命令），然后导航到“Settings”页面下的“Monitoring”选项卡。在这里你可以看到当前的监控设置。

启用高级监控

如果你希望启用更多的监控项，比如 CPU 使用率、内存使用量等，可以在相应的选项中勾选。点击保存按钮以应用更改。

第二步：查看实时监控数据

接下来，我们来查看这些监控数据。返回 Web 控制台主页，在左侧菜单栏找到“Monitoring”选项并点击进入。

你应该能看到一个仪表盘界面，默认显示了一些常见的系统指标图表。如果你想添加新的图表或修改现有的展示方式，请按照以下步骤操作：

1. 点击右上角的“Add Metric”按钮。
2. 在弹出的窗口中选择你需要监控的指标类型（例如 CPU 或 Memory）。
3. 配置好后点击确认按钮即可添加到仪表板上。

第三步：配置日志管理

除了实时监控外，日志也是诊断问题的重要工具。OpenShip 支持多种日志级别，并允许你将日志发送到不同的目的地（如文件、外部服务等）。

我们先回到 Web 控制台，在左侧菜单栏找到“Logs”选项并点击进入。这里列出了所有项目的日志记录情况。

设置日志级别

为了控制日志的数量和详细程度，我们可以为每个项目单独设置日志级别。点击某个项目的名称进入详情页，在“Log Level”下拉菜单中选择合适的级别（Debug, Info, Warn, Error）。

导出日志

如果需要分析过去一段时间内的日志记录，可以使用导出功能：

1. 在 Logs 页面顶部的时间筛选器中设定时间段。
2. 点击“Export Logs”按钮下载选定时间范围内的所有日志文件。

示例场景

假设你在维护一个在线论坛网站，并且最近注意到响应速度有所下降。通过 OpenShip 的实时监控面板，你可以快速定位到可能是由于内存使用过高引起的性能瓶颈。随后你检查了各个项目的日志记录，并找到了一些潜在的问题点——原来是某些后台任务消耗了大量的内存资源。于是你调整了相关任务的调度策略，并重新设置了较高的内存限制阈值来防止类似问题再次发生。

本章小结

• 我们学习了如何在 OpenShip 中启用和配置高级实时监控功能；
• 掌握了如何通过 Web 控制台查看详细的系统指标图表；
• 学习了如何根据需要调整不同项目的日志级别，并导出历史日志用于分析；
• 通过一个具体的案例展示了如何利用这些工具来诊断和解决实际问题中的性能瓶颈。

在云和自托管服务器上部署 OpenShip 可以让你灵活地选择最适合你的基础设施。无论你是想利用云服务提供商的强大功能，还是希望完全掌控自己的硬件资源，OpenShip 都能提供一致的操作体验。本章将指导你如何在这两种环境中成功部署 OpenShip。

前置条件

• 已经安装了 Node.js 和 npm。
• 如果打算使用 Docker，请确保已安装 Docker 和 Docker Compose。
• 对于自托管服务器，你需要一台运行 Linux 的机器，并有 root 或 sudo 权限。
• 了解基本的命令行操作。

第一步：在云平台上部署 OpenShip

我们将以 DigitalOcean 为例来演示如何在云端部署 OpenShip。DigitalOcean 提供了易于使用的界面和强大的虚拟机服务。

1. 登录到你的 DigitalOcean 账户并创建一个新的 Droplet（虚拟机实例）。

   • 选择 Ubuntu 最新 LTS 版本作为操作系统。
   • 根据需求选择合适的 CPU、RAM 和磁盘大小。
   • 添加 SSH 密钥以便安全登录。
   • 创建 Droplet 后，你会得到一个公网 IP 地址。

2. 使用 SSH 连接到你的 Droplet：

   ssh root@your_droplet_ip

3. 更新系统包列表并升级已安装的软件包：

   apt update && apt upgrade -y

4. 安装 Node.js 和 npm：

   curl -fsSL https://deb.nodesource.com/setup_18.x | bash -
   apt install nodejs npm -y

5. 全局安装 OpenShip：

   npm i -g openship

6. 启动 OpenShip 服务：

   openship up --foreground

   预期结果：你应该能看到 OpenShip 正在启动的日志信息，并最终显示服务已经成功运行的消息。

7. 打开浏览器访问 http://your_droplet_ip，你应该能够看到 OpenShip 的 Web 控制台登录页面。

第二步：在自托管服务器上部署 OpenShip

如果你有一个独立的物理服务器或者已经在使用的 VPS，可以按照以下步骤进行部署：

1. 确保服务器满足最低硬件要求（至少 2GB 内存和 20GB 存储空间）。

2. 使用 SSH 连接到你的服务器，并执行以下命令更新系统包列表和升级软件包：

   sudo apt update && sudo apt upgrade -y

3. 安装必要的依赖项（Node.js 和 npm）： （如果之前没有安装过）

   curl -fsSL https://deb.nodesource.com/setup_18.x | sudo bash -
   sudo apt install nodejs npm -y

4. 全局安装 OpenShip： （如果之前没有全局安装过）

   sudo npm i -g openship

5. 启动 OpenShip 服务： （可以选择前台模式查看日志）

   sudo openship up --foreground

6. 访问 http://your_server_ip 查看 Web 控制台登录页面。

示例场景

假设你是一家初创公司的开发者，正在开发一款新的移动应用后端服务。你决定首先在 DigitalOcean 上快速搭建一个测试环境来验证代码的功能是否正常。按照上述步骤，在 DigitalOcean 上创建了一个 Droplet 并成功部署了 OpenShip。然后你通过 Web 控制台上传了自己的项目代码，并进行了初次部署。一切顺利后，你又购买了一台高性能的物理服务器用于生产环境，并再次按照相同的流程完成了自托管服务器上的部署工作。这样就实现了从开发测试到生产的无缝切换。

本章小结

• 我们学习了如何在 DigitalOcean 上创建一个 Droplet 并在其上部署 OpenShip。
• 掌握了如何在自托管的 Linux 服务器上安装和启动 OpenShip。
• 理解了如何通过 Web 控制台管理和监控部署的应用程序。
• 通过一个具体案例展示了如何利用不同的基础设施来进行项目的开发和生产部署。

本章我们要学会使用 Docker 和 Docker Compose 来部署 OpenShip。通过这种方式，你可以更加灵活地管理你的开发和生产环境。假设你已经在一台服务器上安装好了 Docker 和 Docker Compose，并且有基本的使用经验。

前置条件

• 已经安装了 Docker 和 Docker Compose。
• 具备基本的 Git 操作能力。
• 有一台可以访问的服务器或者本地机器。

第一步：克隆 OpenShip 仓库

首先我们需要获取 OpenShip 的源码。打开终端并执行以下命令：

git clone https://github.com/oblien/openship.git && cd openship

这会下载整个 OpenShip 项目到你的当前目录下，并进入该目录。

第二步：复制环境变量文件

OpenShip 提供了一个 .env.example 文件作为模板，你需要根据实际情况修改它。运行下面的命令来复制这个文件：

cp .env.example .env

接下来编辑 .env 文件，设置必要的环境变量。比如数据库连接字符串、管理员密码等。如果你不确定某些值应该填什么，默认配置通常是可以工作的，但是为了安全起见，请至少更改默认密码。

第三步：启动 Docker 容器

一切准备就绪后，我们可以使用 Docker Compose 来启动所有需要的服务：

docker-compose up -d

这条命令会在后台启动所有定义在 docker-compose.yml 文件中的服务。如果一切顺利的话，你应该不会看到任何错误信息。

注意事项：

• 如果遇到权限问题，确保你的用户被添加到了 docker 组。
• 如果某些容器无法启动，可以通过 docker-compose logs <service_name> 来查看具体的错误日志。

第四步：验证部署是否成功

为了确认 OpenShip 是否正确部署并且可以正常使用，尝试访问它的 Web 控制台。打开浏览器并输入：

http://localhost:3000 

如果是远程服务器，请替换为实际的 IP 地址或域名，并确保防火墙允许 3000 端口的流量通过。

示例场景：

想象一下你现在是一名独立开发者，正在构建一个新的在线游戏服务。由于资源有限，你希望尽可能简化部署过程同时保证系统的稳定性和可扩展性。于是你选择了使用 Docker 和 Docker Compose 来部署 OpenShip 在自己的虚拟机上。按照上述步骤完成安装后，你可以在本地轻松地对游戏后端进行迭代和调试，并且随时将其推送到线上环境中进行测试。

本章小结

• 学习了如何通过克隆 GitHub 仓库获取 OpenShip 的源码。
• 掌握了如何复制和配置环境变量文件以适应不同的部署需求。
• 理解了如何使用 docker-compose up -d 命令来一键启动所有依赖服务。
• 能够检查并解决常见的部署过程中出现的问题。
• 通过一个具体场景展示了如何利用 Docker 和 Docker Compose 实现高效便捷的开发和测试流程。

本章我们要实现自动扩展和负载均衡，这样你的应用就能根据流量动态调整资源，提高性能和可靠性。完成这章后，你可以让 OpenShip 更好地应对不同规模的用户请求。

前置条件

• 已经成功部署了 OpenShip 并能正常访问 Web 控制台。
• 确保你的服务器有足够权限来配置网络设置和创建新的实例。
• 你需要有一个支持自动扩展的服务提供商（如 AWS EC2, GCP Compute Engine 或 Azure VM Scale Sets）。

步骤 1: 配置云服务提供商

首先，我们需要在云服务提供商那里创建一个虚拟机镜像（AMI 对于 AWS），这个镜像是基于你当前的 OpenShip 配置的。假设你使用的是 AWS EC2：

1. 登录到 AWS 控制台。
2. 导航到 EC2 服务页面。
3. 创建一个新的 AMI 从现有的实例或快照。

如果你使用其他云服务提供商，请参考相应文档来创建镜像。

步骤 2: 更新 OpenShip 配置

接下来，在你的 OpenShip 配置文件中添加自动扩展的相关配置。编辑 .env 文件，添加以下内容：

AUTO_SCALING_ENABLED=true
MIN_INSTANCES=1
MAX_INSTANCES=5
TARGET_CPU_UTILIZATION=70

这些配置项分别表示启用自动扩展、最小和最大实例数量以及目标 CPU 利用率。

步骤 3: 配置负载均衡器

大多数云服务提供商都提供负载均衡器功能。这里以 AWS Elastic Load Balancer (ELB) 为例：

1. 在 AWS 控制台中导航到 ELB 页面。
2. 创建一个新的 Application Load Balancer，并选择合适的 VPC 和子网。
3. 配置监听规则，默认监听 HTTP 流量并转发到你的目标组。
4. 创建一个新的 Target Group，并关联之前创建的 AMI 实例。

如果使用其他云服务提供商，请查阅相应的文档来设置负载均衡器。

步骤 4: 启动自动扩展组

最后，在云服务提供商中启动自动扩展组。继续以 AWS EC2 Auto Scaling Groups 为例：

1. 在 AWS 控制台中导航到 Auto Scaling 页面。
2. 创建一个新的 Auto Scaling Group，并选择之前创建的 AMI 和负载均衡器作为目标组。
3. 设置所需的缩放策略，例如基于 CPU 使用率或其他指标进行缩放。

如果你使用其他云服务提供商，请参考其文档来设置自动扩展组。

示例场景：

想象一下你现在是一家初创公司的技术负责人，正在为公司开发一款移动应用的后端服务。随着用户的增长，你需要确保后端能够处理更多的并发请求而不影响用户体验。因此，你决定利用 OpenShip 的自动扩展和负载均衡功能来优化系统架构。按照上述步骤配置好之后，当用户流量增加时，OpenShip 将会自动增加更多的计算资源，并通过负载均衡将请求分发到各个实例上，从而提升整体系统的响应速度和服务质量。

本章小结

• 学习了如何在云服务提供商中配置虚拟机镜像以便用于自动扩展。
• 更新了 OpenShip 的配置文件以启用和设置自动扩展参数。
• 配置了一个负载均衡器来分配传入流量至多个实例之间。
• 启动了一个自动扩展组以根据需求动态调整计算资源的数量。

本章我们要实现通过集成 REST API 和 MCP 来自动化你的部署流程。完成这些步骤后，你可以编写脚本或程序，让 OpenShip 自动执行一系列任务，比如构建、测试和部署应用程序。

为了顺利进行本章的操作，你需要确保以下几点：

• 已经安装并启动了 OpenShip 服务。
• 对基本的 REST API 概念有所了解。
• 具备一定的编程能力，熟悉至少一种编程语言（如 Python 或 JavaScript）。

第一步：获取 API 访问令牌

首先，我们需要生成一个 API 访问令牌，以便我们的脚本能安全地与 OpenShip 进行通信。

1. 打开 OpenShip 的 Web 控制台。
2. 导航到“账户设置”页面。
3. 在“API 访问令牌”部分点击“生成新令牌”按钮。
4. 输入令牌名称并勾选所需的权限范围（建议选择所有权限以方便演示）。
5. 点击“创建”，然后复制生成的访问令牌。

这个访问令牌非常重要，请妥善保管并且不要泄露给他人。

第二步：理解基本的 REST API 请求

OpenShip 提供了一套丰富的 REST API 接口来管理各种资源。下面是一个简单的例子，展示如何使用 curl 命令来列出所有的项目：

curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://your-openship-instance.com/api/projects

在这个命令中：

• -H "Authorization: Bearer YOUR_ACCESS_TOKEN" 是用来传递认证信息的头部字段。
• https://your-openship-instance.com/api/projects 是你要请求的具体 API 地址。

预期结果是你应该会看到一个包含所有项目的 JSON 数据列表。如果出现错误信息，请检查你的访问令牌是否正确以及网络连接是否正常。

第三步：编写一个简单的自动化脚本

假设你想自动化地创建一个新的项目。我们可以使用 Python 脚本来完成这个任务。首先确保你已经安装了 requests 库：

pip install requests

接下来编写如下 Python 脚本：

import requests

# 替换为你的实际值
base_url = 'https://your-openship-instance.com'
access_token = 'YOUR_ACCESS_TOKEN'

headers = {
    'Authorization': f'Bearer {access_token}',
    'Content-Type': 'application/json',
}

data = {
    'name': 'MyNewProject',
    # 可以添加更多参数来定义项目属性
}

response = requests.post(f'{base_url}/api/projects', headers=headers, json=data)

if response.status_code == 201:
    print('项目已成功创建:', response.json())
else:
    print('创建失败:', response.text)

这段代码的作用是向 OpenShip 发送一个 POST 请求以创建新的项目，并打印出返回的结果。请注意替换 base_url 和 access_token 为你自己的值。

第四步：集成 MCP 协议（可选）

MCP 是 OpenShip 提供的一种协议，允许外部 AI 助手与平台进行交互。虽然这不是必需的步骤，但对于高级用户来说非常有用。这里我们简单介绍如何调用 MCP 接口的一个方法：

假设你想查询某个项目的详细信息，可以使用以下命令：

curl -X GET -H "Authorization: Bearer YOUR_ACCESS_TOKEN" https://your-openship-instance.com/mcp/project/info?project_id=PROJECT_ID

这里的 PROJECT_ID 是你想要查询的具体项目的 ID。同样，请确保替换 URL 中的相关变量为你自己的值。

示例场景：

想象你现在是一名 DevOps 工程师，在一家快速发展的科技公司工作。每天都要手动处理大量的部署任务不仅耗时而且容易出错。于是你决定利用 OpenShip 的 REST API 和 MCP 协议来简化工作流程。通过编写脚本和程序，你可以让 OpenShip 自动完成大部分日常运维任务，从而提高工作效率并减少人为错误的可能性。

本章小结

• 学习了如何生成和使用 API 访问令牌来进行身份验证。
• 掌握了如何通过 curl 命令发起基本的 REST API 请求。
• 编写了一个简单的 Python 脚本来自动化创建项目的过程。
• 介绍了如何调用 MCP 协议接口的方法及其应用场景。

本章要解决的问题是如何配置和管理一个多节点集群，以便更好地分担负载、提高系统的可靠性和性能。读完本章后，你将能够设置一个基本的多节点 OpenShip 集群，并学会如何管理和监控这些节点。

前置条件

• 你已经安装并成功运行了 OpenShip。
• 你需要至少两台 Linux 服务器（物理机或虚拟机均可），并且它们之间可以通过网络互相通信。
• 每台服务器都已正确安装 Docker 和 Docker Compose。

第一步：准备环境

首先，我们需要在所有节点上安装必要的软件。假设你已经在所有节点上安装了 Docker 和 Docker Compose，接下来我们需要克隆 OpenShip 的仓库到每个节点上。

git clone https://github.com/oblien/openship.git && cd openship

预期结果：OpenShip 代码库被成功克隆到当前目录下。

第二步：配置主节点

选择其中一台服务器作为主节点。编辑 .env 文件以适应你的环境需求。例如：

cp .env.example .env
nano .env

确保以下变量根据实际情况进行了修改：

• OPENSHIP_API_URL: 主节点的 API 地址。
• NODE_ROLE: 设置为 master 或 leader。

保存并退出编辑器。

第三步：启动主节点服务

使用 Docker Compose 启动主节点的服务。

docker-compose up -d

预期结果：主节点的所有服务都应该正常启动并在后台运行。

第四步：配置工作节点

对于其他的工作节点，重复上述的准备工作，但是这次需要将 .env 文件中的 NODE_ROLE 设置为 worker 或 slave，并且指定 MASTER_NODE_IP 为主节点的 IP 地址或者域名。

cp .env.example .env
nano .env

# 修改如下字段:
# NODE_ROLE=worker
# MASTER_NODE_IP=<master_node_ip_or_domain>

保存并退出编辑器。

然后启动工作节点的服务：

docker-compose up -d

预期结果：工作节点的所有服务都应该正常启动并在后台运行，并且连接到了主节点形成集群。

第五步：验证集群状态

登录到主节点的 Web 控制台（通常是 http://<master_node_ip>:8080），查看集群的状态页面。你应该能看到所有工作节点的信息以及它们的状态是否健康。

如果一切顺利的话，在控制台上应该会显示多个在线的工作节点，并且它们都处于活动状态。如果有任何问题，请检查各个服务的日志文件以获取更多信息。

docker-compose logs -f <service_name>

常见问题与排查办法：

• 如果无法访问 Web 控制台，请确认防火墙设置允许相应的端口流量。
• 如果工作节点没有出现在集群列表中，请检查日志文件寻找错误信息，并确保所有配置项都正确无误。
• 如果遇到权限问题，请确保用于通信的身份验证令牌是正确的并且具有适当的权限级别。

示例场景：

假设你现在是一家初创公司的 CTO，随着业务的增长，现有的单机部署方式已经无法满足日益增长的需求。为了保证系统的稳定性和响应速度，你需要搭建一个多节点的 OpenShip 集群来分散负载。通过本章的学习，你成功地在三台服务器上设置了 OpenShip 集群，并将其用于生产环境中。这样不仅提高了系统的处理能力和服务质量，还增强了系统的容错能力和维护效率。

本章小结

• 准备了多台 Linux 服务器作为集群的基础硬件资源。
• 在每个服务器上安装了必要的软件并克隆了 OpenShip 的代码库。
• 配置了一个主节点和若干个工作节点，并使用 Docker Compose 启动了相关的服务。
• 验证了集群的状态并通过 Web 控制台监控整个集群的健康状况。

本章要解决的是如何进一步提升 OpenShip 的监控功能，并优化 CI/CD 流程，从而更好地管理和维护你的应用。通过学习本章的内容，你可以实现对集群的全面监控，并建立高效的持续集成和持续交付流程。

前置条件

• 你已经在多台服务器上成功部署了 OpenShip 集群，并且这些节点都在正常运行。
• 你熟悉基本的 Docker 和 Docker Compose 操作。
• 你有一个可以用来测试 CI/CD 流程的 Git 仓库。

第一步：增强实时监控功能

OpenShip 提供了丰富的监控指标，我们可以利用 Grafana 来可视化这些数据。首先，我们需要在主节点上安装 Grafana 和 Prometheus。

1. 安装 Prometheus

   docker-compose up -d prometheus

   这将会下载并启动 Prometheus 容器。Prometheus 是一个开源的系统和服务监控系统，能够抓取和存储时间序列数据。

2. 安装 Grafana

   docker-compose up -d grafana

   同样地，这会启动 Grafana 容器。Grafana 是一个开源的数据可视化和分析平台，可以与 Prometheus 结合使用来创建复杂的仪表盘。

3. 配置 Grafana 数据源 打开浏览器，访问 http://<your_server_ip>:3000，默认用户名和密码都是 admin。登录后，在左侧菜单点击 "Configuration" -> "Data Sources" -> "Add data source"，选择 Prometheus，并填写 URL 为 http://prometheus:9090。保存配置后，Prometheus 就会被添加为 Grafana 的数据源。

4. 导入预定义的仪表盘 我们可以从 Grafana 社区导入一些预定义的仪表盘来快速查看集群的状态。

   • 在左侧菜单点击 "Create" -> "Import"
   • 输入某个仪表盘 ID（例如 12345），然后点击 "Load"
   • 确保选择了正确的数据源 (Prometheus)，最后点击 "Import"

第二步：优化 CI/CD 流程

为了提高开发效率和减少人为错误，我们需要设置一套完整的 CI/CD 流程。这里我们使用 Jenkins 来构建我们的项目，并将构建后的镜像推送到 Docker Hub 上。

1. 安装 Jenkins

   docker-compose up -d jenkins

   这将启动 Jenkins 容器。Jenkins 是一个流行的自动化服务器，支持多种插件来实现各种任务自动化。

2. 配置 Jenkins 访问 http://<your_server_ip>:8080 来完成初始设置。按照屏幕上的指示解锁 Jenkins 并安装推荐的插件。

3. 创建一个新的 Job

   • 登录到 Jenkins 后，在首页点击 “New Item” 创建一个新的自由风格 Job。
   • 填写名称并勾选 “Freestyle project”，然后点击 OK。

4. 配置 Source Code Management

   • 在 Job 配置页面找到 “Source Code Management” 部分。
   • 选择 Git 并输入你的仓库地址以及认证凭据（如果需要的话）。

5. 添加 Build 步骤

   • 找到 “Build” 部分并点击 “Add build step” 添加一个执行 Shell 脚本的任务。
   • 输入以下脚本来构建你的项目并将镜像推送到 Docker Hub:

     #!/bin/bash
     
     # 构建 Docker 镜像
     docker build --no-cache=true -t your_dockerhub_username/your_image_name:$BUILD_NUMBER .
     
     # 推送镜像到 Docker Hub
     echo $DOCKER_HUB_PASSWORD | docker login --username $DOCKER_HUB_USERNAME --password-stdin 
     docker push your_dockerhub_username/your_image_name:$BUILD_NUMBER

6. 保存并触发构建

   • 点击 Save 保存配置。
   • 回到 Job 主页点击 Build Now 手动触发一次构建过程以测试是否一切正常。

示例场景：

假设你是一名 DevOps 工程师，在一家快速增长的技术公司负责运维工作。随着团队规模扩大和技术栈复杂度增加，手动管理基础设施变得越来越困难。通过本章的学习，你在 OpenShip 中集成了强大的监控工具如 Grafana 和 Prometheus，并引入了 Jenkins 来自动化项目的构建和部署流程。这使得整个开发周期更加高效可靠，并显著减少了因人为失误导致的服务中断情况。

本章小结

• 成功部署了 Grafana 和 Prometheus 组件，并通过 Grafana 可视化集群的各项指标。
• 配置了 Jenkins 自动化流水线，实现了从代码提交到容器推送的一站式服务。
• 学习到了如何利用这些工具来提高系统的稳定性和开发效率。

安装时报错：npm i -g openship 失败

解答：请确保你的 Node.js 和 npm 版本是最新的。你可以通过以下命令更新它们：

npm install -g npm@latest

如果仍然失败，请检查网络连接是否正常，并尝试使用 curl 方法进行安装：

curl -fsSL https://get.openship.io | sh

环境和依赖问题：如何解决缺少某些依赖的问题？

解答：在使用 Docker 进行安装时，确保你已经正确设置了 .env 文件中的所有必要变量。可以参考 .env.example 文件来创建自己的配置文件。

如果你是通过 npm 安装的，可能需要手动安装一些全局依赖项。例如，确保已安装 Docker 并且正在运行：

sudo apt-get update && sudo apt-get install docker-ce docker-ce-cli containerd.io
sudo systemctl start docker
sudo systemctl enable docker

配置问题：如何自定义域名和 SSL 设置？

解答：在 OpenShip 中，默认会自动处理 Let's Encrypt 的证书申请和续订过程。如果你想自定义这些设置，可以在项目的配置文件中进行调整。具体步骤如下：

1. 在项目根目录下找到或创建一个配置文件（如 openship.config.js）。
2. 按照文档说明添加自定义的域名和 SSL 相关配置。

示例配置：

module.exports = {
  domains: ['yourdomain.com'],
  ssl: {
    provider: 'letsencrypt',
    email: 'your-email@example.com'
  }
}

使用误区：为什么部署后无法访问我的应用？

解答：首先确认你的应用是否成功构建并启动了容器服务。可以通过以下命令查看日志信息以排查问题：

openship logs <project-name>

其次，请检查防火墙设置以及端口映射是否正确无误。

最后，确保 DNS 记录指向正确的服务器 IP 地址，并且等待一段时间让 DNS 生效。

如何与同类产品（如 Vercel 或 Netlify）相比？

解答：OpenShip 提供了一个开源且可自我托管的解决方案，适合希望拥有更多控制权的企业用户或开发者团队。它内置了 CI/CD 功能，并支持多种编程语言和技术栈。

相比之下，Vercel 和 Netlify 主要作为云服务提供商而存在，提供了更丰富的集成功能和服务选项，但通常需要支付费用才能获得高级特性支持。

选择哪个平台取决于你的具体需求、预算以及对控制权的要求等因素。

我应该如何贡献代码到 OpenShip 项目？

解答：欢迎参与 OpenShip 的开发！你可以按照以下步骤提交代码贡献：

1. Fork 仓库并在本地克隆副本。
2. 创建一个新的分支用于开发新功能或修复 bug。
3. 编写代码并进行测试。
4. 将更改推送到远程仓库，并发起 Pull Request 到原项目。
5. 团队成员将审核你的 PR，并提供反馈意见。

详细流程可以参考 CONTRIBUTING.md 文件中的指导内容。