ServerPrism 应用程序入门指南

本指南将引导您在 ServerPrism 服务器上设置和配置您选择的自托管应用程序（5e Tools、Owncast、Rathole 或 Yarr）。它涵盖了订购、初始设置、配置和常见问题。

开始之前

确保您拥有一个 ServerPrism 账户，并准备好部署新服务器，或已有一个“应用程序”服务器可供配置。

在 ServerPrism 上订购

1. 选择套餐：登录 ServerPrism 并选择一个“应用程序”服务器。我们建议至少从 2 GB RAM 开始，对于要求更高的应用程序或更高的用户负载，可扩展到 12 GB。
2. 选择区域：选择离您的主要用户最近的服务器位置，以获得最佳性能。
3. 部署：完成订单。您的服务器将自动开始配置。

首次启动

订购后，您的服务器将开始配置。此过程通常需要几分钟。您可以通过 ServerPrism 面板 https://serverprism.com/dashboard 监控其状态。一旦服务器状态显示为“Running”并且您看到控制台输出表明应用程序已启动，它就准备好了。

连接/邀请用户

连接到您的应用程序的方法取决于您部署的是哪一个：

• 5e Tools：通过服务器的 IP 地址和端口访问您的实例（例如，http://YOUR_SERVER_IP:PORT）。Web 应用程序的默认端口通常是 80 或 8080。如果可配置，请检查 ServerPrism 面板中“Startup”选项卡下的 APP_PORT 变量。
• Owncast：您的 Owncast 实例将通过 http://YOUR_SERVER_IP:PORT 访问。Owncast 的默认端口是 8080。您还可以配置自定义域名或 ServerPrism 子域名以便于访问。
• Rathole：Rathole 是一个反向代理。连接涉及配置客户端通过 Rathole 连接到您的内部服务。这需要设置 Rathole 的 server.toml 和客户端配置。它没有直接的用户 Web 界面。
• Yarr：通过 http://YOUR_SERVER_IP:PORT 访问您的 Yarr 实例。默认端口通常是 8080。

为了方便访问，您可以从 ServerPrism 控制面板为您的服务器附加一个免费子域名。

配置基础知识

每个应用程序的配置通常通过 ServerPrism 面板的 Startup 选项卡中的环境变量完成，或者通过使用 File Manager 或 SFTP 编辑特定的配置文件。

5e Tools

• 数据存储：5e Tools 使用本地数据库。配置最少。如果需要，您通常可以在启动变量中找到与数据路径相关的设置。
• 访问：确保 Startup 选项卡中的 APP_PORT 变量与您尝试访问的端口匹配。

Owncast

• 配置文件：Owncast 主要使用位于应用程序数据目录中的 config.yaml。您可以通过 File Manager 编辑此文件。
• 管理员访问：首次访问 Owncast 时，系统会提示您创建管理员账户。您可以在此处设置您的流密钥和其他设置。
• 启动变量：检查 Startup 选项卡中的 OWNCAST_DATABASE_PATH、OWNCAST_DATA_PATH 或 OWNCAST_PORT 以自定义数据位置或监听端口。

Rathole

• 配置文件：Rathole 需要一个 server.toml 文件。此文件定义了监听端口和它将代理的服务。您必须编辑此文件才能使 Rathole 正常工作。
  • 示例 server.toml（通过 File Manager 编辑）：

  [server]
  bind_addr = "0.0.0.0:8000" # Server listening port
  
  [server.services.my_service]
  type = "tcp"
  token = "your_secret_token"
  bind_addr = "0.0.0.0:2222" # Port clients connect to
  remote_addr = "127.0.0.1:22" # Internal service Rathole forwards to
  

• 令牌：确保 server.toml 中的 token 与客户端的配置匹配，以实现安全连接。

Yarr

• 配置：Yarr 的配置通常通过环境变量或 config.json 文件进行管理。检查 Startup 选项卡中是否有 YARR_PORT、YARR_DATABASE_PATH 或 YARR_ADMIN_EMAIL 等变量。
• 初始设置：首次访问 Yarr 时，您可能需要通过初始设置向导来创建管理员用户并配置基本设置。

常见问题

1. 应用程序未启动：检查 ServerPrism 面板中的服务器控制台是否有错误消息。缺少配置文件、不正确的环境变量或端口冲突是常见原因。确保所有必需的文件都存在且格式正确。
2. 无法访问 Web 界面：
   • 验证应用程序正在运行并监听预期端口（例如 8080）。
   • 检查服务器的防火墙规则（ServerPrism 通常会处理此问题，但请确保您的应用程序没有尝试使用非标准阻塞端口）。
   • 确认您在浏览器中使用了正确的 IP 地址和端口。如果使用域名，请确保 DNS 正确指向您的服务器 IP。
3. Rathole 客户端无法连接：仔细检查 server.toml 中的 token 是否与客户端的配置匹配。确保 server.toml 中服务的 bind_addr 配置正确且可访问。
4. 性能缓慢：如果您的应用程序运行缓慢，请考虑升级您的服务器套餐以获得更多 RAM 或 CPU。您可以从 ServerPrism 客户控制面板执行此操作。

如果您遇到持续性问题，请收集您的服务器 ID 和控制台中的相关日志输出，并在 https://serverprism.com/tickets 提交支持工单。

后续步骤

• 自定义域名：为了更专业的设置，请从您的 ServerPrism 控制面板为您的应用程序附加自定义域名或免费的 ServerPrism 子域名。
• 运行时切换：如果您决定切换到不同的应用程序（例如，从 Owncast 切换到 Yarr），您可以通过 ServerPrism 面板中的 Startup 选项卡选择新的运行时轻松完成。这将使用新应用程序重新映像您的服务器。
• 高级配置：有关高级功能、集成和自定义选项，请参阅您所选应用程序的官方文档。