deploy-code-server

Dockerfile

@@ -0,0 +1,43 @@
+# Start from the code-server Debian base image
+FROM codercom/code-server:latest
+
+USER coder
+
+# Apply VS Code settings
+# COPY deploy-container/settings.json .local/share/code-server/User/settings.json
+
+# Use bash shell
+ENV SHELL=/bin/bash
+
+# Install unzip + rclone (support for remote filesystem)
+RUN sudo apt-get update && sudo apt-get install unzip -y
+RUN curl https://rclone.org/install.sh | sudo bash
+
+# Copy rclone tasks to /tmp, to potentially be used
+COPY deploy-container/rclone-tasks.json /tmp/rclone-tasks.json
+
+# Fix permissions for code-server
+RUN sudo chown -R coder:coder /home/coder/.local
+
+# You can add custom software and dependencies for your environment below
+# -----------
+
+# Install a VS Code extension:
+# 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
+# RUN code-server --install-extension esbenp.prettier-vscode
+
+# Install apt packages:
+# RUN sudo apt-get install -y ubuntu-make
+
+# Copy files: 
+# COPY deploy-container/myTool /home/coder/myTool
+
+# -----------
+
+# Port
+ENV PORT=7860
+ENV PASSWORD=huggingface
+
+# Use our custom entrypoint script first
+COPY deploy-container/entrypoint.sh /usr/bin/deploy-container-entrypoint.sh
+ENTRYPOINT ["/usr/bin/deploy-container-entrypoint.sh"]

deploy-container/README.md

@@ -0,0 +1,119 @@
+# code-server-deploy-container
+
+An container image built for deploying code-server.
+
+## Guides
+
+- [Deploy on Railway](../guides/railway.md)
+- [Deploy on Heroku](../guides/heroku.md)
+
+Docker Hub: `bencdr/code-server-deploy-container`
+
+To run the container locally, you can use:
+
+```console
+docker run -p 127.0.0.1:8080:8080 \
+  -v "$PWD/project:/home/coder/project" \
+  -u "$(id -u):$(id -g)" \
+  -e "DOCKER_USER=$USER" \
+  -e "PASSWORD=12345" \
+  -it bencdr/code-server-deploy-container:latest
+```
+
+## Modifying your code-server environment
+
+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.
+
+We've included some examples on how to add additional dependencies in the root-level [Dockerfile](../Dockerfile):
+
+```Dockerfile
+# Install a VS Code extension:
+# 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
+RUN code-server --install-extension esbenp.prettier-vscode
+
+# Install apt packages:
+RUN sudo apt-get install -y ubuntu-make
+
+# Copy files:
+COPY deploy-container/myTool /home/coder/myTool
+```
+
+---
+
+## Environment variables
+
+| Variable Name      | Description                                                                                        | Default Value       |
+| ------------------ | -------------------------------------------------------------------------------------------------- | ------------------- |
+| `PASSWORD`         | Password for code-server                                                                           |                     |
+| `HASHED_PASSWORD`  | Overrrides PASSWORD. [SHA-256 hash](https://xorbin.com/tools/sha256-hash-calculator) of password   |
+| `USE_LINK`         | Use code-server --link instead of a password (coming soon)                                         | false               |
+| `GIT_REPO`         | A git repository to clone                                                                          |                     |
+| `DOTFILES_REPO`    | A [dotfiles](https://dotfiles.github.io/) repo to save preferences. Runs install.sh, if it exists. |                     |
+| `DOTFILES_SYMLINK` | Symlinks dotfiles repo to $HOME, if exits.                                                         | true                |
+| `START_DIR`        | The directory code-server opens (and clones repos in)                                              | /home/coder/project |
+
+---
+
+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.
+
+## 💾 Persist your filesystem with `rclone`
+
+This image has built-in support for [rclone](https://rclone.org/) so that your files don't get lost when code-server is re-deployed.
+
+You can generate the rclone config on any machine, but it works great on the code-server environment itself, or Google Cloud Shell :)
+
+```sh
+# 1. install rclone
+# see https://rclone.org/install/ for other install options
+$ curl https://rclone.org/install.sh | sudo bash
+
+# 2. create a new rclone remote with your favorite storage provider ☁️
+$ rclone config
+
+# 3. Encode your rclone config and copy to your clipboard
+$ cat $(rclone config file | sed -n 2p) | base64 --wrap=0 # Linux
+$ cat $(rclone config file | sed -n 2p) | base64 --b 0 # MacOS
+```
+
+Now, you can add the following the environment variables in the code-server cloud app:
+
+| Environment Variable | Description                                                                                                                                           | Default Value                                | Required |
+| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------- | -------- |
+| RCLONE_DATA          | the encoded rclone config you copied in step 3                                                                                                        | n/a                                          | ✅       |
+| RCLONE_REMOTE_NAME   | the name of the remote you added in step 2.<br />check with `$ rclone listremotes`                                                                    | code-server-remote                           |          |
+| RCLONE_SOURCE        | source directory to sync files in the code-server container                                                                                           | the project directory: `/home/coder/project` |          |
+| 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                            |          |
+| RCLONE_VSCODE_TASKS  | import push and pull shortcuts into VS Code ![rclone screenshot from VS Code](../img/rclone-vscode-tasks.png)                                         | true                                         |
+| RCLONE_AUTO_PUSH     | automatically push files on startup if the rclone remote is empty (environment -> rclone remote)                                                      | true                                         |          |
+| RCLONE_AUTO_PULL     | automatically pull files on startup if the rclone remote is not empty (rclone -> environment remote)                                                  | true                                         |          |
+| RCLONE_FLAGS         | additional flags to attach to the push and pull script.<br />type `$ rclone help flags` for a list.                                                   |                                              |          |
+
+```sh
+
+# --- How to use ---
+
+# Terminal:
+$ sh /home/coder/push_remote.sh # save your uncomitted files to the remote
+$ sh /home/coder/pull_remote.sh # get latest files from the remote
+
+# In VS Code:
+# use items in bottom bar or ctrl + P, run task: push_remote or pull_remote or
+```
+
+### Popular rclone flags
+
+To avoid syncing unnecessary directories, add this to `RCLONE_FLAGS` :
+
+```none
+--exclude "node_modules/**" --exclude ".git/**"
+```
+
+---
+
+## Todo
+
+- [ ] Make `push_remote` and `pull_remote` commands in path
+- [ ] Impliment file watcher or auto file sync in VS Code
+- [ ] Attach a "push" on a git stash??
+- [ ] Add support for SSH / VS Code remote access
+- [ ] Make rclone logs visible in environment for debugging

deploy-container/entrypoint.sh

@@ -0,0 +1,100 @@
+#!/bin/bash
+
+START_DIR="${START_DIR:-/home/coder/project}"
+
+PREFIX="deploy-code-server"
+
+mkdir -p $START_DIR
+
+# function to clone the git repo or add a user's first file if no repo was specified.
+project_init () {
+    [ -z "${GIT_REPO}" ] && echo "[$PREFIX] No GIT_REPO specified" && echo "Example file. Have questions? Join us at https://community.coder.com" > $START_DIR/coder.txt || git clone $GIT_REPO $START_DIR
+}
+
+# add rclone config and start rclone, if supplied
+if [[ -z "${RCLONE_DATA}" ]]; then
+    echo "[$PREFIX] RCLONE_DATA is not specified. Files will not persist"
+
+    # start the project
+    project_init
+
+else
+    echo "[$PREFIX] Copying rclone config..."
+    mkdir -p /home/coder/.config/rclone/
+    touch /home/coder/.config/rclone/rclone.conf
+    echo $RCLONE_DATA | base64 -d > /home/coder/.config/rclone/rclone.conf
+
+    # default to true
+    RCLONE_VSCODE_TASKS="${RCLONE_VSCODE_TASKS:-true}"
+    RCLONE_AUTO_PUSH="${RCLONE_AUTO_PUSH:-true}"
+    RCLONE_AUTO_PULL="${RCLONE_AUTO_PULL:-true}"
+
+    if [ $RCLONE_VSCODE_TASKS = "true" ]; then
+        # copy our tasks config to VS Code
+        echo "[$PREFIX] Applying VS Code tasks for rclone"
+        cp /tmp/rclone-tasks.json /home/coder/.local/share/code-server/User/tasks.json
+        # install the extension to add to menu bar
+        code-server --install-extension actboy168.tasks&
+    else
+        # user specified they don't want to apply the tasks
+        echo "[$PREFIX] Skipping VS Code tasks for rclone"
+    fi
+
+
+
+    # Full path to the remote filesystem
+    RCLONE_REMOTE_PATH=${RCLONE_REMOTE_NAME:-code-server-remote}:${RCLONE_DESTINATION:-code-server-files}
+    RCLONE_SOURCE_PATH=${RCLONE_SOURCE:-$START_DIR}
+    echo "rclone sync $RCLONE_SOURCE_PATH $RCLONE_REMOTE_PATH $RCLONE_FLAGS -vv" > /home/coder/push_remote.sh
+    echo "rclone sync $RCLONE_REMOTE_PATH $RCLONE_SOURCE_PATH $RCLONE_FLAGS -vv" > /home/coder/pull_remote.sh
+    chmod +x push_remote.sh pull_remote.sh
+
+    if rclone ls $RCLONE_REMOTE_PATH; then
+
+        if [ $RCLONE_AUTO_PULL = "true" ]; then
+            # grab the files from the remote instead of running project_init()
+            echo "[$PREFIX] Pulling existing files from remote..."
+            /home/coder/pull_remote.sh&
+        else
+            # user specified they don't want to apply the tasks
+            echo "[$PREFIX] Auto-pull is disabled"
+        fi
+
+    else
+
+        if [ $RCLONE_AUTO_PUSH = "true" ]; then
+            # we need to clone the git repo and sync
+            echo "[$PREFIX] Pushing initial files to remote..."
+            project_init
+            /home/coder/push_remote.sh&
+        else
+            # user specified they don't want to apply the tasks
+            echo "[$PREFIX] Auto-push is disabled"
+        fi
+
+    fi
+
+fi
+
+# Add dotfiles, if set
+if [ -n "$DOTFILES_REPO" ]; then
+    # grab the files from the remote instead of running project_init()
+    echo "[$PREFIX] Cloning dotfiles..."
+    mkdir -p $HOME/dotfiles
+    git clone $DOTFILES_REPO $HOME/dotfiles
+
+    DOTFILES_SYMLINK="${RCLONE_AUTO_PULL:-true}"
+
+    # symlink repo to $HOME
+    if [ $DOTFILES_SYMLINK = "true" ]; then
+        shopt -s dotglob
+        ln -sf source_file $HOME/dotfiles/* $HOME
+    fi
+
+    # run install script, if it exists
+    [ -f "$HOME/dotfiles/install.sh" ] && $HOME/dotfiles/install.sh
+fi
+
+echo "[$PREFIX] Starting code-server..."
+# Now we can run code-server with the default entrypoint
+/usr/bin/entrypoint.sh --bind-addr 0.0.0.0:8080 $START_DIR

deploy-container/myTool/test.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+echo "This is a demo tool that could be brought into the code-server workspace"

deploy-container/rclone-tasks.json

@@ -0,0 +1,33 @@
+{
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "push_remote",
+      "type": "shell",
+      "command": "sh /home/coder/push_remote.sh",
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": [],
+      "options": {
+        "statusbar": {
+          "label": "$(repo-push) rclone: push"
+        }
+      }
+    },
+    {
+      "label": "pull_remote",
+      "type": "shell",
+      "command": "sh /home/coder/pull_remote.sh",
+      "presentation": {
+        "reveal": "always"
+      },
+      "problemMatcher": [],
+      "options": {
+        "statusbar": {
+          "label": "$(repo-pull) rclone: pull"
+        }
+      }
+    }
+  ]
+}

deploy-container/settings.json

@@ -0,0 +1,7 @@
+{
+  "workbench.colorTheme": "Default Dark+",
+  "git.postCommitCommand": "sync",
+  "git.enableSmartCommit": true,
+  "git.confirmSync": false,
+  "git.autofetch": true
+}