> For the complete documentation index, see [llms.txt](https://docs.checkcle.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.checkcle.io/checkcle-docs-zh/ru-men/quickstart.md).

# 快速入门

此快速安装允许您使用 Docker Compose 启动整个平台，因此仅需几分钟即可开始监控。它以最小的工作量设置 CheckCle 仪表板、后端服务和核心代理，无需复杂配置。

{% hint style="success" %}
🚀 CheckCle 已在真实监控场景中成功测试，处理了 70+ 的可用性检查、15 台服务器和 60 多个 SSL 证书——同时使用极少的 CPU 和内存。它已针对低资源环境进行了优化，仍能良好运行。
{% endhint %}

#### 🖥️ 系统要求

要顺利运行 CheckCle，请确保您的系统满足以下规格：

| 🔧 最低要求：                                                                                                                                                                                                                                                                                                             | ✅ 生产环境推荐：                                                                                                                                                                                                                                                                                      |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li><strong>CPU</strong>: 1 个虚拟 CPU</li><li><strong>内存</strong>: 500MB</li><li><strong>磁盘</strong>: 2 GB 可用存储</li><li><strong>操作系统</strong>: 在 Linux（Debian/Ubuntu/Alpine/CentOS）、macOS 或 Windows 上运行的 Docker </li><li><strong>Docker</strong>: v20.10+</li><li><strong>Docker Compose</strong>: v2.0+</li></ul> | <ul><li><strong>CPU</strong>: 2+ 个虚拟 CPU</li><li><strong>内存</strong>: 2–4 GB</li><li><strong>磁盘</strong>: SSD，10 GB 以上可用空间</li><li><strong>公网 IP</strong> （用于代理连接和外部访问）</li><li>私有 IP（如果您的所有应用和服务器都运行在同一网络中）</li><li><strong>TLS/SSL 证书</strong> 用于安全访问（例如，通过 NGINX + Let’s Encrypt）</li></ul> |

### 🚀 部署 &#x20;

{% stepper %}
{% step %}

### 部署 **CheckCle** 作为 Docker 容器

{% hint style="info" %}
您可以使用以下方法之一安装 CheckCle：
{% endhint %}

适用于生产环境或希望轻松管理多个容器的情况。只需创建一个 `docker-compose.yml` 文件并运行 `docker-compose up -d` 即可使用持久存储和可自定义设置启动 CheckCle。

{% tabs %}
{% tab title="Docker-Compose" %}

```yaml
# 创建 docker-compose.yml

version: '3.9'

services:
  checkcle:
    image: operacle/checkcle:latest
    container_name: checkcle
    restart: unless-stopped
    ports:
      - "8090:8090"  # Web 应用
    volumes:
      - /opt/pb_data:/mnt/pb_data  # 主机目录映射到容器路径
    ulimits:
      nofile:
        soft: 4096
        hard: 8192
```

{% endtab %}

{% tab title="Docker Run" %}

```yaml
# Docker 运行命令

docker run -d   --name checkcle   --restart unless-stopped   -p 8090:8090   -v /opt/pb_data:/mnt/pb_data   --ulimit nofile=4096:8192   operacle/checkcle:latest
```

{% endtab %}

{% tab title="一键安装" %}

```yaml
curl -fsSL https://checkcle.io/install.sh | bash
```

{% endtab %}
{% endtabs %}
{% endstep %}

{% step %}

### CheckCle 默认凭证&#x20;

* **用户名：** `admin@example.com`
* **密码：** `Admin123456`
  {% endstep %}

{% step %}

### 如何查看 CheckCle 容器日志

使用此命令查看 CheckCle 容器的实时日志，包括服务检查、错误和其他重要信息：

`docker logs -f checkcle`&#x20;

这可以让您监控代理的逻辑，检测任何错误，并在问题发生时进行故障排除。

<figure><img src="/files/58a8bca8701129d4237c69b6a8547e6e37563733" alt=""><figcaption></figcaption></figure>
{% endstep %}

{% step %}

### 🔒 重要：更改默认用户名和密码

{% hint style="success" %}
出于安全原因， **请在首次登录后立即更改默认凭证** 以防止未经授权的访问。
{% endhint %}

**设置强密码的建议：**

* 使用至少 8-12 个字符。
* 混合使用大写、小写、数字和符号。
* 避免常见词或容易被猜到的信息。
  {% endstep %}
  {% endstepper %}

### U**卸载 CheckCle 容器和镜像**

{% stepper %}
{% step %}

### &#x20;步骤 1：停止并移除 CheckCle 容器

`docker stop checkcle`\
`docker rm checkcle`
{% endstep %}

{% step %}

### 步骤 2：移除 CheckCle 镜像&#x20;

`docker rmi operacle/checkcle:latest`

如果您使用了不同的标签或版本，请相应地调整 `latest` 。
{% endstep %}

{% step %}

### 可选：移除相关卷（如果使用）

如果您挂载了本地文件夹（例如 `/mnt/pb_data`），您可以手动删除它们：

`rm -rf /mnt/pb_data`
{% endstep %}
{% endstepper %}

### ✅ 部署 CheckCle 的推荐提示

**1. 使用反向代理（Nginx / Caddy / Traefik）**

* 将流量干净地路由到 CheckCle 应用。
* 为 SSL、缓存和速率限制提供更好的控制。
* 示例：将流量从 `yourdomain.com` 转发到 `localhost:8090`

**2. 使用 HTTPS 运行**

* 始终使用 **SSL/TLS** 来保护您的仪表板和 API。
* 使用 **Let's Encrypt** 获取免费证书。
* 像 **Caddy** 或 **Certbot + Nginx** 这样的工具可以简化此操作。

**3. 启用基本认证或 IP 白名单（可选）**

* 在应用前端添加额外保护以进行设置。

**4. 使用 Docker 卷或绑定挂载**

* 在容器重启时保留 CheckCle 数据。
* 示例： `-v ./pb_data:/app/pb_data`

**5. 保护 API 端点（如果对外暴露）**

* 除非受到保护，否则避免将内部 API 暴露到互联网上。
* 使用防火墙规则或反向代理访问控制。

**6. 自动监控并重启**

* 使用 `restart: unless-stopped` 在 Docker 中或在 Kubernetes 中使用健康检查。
* 确保在发生故障时 CheckCle 能够保持运行。