Skip to content

Commit 32d5d91

Browse files
Mike Niklesjeanp413
Mike Nikles
authored andcommitted
Align all guides with the guide template.
1 parent 8b41448 commit 32d5d91

File tree

4 files changed

+58
-31
lines changed

4 files changed

+58
-31
lines changed

docs/guides/digital-ocean/README.md

+25-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,20 @@
1-
# Deploying an OpenVSCode Server to Digital Ocean
1+
# Deploy OpenVSCode Server to Digital Ocean
22

3-
## Creating the Droplet
3+
## Prerequisites
4+
5+
To complete this guide, you need:
6+
* a [Digital Ocean](https://www.digitalocean.com/) account
7+
8+
## Setup
9+
10+
### Create the Droplet
411

512
First, you need to create a Virtual Machine to host your server. If you don't have one already, you can start with [our template](https://cloud.digitalocean.com/droplets/new?use_case=droplet&i=59c3b0&fleetUuid=a8fdcc26-2bf0-449d-8113-e458327192fe&distro=ubuntu&distroImage=ubuntu-20-04-x64&size=s-1vcpu-1gb-amd&region=fra1&options=ipv6), then change a couple of settings as explained below.
613

714
- You either need to set a password or add an SSH key. For demonstration purposes, it's easier to use a password. **Caution**: This is for demo purposes, please follow security best practices for a production environment.
815
- We need to do is to check the checkbox <kbd>User data</kbd> and add the following script to the text field below: **TODO: What script, cc @filiptronicek**
916

10-
## Initial setup
17+
### Prepare the Droplet
1118

1219
- First things first, you need to turn on the Droplet by selecting it in the dashboard and toggling the switch on the top right of the page.
1320
- Then, you need to copy the Droplet's IP address, available on the same page in the top bar. If you are unsure whether to copy the **ipv4** or **ipv6** address, select **ipv4**.
@@ -17,7 +24,7 @@ First, you need to create a Virtual Machine to host your server. If you don't ha
1724
```
1825
- When prompted, enter the password you chose during the configuration.
1926

20-
### Downloading OpenVSCode Server
27+
### Download & extract OpenVSCode Server
2128

2229
**Caution**: Make sure you successfully connected to the Droplet before you execute the following commands.
2330

@@ -35,7 +42,9 @@ tar -xzf code-server.tar.gz
3542
rm code-server.tar.gz
3643
```
3744

38-
While you are still connected to the VM, execute the following commands to start OpenVSCode Server:
45+
## Start the server
46+
47+
While you are still connected to the Droplet, execute the following commands to start OpenVSCode Server:
3948

4049
```bash
4150
cd openvscode-server-v$SERVER_VERSION-linux-x64
@@ -47,7 +56,15 @@ cd openvscode-server-v$SERVER_VERSION-linux-x64
4756
./server.sh >/dev/null 2>&1 &
4857
```
4958

50-
You're all set! You can now access your IDE at `http://<your-droplet-ip>:3000`.
59+
You're all set!
60+
61+
## Access OpenVSCode Server
62+
63+
You can now access your IDE at `http://<your-droplet-ip>:3000`.
64+
65+
## Teardown
66+
67+
Delete the Droplet through the Digital Ocean web interface.
5168

5269
## Further steps
5370

@@ -61,10 +78,10 @@ If you want to run the server on boot, you can add this to your Crontab file (`c
6178

6279
Make sure you replace `REPLACE_WITH_LATEST_VERSION` with the version you used earlier.
6380

64-
### Adding a custom domain
81+
### Add a custom domain
6582

6683
You can follow the official [DNS Quickstart](https://docs.digitalocean.com/products/networking/dns/quickstart/) guide for setting up a custom domain with your Droplet.
6784

68-
### Securing the Droplet
85+
### Secure the Droplet
6986

7087
There is an awesome video by Mason Egger called [Securing Your Droplet](https://youtu.be/L8e_eAm4fFM), which explains some key steps for hardening the security of the Droplet.

docs/guides/gcp-gce/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
## Prerequisites
44

55
To complete this guide, you need:
6-
* a GCP account
6+
* a [Google Cloud Platform](https://cloud.google.com/) account
77
* a project where you can create a virtual machine
88

99
## Start the interactive tutorial

docs/guides/railway/README.md

+13-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,16 @@
1-
# Deploying an OpenVSCode Server to Railway
1+
# Deploy OpenVSCode Server to Railway
22

3-
To deploy to https://railway.app, all it takes is to click the following button:
3+
## Prerequisites
4+
5+
To complete this guide, you need:
6+
* a [Railway](https://railway.app/) account
7+
8+
## Deploy & access OpenVSCode Server
9+
10+
To deploy to Railway, click the following button and follow the instructions:
411

512
[![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/new/template?template=https%3A%2F%2Fgithub.com%2Fgitpod-io%2Fopenvscode-releases&envs=RELEASE_TAG%2CPORT&RELEASE_TAGDefault=openvscode-server-v1.60.0&PORTDefault=3000)
13+
14+
## Teardown
15+
16+
Delete the project in the Railway dashboard.

docs/guides/render/README.md

+19-20
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
1-
# Deploying an OpenVSCode Server to Render
1+
# Deploy OpenVSCode Server to Render
22

3-
## Creating the server with one click
3+
## Prerequisites
44

5-
To host OpenVSCode Server on Render (www.render.com), click the button below:
5+
To complete this guide, you need:
6+
* a [Render](https://render.com/) account
67

7-
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://dashboard.render.com/login?next=/iac/new?repo=https://github.com/render-examples/gitpod-vscode-example)
8+
## Setup
9+
10+
To deploy to Render, click the following button and follow the instructions:
11+
12+
[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/render-examples/gitpod-vscode-example)
813

914
After that, create a name for the service group (for example `OpenVSCode Server`) and click <kbd>Apply</kbd>.
1015

11-
After Render does its magic, you will see your server listed in the <kbd>Services</kbd> section of the Dashboard. In there, you can see your server URL, at which you can access it.
16+
## Start the server
17+
18+
Render starts the server automatically.
19+
20+
## Access OpenVSCode Server
21+
22+
When the deployment is complete, you will see your server listed in the <kbd>Services</kbd> section of the Dashboard. In there, you can see your server URL to access OpenVSCode Server.
1223

1324
![image showing where the URL can be found](https://user-images.githubusercontent.com/29888641/133103443-c20a6eab-7d35-46d2-80b0-107dd9237870.png)
1425

15-
## Creating the server manually
16-
17-
- [Connect your GitHub account to your Render account](https://render.com/docs/github).
18-
- Clone this repo.
19-
- Create a new web service using this repo and the following parameters:
20-
- Environment: Docker
21-
- Advanced > Add Environment Variable
22-
- key: SERVER_VERSION
23-
- value: v1.60.0
24-
- Advanced > Add Disk
25-
- Name: data
26-
- Mount Path: /home/workspace
27-
- Watch your OpenVSCode Server deploy, and then log in at the public URL listed below your web service name.
28-
29-
For a list of available `SERVER_VERSION` values, please refer to the [Releases](https://github.com/gitpod-io/openvscode-server/releases) page.
26+
## Teardown
27+
28+
Delete the service in your dashboard.

0 commit comments

Comments
 (0)