# vscode-web-linux

**Repository Path**: 457049726/vscode-web-linux

## Basic Information

- **Project Name**: vscode-web-linux
- **Description**: Linux版本VSCode Web服务器
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-02-21
- **Last Updated**: 2025-02-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# VSCode Web服务器

## 一、简介

​		基于[GitHub - coder/code-server: VS Code in the browser](https://github.com/coder/code-server)封装了启动方法，无需安装一键启动VSCode Web服务器。

## 二、目录构成

VSCode Web服务器的目录结构如下表所示：

| 名称        | 描述                                                         |
| ----------- | ------------------------------------------------------------ |
| code-server | VSCode Web服务器主体程序，基于[GitHub - coder/code-server: VS Code in the browser](https://github.com/coder/code-server)<br />(目前发布版本只有Linux版本，Windows版本有相关适配修改) |
| config      | 配置文件存放目录                                             |
| extensions  | vscode插件存放目录                                           |
| log         | 日志文件存放目录                                             |
| user        | 用户配置存放目录                                             |

VSCode Web服务器的树结构：

```shell
vscode-web
├── code-server                         # VSCode Web服务器主体程序
├── config                              # 配置文件存放目录
│   └── config.yaml                     # 配置文件
├── extensions                          # vscode插件存放目录
│   ├── .obsolete                       # 记录vscode插件那些需要删除状态文件
│   └── extensions.json                 # vscode插件配置文件
├── log                                 # 日志文件存放目录
├── user                                # 用户配置存放目录
├── .gitignore                          # 用来忽略哪些文件不被git管理的文件
├── README.md                           # 项目文档
├── StartCodeServer                     # 启动VSCode Web服务器sh脚本
├── StopCodeServer                      # 停止VSCode Web服务器sh脚本
└── vscode-web.service                  # VSCode Web服务器systemd配置文件格式
```

## 三、[config.yaml](config/config.yaml)配置文件说明

```yaml
bind-addr: 0.0.0.0:8080
auth: password
password: 123456
cert: false
```

| 对象      | 含义                                                         |
| --------- | ------------------------------------------------------------ |
| bind-addr | VSCode Web服务器绑定的IP和端口，格式: ip:port                |
| auth      | 默认password，不需要改动                                     |
| password  | VSCode Web服务器登录密码                                     |
| cert      | 是否启用https(false: 不启用、true:启用)，**注意：Windows版本不支持cert，所以不要配置为true，否则不能正常运行VSCode Web服务器** |

## 四、Linux系统开机自启动(依赖systemd)
### 1. [vscode-web.service](vscode-web.service)文件说明
```sh
[Unit]
Description=vscode-web.service

[Service]
Type=simple
User=work
Group=work
WorkingDirectory=/work/vscode-web
Restart=no
RemainAfterExit=yes
ExecStart=/work/vscode-web/StartCodeServer
ExecStop=/work/vscode-web/StopCodeServer

[Install]
WantedBy=multi-user.target
```

建议可修改配置内容(主要是[Service]小节)：

| 名称      | 说明                                                         |
| --------- | ------------------------------------------------------------ |
| User      | 用户名(Linux系统的用户名)，指定VSCode Web程序属于那个用户启动  |
| Group     | 用户组(Linux系统的用户组)，指定VSCode Web程序属于那个用户组启动 |
| WorkingDirectory | VSCode Web服务器存储绝对路径 |
| Restart | 服务进程退出、终止或超时后，是否重新启动服务 |
| RemainAfterExit | 当该服务的所有进程全部退出之后，是否依然将此服务视为活动(active)状态 |
| ExecStart | 服务进程启动脚本或程序 |
| ExecStop | 服务进程退出脚本或程序 |

### 2. 开启自启动VSCode Web服务器

```shell
# 拷贝[vscode-web.service](vscode-web.service)到/etc/systemd/system目录
$ cp vscode-web.service /etc/systemd/system
# 完成自启动设置
$ sudo systemctl daemon-reload
$ sudo systemctl enable vscode-web.service
```