Skip to content

Commit 53dd155

Browse files
bpmctbpmct
committed
cleanup guides
1 parent c968c6d commit 53dd155

File tree

3 files changed

+26
-21
lines changed

3 files changed

+26
-21
lines changed

‎README.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@
22

33
A collection of one-click buttons and scripts for deploying code-server to various cloud hosting platforms. The fastest way to get a code-server environment! ☁️
44

5-
| Platform | Type | Cheapest Plan | Deploy |
6-
| ----------------- | ---------------- | ------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
7-
| DigitalOcean | VM | $5/mo, 1 CPU, 1 GB RAM | Test |
8-
| Vultr | VM | $5/mo, 1 CPU, 1 GB RAM | Test |
9-
| Linode | VM | $3.50/mo, 1 CPU, 512 MB RAM | Test |
10-
| Railway | Deploy Container | Free, specs unknown, but very fast 🚀 | [![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) |
11-
| Heroku | Deploy Container | Free, 1 CPU, 512 MB RAM | [![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy) |
12-
| Azure App Service | Deploy Container | Free, 1 CPU, 1 GB RAM | [see guide](https://github.com/bencdr/code-server-azure) |
5+
| Platform | Type | Cheapest Plan | Deploy |
6+
| ----------------- | ---------------- | ------------------------------------- | -------------------------------------------------------- |
7+
| DigitalOcean | VM | $5/mo, 1 CPU, 1 GB RAM | Test |
8+
| Vultr | VM | $5/mo, 1 CPU, 1 GB RAM | Test |
9+
| Linode | VM | $3.50/mo, 1 CPU, 512 MB RAM | Test |
10+
| Railway | Deploy Container | Free, specs unknown, but very fast 🚀 | [see guide](guides/railway.md) |
11+
| Heroku | Deploy Container | Free, 1 CPU, 512 MB RAM | [see guide](guides/heroku.md) |
12+
| Azure App Service | Deploy Container | Free, 1 CPU, 1 GB RAM | [see guide](https://github.com/bencdr/code-server-azure) |
1313

1414
---
1515

‎guides/heroku.md

+18-13
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,32 @@
1-
# Guide: Launching code-server on Heroku
1+
# Guide: Launching `code-server` on Heroku
22

3-
![code-server and railway.app](../img/code-server-railway.png)
3+
Heroku is a managed app hosting platform. Launch code-server on Heroku to get on-demand dev environments that turn off when you don't need them! 💵
44

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.
5+
![code-server and Heroku](../img/heroku-app-create.png)
66

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)
7+
## Step 1: Click to deploy
8+
9+
[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/bpmct/code-server-heroku/tree/main)
810

911
---
1012

11-
## Step 2: Configure & launch your environment
13+
## Step 2: Configure & deploy your environment
1214

13-
![railway launch environment screen](../img/launch-railway.gif)
15+
`App name`: The URL and you can access code-server with
16+
`PASSWORD`: A password you can use to log in
17+
`GIT_REPO`: The HTTPS URL of a git repo you'd like to use in code-server. (optional)
1418

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.
19+
After it has built, you can access it by pressing "View" or "Open app."
1620

17-
You also need to specity a `PASSWORD` and a `GIT_REPO` to clone in your environment :)
21+
## Step 3: Create a new GitHub repo with this template
1822

19-
## Step 3: Modify your environment to add additional tools
23+
<img src="../img/modify-github-template.png" alt="Modify GitHub template" width="600" />
2024

21-
![railway repo](../img/railway-connected.png)
25+
## Step 4: Set up automatic builds with this repo
2226

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`
27+
1. In Heroku, navigate to `Deploy -> Deployment Method"
28+
1. Link it with the GitHub repo you just created.
29+
1. Open the repo in GitHub and edit the `Dockerfile`
2530
1. Add some custom tools (like NodeJS) and commit to the main branch:
2631

2732
```Dockerfile
@@ -36,6 +41,6 @@ You also need to specity a `PASSWORD` and a `GIT_REPO` to clone in your environm
3641
RUN sudo apt-get install -y nodejs
3742
```
3843

39-
1. Head back to Railway and notice a new deployment was created. After it has completed, you can use these tools in your environment.
44+
1. Head back to Heroku and notice a new deployment has started. After it has completed, you can use these tools in your environment.
4045

4146
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/modify-github-template.png

368 KB
Loading

0 commit comments

Comments
 (0)