You signed in with another tab or window.Reload to refresh your session.You signed out in another tab or window.Reload to refresh your session.You switched accounts on another tab or window.Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: deploy-container/README.md
+33-21Lines changed: 33 additions & 21 deletions
Original file line number
Diff line number
Diff line change
@@ -4,26 +4,37 @@ An container image built for deploying code-server.
4
4
5
5
##Guides
6
6
7
-
*[Deploy on Railway](../guides/railway.md)
8
-
*[Deploy on Heroku](../guides/heroku.md)
7
+
-[Deploy on Railway](../guides/railway.md)
8
+
-[Deploy on Heroku](../guides/heroku.md)
9
9
10
10
Docker Hub:`bencdr/code-server-deploy-container`
11
11
12
+
To run the container locally, you can use:
13
+
14
+
```
15
+
docker run -p 127.0.0.1:8080:8080 \
16
+
-v "$PWD/project:/home/coder/project" \
17
+
-u "$(id -u):$(id -g)" \
18
+
-e "DOCKER_USER=$USER" \
19
+
-e "PASSWORD=12345" \
20
+
-it bencdr/code-server-deploy-container:latest
21
+
```
22
+
12
23
##Modifying your code-server environment
13
24
14
25
To update your code-server version, modify the version number on line 2 in your Dockerfile. See the[list of tags](https://hub.docker.com/r/codercom/code-server/tags?page=1&ordering=last_updated) for the latest version.
15
26
16
27
We've included some examples on how to add additoonal dependencies in the root-level[Dockerfile](../Dockerfile):
17
28
18
-
```Dockerfile
29
+
```Dockerfile
19
30
# Install a VS Code extension:
20
31
# Note: we use a different marketplace than VS Code. See https://github.com/cdr/code-server/blob/main/docs/FAQ.md#differences-compared-to-vs-code
21
32
RUN code-server --install-extension esbenp.prettier-vscode
|`HASHED_PASSWORD`| Overrrides PASSWORD.[SHA-256 hash](https://xorbin.com/tools/sha256-hash-calculator) of password|
38
-
|`USE_LINK`| Use code-server --link instead of a password (coming soon)| false|
39
-
|`GIT_REPO`| A git repository to clone||
40
-
|`START_DIR`| The directory code-server opens (and clones repos in)| /home/coder/project|
49
+
|`USE_LINK`| Use code-server --link instead of a password (coming soon)| false|
50
+
|`GIT_REPO`| A git repository to clone||
51
+
|`START_DIR`| The directory code-server opens (and clones repos in)| /home/coder/project|
52
+
41
53
---
42
54
43
55
Other code-server environment variables (such as`CODE_SERVER_CONFIG` ) can also be used. See the[code-server FAQ](https://github.com/cdr/code-server/blob/main/docs/FAQ.md) for details.
@@ -48,7 +60,7 @@ This image has built-in support for [rclone](https://rclone.org/) so that your f
48
60
49
61
You can generate the rclone config on any machine, but it works great on the code-server environment itself, or Google Cloud Shell :)
50
62
51
-
```sh
63
+
```sh
52
64
# 1. install rclone
53
65
# see https://rclone.org/install/ for other install options
54
66
$ curl https://rclone.org/install.sh| sudo bash
@@ -65,16 +77,16 @@ Now, you can add the following the environment variables in the code-server clou
| RCLONE_DATA| the encoded rclone config you copied in step 3| n/a| ✅|
69
-
| RCLONE_REMOTE_NAME| the name of the remote you added in step 2.<br />check with`$ rclone listremotes`| code-server-remote||
80
+
| RCLONE_DATA| the encoded rclone config you copied in step 3| n/a| ✅|
81
+
| RCLONE_REMOTE_NAME| the name of the remote you added in step 2.<br />check with`$ rclone listremotes`| code-server-remote||
70
82
| RCLONE_SOURCE| source directory to sync files in the code-server container| the project directory:`/home/coder/project`||
71
83
| RCLONE_DESTINATION| the path in the remote that rclone syncs to. change this if you have multiple code-server environments, or if you want to better organize your files.| code-server-files||
72
-
| RCLONE_VSCODE_TASKS| import push and pull shortcuts into VS Code| true|
84
+
| RCLONE_VSCODE_TASKS| import push and pull shortcuts into VS Code| true|
73
85
| RCLONE_AUTO_PUSH| automatically push files on startup if the rclone remote is empty (environment -> rclone remote)| true||
74
86
| RCLONE_AUTO_PULL| automatically pull files on startup if the rclone remote is not empty (rclone -> environment remote)| true||
75
-
| RCLONE_FLAGS| additional flags to attach to the push and pull script.<br />type`$ rclone help flags` for a list.|||
87
+
| RCLONE_FLAGS| additional flags to attach to the push and pull script.<br />type`$ rclone help flags` for a list.|||
76
88
77
-
```sh
89
+
```sh
78
90
79
91
# --- How to use ---
80
92
@@ -83,23 +95,23 @@ $ sh /home/coder/push_remote.sh # save your uncomitted files to the remote
83
95
$ sh /home/coder/pull_remote.sh# get latest files from the remote
84
96
85
97
# In VS Code:
86
-
# use items in bottom bar or ctrl + P, run task: push_remote or pull_remote or
98
+
# use items in bottom bar or ctrl + P, run task: push_remote or pull_remote or
87
99
```
88
100
89
101
###Popular rclone flags
90
102
91
103
To avoid syncing unnecessary directories, add this to`RCLONE_FLAGS` :
92
104
93
-
```none
105
+
```none
94
106
--exclude "node_modules/**" --exclude ".git/**"
95
107
```
96
108
97
109
---
98
110
99
111
##Todo
100
112
101
-
*[ ] Make`push_remote` and`pull_remote` commands in path
102
-
*[ ] Impliment file watcher or auto file sync in VS Code
103
-
*[ ] Attach a "push" on a git stash??
104
-
*[ ] Add support for SSH / VS Code remote access
105
-
*[ ] Make rclone logs visible in environment for debugging
113
+
-[ ] Make`push_remote` and`pull_remote` commands in path
114
+
-[ ] Impliment file watcher or auto file sync in VS Code
115
+
-[ ] Attach a "push" on a git stash??
116
+
-[ ] Add support for SSH / VS Code remote access
117
+
-[ ] Make rclone logs visible in environment for debugging