diff --git a/deploy-container/README.md b/deploy-container/README.md index 8e4d715..093d973 100644 --- a/deploy-container/README.md +++ b/deploy-container/README.md @@ -10,6 +10,8 @@ To launch your code-server environment, click the button below and log in with G | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | For Railway, it will ask you to make a new repo to store this image, so you can add additional software to your repo's `Dockerfile` in the future. | For Heroku, we recommend [using this repo as a template](https://github.com/bpmct/code-server-railway/generate) and using the one-click deploy on your own repo to further modify your app. | +Docker Hub: this image is live on the Docker Hub at `bencdr/code-server-deploy-container` + --- ## 💾 Persist your filesystem with `rclone` diff --git a/vm-script/README.md b/deploy-vm/README.md similarity index 100% rename from vm-script/README.md rename to deploy-vm/README.md diff --git a/guides/railway.md b/guides/railway.md new file mode 100644 index 0000000..a71ee60 --- /dev/null +++ b/guides/railway.md @@ -0,0 +1,41 @@ +![code-server and railway.app](../img/code-server-railway.png) + +## Guide: Launching code-server on railway.app + +[Railway](https://railway.app) is a new cloud development platform! ☁️ Use Railway + code-server to get a dev environment that you can access from any device. + +## Step 1: Click to deploy [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new?template=https%3A%2F%2Fgithub.com%2Fbpmct%2Fcode-server-railway&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 + +![railway launch environment screen](../img/launch-railway.gif) + +You'll need to make a new repository which will contain your code-server configuration. If you push changes to this repo (to install NodeJS, for example), it will re-deploy code-server. + +You also need to specity a `PASSWORD` and a `GIT_REPO` to clone in your environment :) + +## Step 3: Modify your environment to add additional tools + +![railway repo](../img/railway-connected.png) + +1. In Railway, go to `Deployments -> Triggers` to see your source repo. +1. Open the source repo in GitHub and edit the `Dockerfile` +1. Add some custom tools (like NodeJS) and commit to the main branch: + + ```Dockerfile + # You can add custom software and dependencies for your environment here. Some examples: + + # RUN code-server --install-extension esbenp.prettier-vscode + # RUN sudo apt-get install -y build-essential + # RUN COPY myTool /home/coder/myTool + + # Install NodeJS + RUN sudo curl -fsSL https://deb.nodesource.com/setup_15.x | sudo bash - + RUN sudo apt-get install -y nodejs + ``` + +1. Head back to Railway and notice how there is a new deployment. After it is done, you can use these tools in your environment. + +1. (Optional): [Configure rclone](https://github.com/bpmct/deploy-code-server/tree/main/deploy-container#-persist-your-filesystem-with-rclone) so that you can save your VS Code config and files without commiting diff --git a/img/launch-railway.gif b/img/launch-railway.gif new file mode 100644 index 0000000..80c7750 Binary files /dev/null and b/img/launch-railway.gif differ diff --git a/img/railway-connected.png b/img/railway-connected.png new file mode 100644 index 0000000..09262bd Binary files /dev/null and b/img/railway-connected.png differ