From 3fb84e8b72c200beccc7042155efb4f1692285b9 Mon Sep 17 00:00:00 2001 From: Ben Date: Wed, 28 Apr 2021 02:43:29 +0000 Subject: [PATCH] exclude directories --- deploy-container/README.md | 46 ++++++++++++++++++++++++-------------- 1 file changed, 29 insertions(+), 17 deletions(-) diff --git a/deploy-container/README.md b/deploy-container/README.md index 74313588..5508c545 100644 --- a/deploy-container/README.md +++ b/deploy-container/README.md @@ -4,8 +4,8 @@ An container image built for deploying code-server. ## Guides -- [Deploy on Railway](../guides/railway.md) -- [Deploy on Heroku](../guides/heroku.md) +* [Deploy on Railway](../guides/railway.md) +* [Deploy on Heroku](../guides/heroku.md) Docker Hub: `bencdr/code-server-deploy-container` @@ -15,7 +15,7 @@ To update your code-server version, modify the version number on line 2 in your We've included some examples on how to add additoonal dependencies in the root-level [Dockerfile](../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 @@ -33,14 +33,14 @@ COPY deploy-container/myTool /home/coder/myTool | Variable Name | Description | Default Value | | ----------------- | ------------------------------------------------------------------------------------------------ | ------------------- | -| `PASSWORD` | Password for code-server | | +| `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 | | -| `START_DIR` | The directory code-server opens (and clones repos in) | /home/coder/project | +| `USE_LINK` | Use code-server --link instead of a password (coming soon) | false | +| `GIT_REPO` | A git repository to clone | | +| `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. +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` @@ -48,7 +48,7 @@ This image has built-in support for [rclone](https://rclone.org/) so that your f You can generate the rclone config on any machine, but it works great on the code-server environment itself, or Google Cloud Shell :) -```sh +``` sh # 1. install rclone # see https://rclone.org/install/ for other install options $ curl https://rclone.org/install.sh | sudo bash @@ -66,15 +66,19 @@ Now, you can add the following the environment variables in the code-server clou | 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.
check with `$ rclone listremotes` | code-server-remote | | +| RCLONE_REMOTE_NAME | the name of the remote you added in step 2.
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_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.
type `$ rclone help flags` for a list. | | | -```sh +``` sh # --- How to use --- @@ -86,12 +90,20 @@ $ sh /home/coder/pull_remote.sh # get latest files from the remote # 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 +* [ ] 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 pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy