Skip to content

Commit 4d5152a

Browse files
committed
update readme
1 parent 4344009 commit 4d5152a

File tree

2 files changed

+6
-6
lines changed

2 files changed

+6
-6
lines changed

README-zh.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,19 +70,19 @@ git submodule update
7070

7171
`backend/src/main/resources/application.properties` 包括用户、项目、数据库等配置,可以通过修改配置定制服务:
7272

73-
* **SPACE_HOME:** 存放 workspace 的目录,默认为 ${"user.home"}/.workspace
73+
* **SPACE_HOME:** 存放 workspace 的目录,默认为 `~/.coding-ide/workspace`
7474
* **server.port:** 应用启动的端口
7575
* **USERNAME:** 用户名,git 提交时会使用该值作为 user.name,默认为 coding。
7676
* **EMAIL:** 用户邮箱,git 提交时会使用该值作为 user.email,默认为 coding@coding.net
7777
* **AVATAR:** 用户头像
78-
* **CODING_IDE_HOME:** 应用数据存放目录
78+
* **CODING_IDE_HOME:** 应用数据存放目录,默认为 `~/.coding-ide`
7979

8080
修改配置后,需要重启应用。另外如果修改了 `USERNAME``EMAIL` 的值,会在创建新的 Workspace 时生效。
8181

8282
## docker 版
8383

8484
```
85-
docker run -p 8080:8080 --name webide webide/webide
85+
docker run -p 8080:8080 -v coding-ide-home:/root/.coding-ide webide/webide
8686
```
8787

8888
更多 docker 命令,参照 wiki [English](https://github.com/Coding/WebIDE/wiki/Docker-Server.en) [中文](https://github.com/Coding/WebIDE/wiki/Docker-Server.zh)

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,20 +75,20 @@ Server runs on port 8080 by default, visit localhost:8080 to check it out.
7575

7676
`backend/src/main/resources/application.properties` contains configurations of user, project, database, etc., you can change these parameters to meet your need:
7777

78-
* **SPACE_HOME:** path to your workspace directory, default to `${"user.home"}/.workspace`
78+
* **SPACE_HOME:** path to your workspace directory, default to `~/.coding-ide/workspace`
7979
* **server.port:** backend server port
8080
* **USERNAME:** username, used by git as its `user.name` config when commit, defaults to "coding"
8181
* **EMAIL:** email, used by git as its `user.email` config when commit, defaults to "coding@coding.net"
8282
* **AVATAR:** user's avatar
83-
* **CODING_IDE_HOME:** path to store WebIDE application's data
83+
* **CODING_IDE_HOME:** path to store WebIDE application's data, default to `~/.coding-ide`
8484

8585
If changed, restart the application to let your configurations take effect. Note that changes on `USERNAME`, `EMAIL` *WILL NOT* apply to workspaces that are already created.
8686

8787

8888
## Docker Server
8989

9090
```
91-
docker run -p 8080:8080 -h webide --name webide webide/webide
91+
docker run -p 8080:8080 -v coding-ide-home:/root/.coding-ide webide/webide
9292
```
9393

9494
To learn more about docker commands,please refer to wiki [English](https://github.com/Coding/WebIDE/wiki/Docker-Server.en) [中文](https://github.com/Coding/WebIDE/wiki/Docker-Server.zh)

0 commit comments

Comments
 (0)