Skip to content

Commit f66c750

Browse files
committed
add railway guide
1 parent ade3cef commit f66c750

File tree

5 files changed

+43
-0
lines changed

5 files changed

+43
-0
lines changed

deploy-container/README.md

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ To launch your code-server environment, click the button below and log in with G
1010
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1111
| 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. |
1212

13+
Docker Hub: this image is live on the Docker Hub at `bencdr/code-server-deploy-container`
14+
1315
---
1416

1517
## 💾 Persist your filesystem with `rclone`
File renamed without changes.

guides/railway.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
![code-server and railway.app](../img/code-server-railway.png)
2+
3+
## Guide: Launching code-server on railway.app
4+
5+
[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.
6+
7+
## 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)
8+
9+
---
10+
11+
## Step 2: Configure & launch your environment
12+
13+
![railway launch environment screen](../img/launch-railway.gif)
14+
15+
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.
16+
17+
You also need to specity a `PASSWORD` and a `GIT_REPO` to clone in your environment :)
18+
19+
## Step 3: Modify your environment to add additional tools
20+
21+
![railway repo](../img/railway-connected.png)
22+
23+
1. In Railway, go to `Deployments -> Triggers` to see your source repo.
24+
1. Open the source repo in GitHub and edit the `Dockerfile`
25+
1. Add some custom tools (like NodeJS) and commit to the main branch:
26+
27+
```Dockerfile
28+
# You can add custom software and dependencies for your environment here. Some examples:
29+
30+
# RUN code-server --install-extension esbenp.prettier-vscode
31+
# RUN sudo apt-get install -y build-essential
32+
# RUN COPY myTool /home/coder/myTool
33+
34+
# Install NodeJS
35+
RUN sudo curl -fsSL https://deb.nodesource.com/setup_15.x | sudo bash -
36+
RUN sudo apt-get install -y nodejs
37+
```
38+
39+
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.
40+
41+
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

img/launch-railway.gif

1.68 MB
Loading

img/railway-connected.png

217 KB
Loading

0 commit comments

Comments
 (0)