# vibe

> VIBE AI 编程沙箱配置模板，集成 Code-Server、JupyterLab、Claude Code、Codex CLI 与 JuiceFS 的 Web 开发环境

---

LLMS 索引： [llms.txt](/zh/llms.txt)

---

`vibe` 配置模板提供了一个开箱即用的 **AI 编程沙箱**，集成了 Code-Server（Web VS Code）、JupyterLab、Claude Code 可观测能力、Codex CLI、JuiceFS 分布式文件系统，以及功能丰富的 PostgreSQL 数据库。


--------

## 配置概览

- 配置名称： `vibe`
- 节点数量： 单节点
- 配置说明：VIBE AI 编程沙箱，Code-Server + JupyterLab + Claude Code + Codex CLI + JuiceFS + PostgreSQL
- 适用系统：`el8`, `el9`, `el10`, `d12`, `d13`, `u22`, `u24`, `u26`
- 适用架构：`x86_64`, `aarch64`
- 相关配置：[`meta`](/docs/conf/meta/)

启用方式：

```bash
./configure -c vibe [-i <primary_ip>]
```


--------

## 配置内容

源文件地址：[`pigsty/conf/vibe.yml`](https://github.com/pgsty/pigsty/blob/main/conf/vibe.yml)

```yaml
---
#==============================================================#
# File      :   vibe.yml
# Desc      :   Pigsty ai vibe coding sandbox
# Ctime     :   2026-01-19
# Mtime     :   2026-06-28
# Docs      :   https://pigsty.io/docs/conf/vibe
# License   :   Apache-2.0 @ https://pigsty.io/docs/about/license/
# Copyright :   2018-2026  Ruohang Feng / Vonng (rh@vonng.com)
#==============================================================#

# VIBE CODING SANDBOX
# PostgreSQL with related extensions
# Code-Server, Jupyter, Claude Code, optional Codex CLI
#
# Usage:
#   curl https://repo.pigsty.io/get | bash
#   ./configure -c vibe
#   ./deploy.yml
#   ./juice.yml     # pgfs: juicefs on pgsql, mount on /fs
#   ./vibe.yml      # code-server, jupyter, claude-code, and codex cli

all:
  children:
    infra: { hosts: { 10.10.10.10: { infra_seq: 1 }} ,vars: { repo_enabled: false }}
    etcd:  { hosts: { 10.10.10.10: { etcd_seq: 1  }} ,vars: { etcd_cluster: etcd  }}
    pgsql: { hosts: { 10.10.10.10: { pg_seq: 1, pg_role: primary } } ,vars: { pg_cluster: pgsql }}

    # optional modules
    #minio: { hosts: { 10.10.10.10: { minio_seq: 1 }} ,vars: { minio_cluster: minio }}
    #redis-ms:
    #  hosts: { 10.10.10.10: { redis_node: 1 , redis_instances: { 6379: { }, 6380: { replica_of: '10.10.10.10 6379' } } } }
    #  vars: { redis_cluster: redis-ms ,redis_password: 'redis.ms' ,redis_max_memory: 64MB }

  vars:
    #----------------------------------------------#
    # INFRA: https://pigsty.io/docs/infra
    #----------------------------------------------#
    version: v4.5.0                     # pigsty version string
    admin_ip: 10.10.10.10               # admin node ip address
    region: default                     # upstream mirror region: default,china,europe
    infra_portal:                       # infra services exposed via portal
      home : { domain: i.pigsty }       # default domain name
    dns_enabled: false                  # disable dns service
    #blackbox_enabled: false            # disable blackbox exporter
    #alertmanager_enabled: false        # disable alertmanager
    infra_extra_services:               # home page navigation entries
      - { name: Code Server  ,url: '/code'             ,desc: 'VS Code Server'       ,icon: 'code'     }
      - { name: Jupyter      ,url: '/jupyter'          ,desc: 'Jupyter Notebook'     ,icon: 'jupyter'  }
      - { name: Claude Code  ,url: '/ui/d/claude-code' ,desc: 'Claude Observability' ,icon: 'claude'   }

    #----------------------------------------------#
    # NODE: https://pigsty.io/docs/node
    #----------------------------------------------#
    nodename_overwrite: false           # do not overwrite node hostname on single node mode
    node_tune: oltp                     # node tuning specs: oltp,olap,tiny,crit
    node_dns_method: none               # do not setup dns
    node_repo_modules: node,infra,pgsql # add these repos directly to the singleton node
    node_packages: [ openssh-server, juicefs, restic, rclone, uv, opencode, golang, asciinema, tmux ]
    docker_enabled: true                # enable docker service
    node_firewall_mode: zone            # default: trust intranet, expose selected public ports
    node_firewall_public_port: [22, 80, 443, 5432]    # expose 5432 for remote access, remove in production!
    #docker_registry_mirrors: ["https://docker.1panel.live","https://docker.1ms.run","https://docker.xuanyuan.me","https://registry-1.docker.io"]

    #----------------------------------------------#
    # PGSQL: https://pigsty.io/docs/pgsql
    #----------------------------------------------#
    pg_version: 18                      # Default PostgreSQL Major Version is 18
    pg_conf: oltp.yml                   # pgsql tuning specs: {oltp,olap,tiny,crit}.yml
    pg_packages: [ pgsql-main, patroni, pgbackrest, pg-exporter, pgbackrest-exporter ]
    pg_extensions: [ pg18-main ,pg18-time ,pg18-gis ,pg18-rag ,pg18-fts ,pg18-olap ,pg18-feat ,pg18-lang ,pg18-type ,pg18-util ,pg18-func ,pg18-admin ,pg18-stat ,pg18-sec ,pg18-fdw ,pg18-sim ,pg18-etl]
    pg_users:
      - { name: dbuser_meta ,password: DBUser.Meta   ,pgbouncer: true ,roles: [dbrole_admin   ] ,comment: pigsty admin user }
      - { name: dbuser_view ,password: DBUser.Viewer ,pgbouncer: true ,roles: [dbrole_readonly] ,comment: read-only viewer  }
    pg_databases:
      - { name: meta, baseline: cmdb.sql ,comment: pigsty meta database ,schemas: [pigsty] ,extensions: [ postgis, timescaledb, vector, age ]}
    pg_libs: 'timescaledb, pg_stat_statements, auto_explain, pg_wait_sampling'
    pg_hba_rules:
      - { user: all ,db: all ,addr: intra ,auth: pwd ,title: 'everyone intranet access with password' ,order: 800 }
      # WARNING: devbox only. Remove world access in production.
      - { user: all ,db: all ,addr: world ,auth: pwd ,title: 'everyone world access with password'    ,order: 900 }
    pg_crontab: [ '00 01 * * * /pg/bin/pg-backup full' ] # make a full backup every 1am
    patroni_mode: remove                # remove patroni after deployment
    pgbouncer_enabled: false            # disable pgbouncer pool
    pgbouncer_exporter_enabled: false   # disable pgbouncer_exporter on pgsql hosts?
    pgbackrest_exporter_enabled: false  # disable pgbackrest_exporter
    pg_default_services: []             # do not provision pg services
    #pg_reload: false                   # do not reload patroni/service

    #----------------------------------------------#
    # PASSWORD : https://pigsty.io/docs/setup/security/
    #----------------------------------------------#
    grafana_admin_password: pigsty
    grafana_view_password: DBUser.Viewer
    pg_admin_password: DBUser.DBA
    pg_monitor_password: DBUser.Monitor
    pg_replication_password: DBUser.Replicator
    patroni_password: Patroni.API
    haproxy_admin_password: pigsty

    #----------------------------------------------#
    # OPTIONAL VIBE COMPONENTS
    #----------------------------------------------#
    code_enabled: true                # install & enable code-server via vibe role
    code_password: DBUser.Meta
    jupyter_enabled: true             # enable jupyter (disabled by default, enable for vibe sandbox)
    jupyter_password: DBUser.Meta
    juice_instances:
      jfs:
        path  : /fs
        meta  : postgres://dbuser_meta:DBUser.Meta@10.10.10.10:5432/meta
        data  : --storage postgres --bucket 10.10.10.10:5432/meta --access-key dbuser_meta --secret-key DBUser.Meta
        port  : 9567

    # Claude Code is the default coding agent. Node.js is installed on demand when agents are enabled.
    nodejs_enabled: true              # standalone nodejs runtime
    npm_packages: []                  # extra global npm packages
    codex_enabled: true
    claude_enabled: true
    #claude_env:                      # use 3rd party Anthropic-compatible API service
    #  ANTHROPIC_BASE_URL: https://open.bigmodel.cn/api/anthropic
    #  ANTHROPIC_API_URL: https://open.bigmodel.cn/api/anthropic
    #  ANTHROPIC_AUTH_TOKEN: your_api_service_token
    #  ANTHROPIC_DEFAULT_OPUS_MODEL: "glm-5.2[1m]"
    #  ANTHROPIC_DEFAULT_SONNET_MODEL: "glm-5.2[1m]"
    #  ANTHROPIC_DEFAULT_HAIKU_MODEL: "glm-4.7"
    #  CLAUDE_CODE_AUTO_COMPACT_WINDOW: "1000000"

...
```


--------

## 配置解读

`vibe` 模板是一个面向 **AI 时代的 Web 编程沙箱**，让您可以在浏览器中完成开发、数据分析、AI 应用构建等任务。

**核心组件**：

| 组件                | 说明                                      | 访问方式                  |
|-------------------|-----------------------------------------|-----------------------|
| **Code-Server**   | VS Code 的 Web 版本，功能完整的代码编辑器             | `http://<ip>/code`    |
| **JupyterLab**    | 交互式数据科学笔记本，支持 Python/SQL                | `http://<ip>/jupyter` |
| **Claude Code**   | AI 编程助手运行环境与可观测性入口（可通过 `claude_env` 定制） | 终端 / 仪表盘              |
| **Codex CLI**     | OpenAI 代理编程 CLI；VIBE 只负责安装，不托管配置        | 终端                    |
| **JuiceFS**       | 基于 PostgreSQL 的分布式文件系统                  | 挂载点 `/fs`             |
| **PostgreSQL 18** | 功能丰富的数据库，安装 `pg18-main` + 全类别扩展包组       | `5432` 端口             |

**模板显式安装的节点工具**（`node_packages`）：

- `openssh-server`, `juicefs`, `restic`, `rclone`
- `uv`, `opencode`, `golang`
- `asciinema`, `tmux`

**PostgreSQL 扩展**：

此模板通过分类包组安装 PostgreSQL 18 的完整扩展集合：

```text
pg18-main, pg18-time, pg18-gis, pg18-rag, pg18-fts, pg18-olap,
pg18-feat, pg18-lang, pg18-type, pg18-util, pg18-func, pg18-admin,
pg18-stat, pg18-sec, pg18-fdw, pg18-sim, pg18-etl
```

`meta` 业务库默认创建扩展为 `postgis`、`timescaledb`、`vector`，其余扩展可按需启用。


--------

## VIBE 模块组件

提供 AI 编程沙箱能力；`vibe.yml` 显式开启 Code-Server 与 Jupyter，默认安装 Claude Code 与 Codex CLI。

**Code-Server**：浏览器中的 VS Code

- 完整的 VS Code 功能，支持扩展安装
- 通过 Nginx 反向代理提供 HTTPS 访问
- 支持 Open VSX 和 Microsoft 扩展商店
- 模板显式参数：`code_enabled`, `code_password`
- 其余可选参数：`code_port`, `code_data`, `code_gallery`

**JupyterLab**：交互式计算环境

- 支持 Python/SQL/Markdown 笔记本
- 预配置 Python venv 数据科学库
- 通过 Nginx 反向代理提供 HTTPS 访问
- 模板显式参数：`jupyter_enabled`, `jupyter_password`
- 其余可选参数：`jupyter_port`, `jupyter_data`, `jupyter_venv`

**Claude Code**：AI 编程助手

- 使用模块默认行为完成 Claude 运行环境配置
- 可通过 `claude_env` 覆盖模型端点与 API 密钥
- 提供 `claude-code` 仪表盘监控使用情况

**Codex CLI**：AI 编程助手

- 由 `codex_enabled` 控制，默认启用
- VIBE 仅安装 `@openai/codex`，不写入 Codex 配置，也不接入 Claude Code 仪表盘


--------

## JuiceFS 文件系统

此模板使用 **JuiceFS** 提供分布式文件系统能力，特别之处在于：**元数据和数据都存储在 PostgreSQL 中**。

**架构特点**：

- **元数据引擎**：使用 PostgreSQL 存储文件系统元数据
- **数据存储**：使用 PostgreSQL 大对象（Large Object）存储文件数据
- **挂载点**：默认挂载到 `/fs` 目录（由 `juice_instances.jfs.path` 控制）
- **监控端口**：`9567` 提供 Prometheus 指标

**使用场景**：

- 代码项目的持久化存储
- Jupyter Notebook 的工作目录
- AI 模型和数据集的存储
- 多实例间的文件共享（扩展到多节点时）

**配置示例**：

```yaml
juice_instances:
  jfs:
    path  : /fs
    meta  : postgres://dbuser_meta:DBUser.Meta@10.10.10.10:5432/meta
    data  : --storage postgres --bucket 10.10.10.10:5432/meta --access-key dbuser_meta --secret-key DBUser.Meta
    port  : 9567
```


--------

## 部署步骤

```bash
# 1. 下载 Pigsty
curl -fsSL https://repo.pigsty.cc/get | bash; cd ~/pigsty

# 2. 使用 vibe 配置模板
./configure -c vibe

# 3. 修改密码（重要！）
vi pigsty.yml
# 修改 code_password、jupyter_password、数据库与基础设施默认密码

# 4. 部署基础设施和 PostgreSQL
./deploy.yml

# 5. 可选：部署 JuiceFS 文件系统
./juice.yml -l 10.10.10.10

# 6. 部署 VIBE 模块（Code-Server、JupyterLab、Claude Code、Codex CLI）
./vibe.yml -l 10.10.10.10
```


--------

## 访问方式

部署完成后，通过浏览器访问：

```bash
# Code-Server（VS Code Web）
https://<domain>/code/
# 使用已轮换的 code_password

# JupyterLab
https://<domain>/jupyter/
# 使用已轮换的 jupyter_password Token

# Claude Code 仪表盘
https://<domain>/ui/d/claude-code
# 使用已轮换的 Grafana 管理凭据

# PostgreSQL
psql 'host=<ip> port=5432 dbname=meta user=dbuser_meta sslmode=require'
```


--------

## 适用场景

- **AI 应用开发**：构建 RAG、Agent、LLM 应用
- **数据科学**：使用 JupyterLab 进行数据分析和可视化
- **远程开发**：在云服务器上搭建 Web IDE 环境
- **教学演示**：提供一致的开发环境供学员使用
- **快速原型**：快速验证想法，无需配置本地环境
- **Claude Code 可观测性**：监控 AI 编程助手的使用情况


--------

## 注意事项

- **必须修改密码**：`code_password` 和 `jupyter_password` 默认值仅供测试
- **Jupyter 安全边界**：模板监听 `0.0.0.0:8888`、允许任意 Origin、关闭 XSRF 校验，默认只依靠 Token；必须限制端口与门户来源，不得直接暴露公网
- **网络安全**：此模板默认开放 `5432`（`node_firewall_public_port`）且包含 `addr: world` HBA 规则，生产环境请删除这些公网入口，并在需要时为门户增加 Basic Auth
- **资源需求**：建议至少 2 核 4GB 内存，SSD 磁盘
- **精简架构**：此模板禁用了 Patroni、PgBouncer 等高可用组件，适合单节点开发环境
- **Claude API**：使用 Claude Code 需要配置 `claude_env` 中的 API 密钥
