Skip to content

exclude directories #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Apr 28, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions deploy-container/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@ COPY deploy-container/myTool /home/coder/myTool
| `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 |
| `DOTFILES_REPO` | GitHub path to a dotfiles repository with your personal configuration across devices. | |
---

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.
Expand Down Expand Up @@ -70,12 +69,7 @@ Now, you can add the following the environment variables in the code-server clou
| 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_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. | | |
Expand All @@ -92,6 +86,14 @@ $ 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
Expand Down
20 changes: 0 additions & 20 deletions deploy-container/entrypoint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -76,26 +76,6 @@ else

fi

# Extract the user's dotfiles, if they exist
if [[ -z "${DOTFILES_REPO}" ]]; then
echo "[$PREFIX] DOTFILES_REPO is not specified"
else
echo "[$PREFIX] DOTFILES_REPO is specified"
git clone $DOTFILES_REPO /home/coder/dotfiles

# Symlink if install.sh doesn't exist.
# If it exits, run it
if [ -f "/home/coder/dotfiles/install.sh" ]; then
echo "[$PREFIX] install.sh exists, running it..."
/bin/sh /home/coder/dotfiles/install.sh
else
echo "[$PREFIX] install.sh does not exist, symlinking dotfiles..."
ln -sv /home/coder/dotfiles/* ~/
fi


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
4 changes: 2 additions & 2 deletions guides/railway.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Use Railway + code-server to get a dev environment that you can access from any

## Step 1: Click button to deploy

[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new?template=https%3A%2F%2Fgithub.com%2Fcdr%2Fdeploy-code-server%2F&envs=PASSWORD%2CGIT_REPO%2CDOTFILES_REPO&optionalEnvs=GIT_REPO%2CDOTFILES_REPO&PASSWORDDesc=Your+password+to+log+in+to+code-server+with&GIT_REPODesc=A+git+repo+to+clone+and+open+in+code-server+(ex.+https%3A%2F%2Fgithub.com%2Fcdr%2Fdocs.git)&DOTFILES_REPODesc=Environment+configuration+not+related+to+this+specific+environment.+(see+https%3A%2F%2Fdotfiles.github.io%2F))
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new?template=https%3A%2F%2Fgithub.com%2Fcdr%2Fdeploy-code-server&envs=PASSWORD%2CGIT_REPO&PASSWORDDesc=Your+password+to+log+in+to+code-server+with&GIT_REPODesc=A+git+repo+to+clone+and+open+in+code-server+%28ex.+https%3A%2F%2Fgithub.com%2Fcdr%2Fdocs.git%29)

## Step 2: Configure & launch your environment

Expand All @@ -27,7 +27,7 @@ You also need to specity a `PASSWORD` and a `GIT_REPO` to clone in your environm
1. Open the source repo in GitHub and edit the `Dockerfile`
1. Add some custom tools (like NodeJS) and push to the main branch:

``` Dockerfile
```Dockerfile
# You can add custom software and dependencies for your environment here. Some examples:

# RUN code-server --install-extension esbenp.prettier-vscode
Expand Down