76 lines
2.2 KiB
Markdown
76 lines
2.2 KiB
Markdown
# 荆棘鸟 Coder 开发环境模板
|
||
|
||
## 概述
|
||
|
||
这是一个基于 [Coder](https://coder.com/) 的开发环境模板，专为荆棘鸟文学社设计。该模板提供了一个预配置的 Node.js 开发环境，使开发者可以在任何设备上通过浏览器或远程 IDE 连接进行开发工作。
|
||
|
||
## 特性
|
||
|
||
- 基于 Docker 的隔离开发环境
|
||
- 预装 Node.js 20.x 和开发工具
|
||
- 自动配置 VS Code (code-server) 开发环境
|
||
- 自动生成 SSH 密钥对用于 Git 操作
|
||
- 持久化存储确保工作空间数据安全保存
|
||
- 系统资源监控仪表板
|
||
|
||
## 技术栈
|
||
|
||
- Node.js 20.x
|
||
- npm 最新版
|
||
- pnpm 包管理器
|
||
- Git 版本控制
|
||
- VS Code (通过 code-server)
|
||
|
||
## 预安装的 VS Code 扩展
|
||
|
||
- redhat.vscode-yaml：YAML 文件支持
|
||
- mhutchie.git-graph：Git 图形化界面
|
||
|
||
## 自动配置
|
||
|
||
工作区第一次启动时会自动完成以下配置：
|
||
|
||
1. 创建 SSH 密钥对，用于 Git 操作
|
||
2. 配置 SSH 连接到代码库服务器
|
||
3. 配置全局 Git 用户信息
|
||
|
||
## 使用方法
|
||
|
||
### 创建工作区
|
||
|
||
1. 登录到 Coder 平台
|
||
2. 选择此模板创建新工作区
|
||
3. 等待工作区启动完成
|
||
|
||
### 连接到工作区
|
||
|
||
可通过以下方式连接到工作区：
|
||
|
||
1. **浏览器访问** - 通过 Coder 界面打开内置 VS Code
|
||
2. **VS Code Remote** - 使用本地 VS Code 连接到远程工作区
|
||
3. **SSH 连接** - 使用终端直接 SSH 连接到工作区
|
||
|
||
### 项目目录结构
|
||
|
||
所有项目文件应存储在 `/home/coder/jingjiniao` 目录中，此目录会自动在 VS Code 中打开。
|
||
|
||
## 系统资源监控
|
||
|
||
工作区提供以下系统资源监控指标：
|
||
|
||
- CPU 使用率（容器内和宿主机）
|
||
- 内存使用情况（容器内和宿主机）
|
||
- 磁盘使用情况
|
||
- 宿主机负载平均值
|
||
- 宿主机交换内存使用情况
|
||
- Node.js 和 pnpm 版本信息
|
||
|
||
## 注意事项
|
||
|
||
- 工作区中的 `/home/coder` 目录是持久化的，数据会在工作区重启后保留
|
||
- 第一次启动会自动生成 SSH 密钥，密钥保存在 `~/.ssh/git` 文件中
|
||
- 公钥显示在首次启动日志中，可用于设置 Git 仓库访问权限
|
||
|
||
## 技术支持
|
||
|
||
如有任何问题或需要帮助，请联系管理员或参考 [Coder 官方文档](https://coder.com/docs)。 |