diff --git a/README.md b/README.md index 72884555d3314d0cfa9286c08544e083b8e49604..69f5d34c0b76e16ec55dc32ab2c50e9d0ce6cad7 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,51 @@ -# 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)
(目前发布版本只有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 # 项目文档 -├── vscode-web.bat # 启动VSCode Web服务器bat脚本 -└── vscode-web.exe # 启动VSCode Web服务器程序(基于VSCode Web服务器bat脚本制作生成) -``` - -## 三、[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服务器** | - +# 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)
(目前发布版本只有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 # 项目文档 +├── vscode-web.bat # 启动VSCode Web服务器bat脚本 +└── vscode-web.exe # 启动VSCode Web服务器程序(基于VSCode Web服务器bat脚本制作生成) +``` + +## 三、`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服务器** | \ No newline at end of file