Skip to content

Commit ec70ea6

Browse files
deansheathercode-asher
authored andcommittedJun 7, 2019
Change documentation to use port 8443 (#740)
1 parent 04adf14 commit ec70ea6

File tree

5 files changed

+16
-26
lines changed

5 files changed

+16
-26
lines changed
 

‎doc/admin/install/aws.md

+4-7
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@ If you're just starting out, we recommend [installing code-server locally](../..
1111
### Use the AWS wizard
1212

1313
- Click **Launch Instance** from your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home).
14-
- Select the Ubuntu Server 16.04 LTS (HVM), SSD Volume Type (`ami-0f9cf087c1f27d9b1)` at this time of writing)
14+
- Select the Ubuntu Server 18.04 LTS (HVM), SSD Volume Type
1515
- Select an appropriate instance size (we recommend t2.medium/large, depending on team size and number of repositories/languages enabled), then **Next: Configure Instance Details**
16-
- Select **Next: ...** until you get to the **Configure Security Group** page, then add the default **HTTP** rule (port range "80", source "0.0.0.0/0, ::/0")
16+
- Select **Next: ...** until you get to the **Configure Security Group** page, then add a **Custom TCP Rule** rule with port range set to `8443` and source set to "Anywhere"
1717
> Rules with source of 0.0.0.0/0 allow all IP addresses to access your instance. We recommend setting [security group rules](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html?icmpid=docs_ec2_console) to allow access from known IP addresses only.
1818
- Click **Launch**
1919
- You will be prompted to create a key pair
@@ -56,14 +56,11 @@ If you're just starting out, we recommend [installing code-server locally](../..
5656
> To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md)
5757
- Finally, run
5858
```
59-
sudo ./code-server -p 80
59+
./code-server
6060
```
61-
- When you visit the public IP for your AWS instance, you will be greeted with this page. Code-server is using a self-signed SSL certificate for easy setup. To proceed to the IDE, click **"Advanced"**<img src ="../../assets/chrome_warning.png">
62-
- Then click **"proceed anyway"**<img src="../../assets/chrome_confirm.png">
61+
- Open your browser and visit `https://$public_ip:8443/` (where `$public_ip` is your AWS instance's public IP address). You will be greeted with a page similar to the following screenshot. Code-server is using a self-signed SSL certificate for easy setup. In Chrome/Chromium, click **"Advanced"** then click **"proceed anyway"**. In Firefox, click **Advanced**, then **Add Exception**, then finally **Confirm Security Exception**.<img src ="../../assets/chrome_warning.png">
6362

6463
> For instructions on how to keep the server running after you end your SSH session please checkout [how to use systemd](https://www.linode.com/docs/quick-answers/linux/start-service-at-boot/) to start linux based services if they are killed
6564
66-
> The `-p 80` flag is necessary in order to make the IDE accessible from the public IP of your instance (also available from the description in the instances page.
67-
6865
---
6966
> NOTE: If you get stuck or need help, [file an issue](https://github.com/cdr/code-server/issues/new?&title=Improve+self-hosted+quickstart+guide), [tweet (@coderhq)](https://twitter.com/coderhq) or [email](mailto:support@coder.com?subject=Self-hosted%20quickstart%20guide).

‎doc/admin/install/digitalocean.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -39,11 +39,10 @@ If you're just starting out, we recommend [installing code-server locally](../..
3939
> To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md)
4040
- Finally start the code-server
4141
```
42-
sudo ./code-server -p 80
42+
./code-server
4343
```
4444
> For instructions on how to keep the server running after you end your SSH session please checkout [how to use systemd](https://www.linode.com/docs/quick-answers/linux/start-service-at-boot/) to start linux based services if they are killed
45-
- When you visit the public IP for your Digital Ocean instance, you will be greeted with this page. Code-server is using a self-signed SSL certificate for easy setup. To proceed to the IDE, click **"Advanced"**<img src ="../../assets/chrome_warning.png">
46-
- Then click **"proceed anyway"**<img src="../../assets/chrome_confirm.png">
45+
- Open your browser and visit `https://$public_ip:8443/` (where `$public_ip` is your Digital Ocean instance's public IP address). You will be greeted with a page similar to the following screenshot. Code-server is using a self-signed SSL certificate for easy setup. In Chrome/Chromium, click **"Advanced"** then click **"proceed anyway"**. In Firefox, click **Advanced**, then **Add Exception**, then finally **Confirm Security Exception**.<img src ="../../assets/chrome_warning.png">
4746

4847
---
4948
> NOTE: If you get stuck or need help, [file an issue](https://github.com/cdr/code-server/issues/new?&title=Improve+self-hosted+quickstart+guide), [tweet (@coderhq)](https://twitter.com/coderhq) or [email](mailto:support@coder.com?subject=Self-hosted%20quickstart%20guide).

‎doc/admin/install/google_cloud.md

+6-11
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ If you're just starting out, we recommend [installing code-server locally](../..
1212
- [Open your Google Cloud console](https://console.cloud.google.com/compute/instances) to create a new VM instance and click **Create Instance**
1313
- Choose an appropriate machine type (we recommend 2 vCPU and 7.5 GB RAM, more depending on team size and number of repositories/languages enabled)
1414
- Choose Ubuntu 16.04 LTS as your boot disk
15-
- Check the boxes for **Allow HTTP traffic** and **Allow HTTPS traffic** in the **Firewall** section
15+
- Expand the "Management, security, disks, networking, sole tenancy" section, go to the "Networking" tab, then under network tags add "code-server"
1616
- Create your VM, and **take note** of its public IP address.
17+
- Visit "VPC network" in the console and go to "Firewall rules". Create a new firewall rule called "http-8443". Under "Target tags" add "code-server", and under "Protocols and ports" tick "Specified protocols and ports" and "tcp". Beside "tcp", add "8443", then create the rule.
1718
- Copy the link to download the latest Linux binary from our [releases page](https://github.com/cdr/code-server/releases)
1819

1920
---
@@ -53,19 +54,13 @@ chmod +x code-server
5354
> To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md)
5455
5556
- Start the code-server
56-
```
57-
sudo ./code-server -p 80
58-
```
57+
```
58+
./code-server
59+
```
60+
- Open your browser and visit `https://$public_ip:8443/` (where `$public_ip` is your Compute Engine instance's public IP address). You will be greeted with a page similar to the following screenshot. Code-server is using a self-signed SSL certificate for easy setup. In Chrome/Chromium, click **"Advanced"** then click **"proceed anyway"**. In Firefox, click **Advanced**, then **Add Exception**, then finally **Confirm Security Exception**.<img src ="../../assets/chrome_warning.png">
5961

6062
> For instructions on how to keep the server running after you end your SSH session please checkout [how to use systemd](https://www.linode.com/docs/quick-answers/linux/start-service-at-boot/) to start linux based services if they are killed
6163
62-
- Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser.
63-
> example: 32.32.32.234
64-
65-
- You will be greeted with this page. Code-server is using a self-signed SSL certificate for easy setup. To proceed to the IDE, click **"Advanced"**<img src ="../../assets/chrome_warning.png">
66-
67-
- Then click **"proceed anyway"**<img src="../../assets/chrome_confirm.png">
68-
6964
---
7065

7166
> NOTE: If you get stuck or need help, [file an issue](https://github.com/cdr/code-server/issues/new?&title=Improve+self-hosted+quickstart+guide), [tweet (@coderhq)](https://twitter.com/coderhq) or [email](mailto:support@coder.com?subject=Self-hosted%20quickstart%20guide).

‎doc/assets/chrome_confirm.png

-19 KB
Binary file not shown.

‎doc/self-hosted/index.md

+4-5
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,7 @@ It takes just a few minutes to get your own self-hosted server running. If you'v
2525
> NOTE: Be careful with your password as sharing it will grant those users access to your server's file system
2626
2727
### Things To Know
28-
- When you visit the IP for your code-server, you will be greeted with this page. Code-server is using a self-signed SSL certificate for easy setup. To proceed to the IDE, click **"Advanced"**<img src ="../assets/chrome_warning.png">
29-
- Then click **"proceed anyway"**<img src="../assets/chrome_confirm.png">
28+
- When you visit the IP for your code-server instance, you will be greeted with a page similar to the following screenshot. Code-server is using a self-signed SSL certificate for easy setup. In Chrome/Chromium, click **"Advanced"** then click **"proceed anyway"**. In Firefox, click **Advanced**, then **Add Exception**, then finally **Confirm Security Exception**.<img src ="../../assets/chrome_warning.png">
3029

3130
## Usage
3231
<pre class="pre-wrap"><code>code-server<span class="virtual-br"></span> --help</code></pre>
@@ -94,7 +93,7 @@ Options:
9493
}
9594
}
9695
```
97-
96+
9897
### Apache Reverse Proxy
9998
Example of https virtualhost configuration for Apache as a reverse proxy. Please also pass --allow-http on code-server startup to allow the proxy to connect.
10099
```
@@ -106,7 +105,7 @@ Options:
106105
RewriteRule /(.*) ws://localhost:8443/$1 [P,L]
107106
RewriteCond %{HTTP:Upgrade} !=websocket [NC]
108107
RewriteRule /(.*) http://localhost:8443/$1 [P,L]
109-
108+
110109
ProxyRequests off
111110
112111
RequestHeader set X-Forwarded-Proto https
@@ -118,6 +117,6 @@ Options:
118117
</VirtualHost>
119118
```
120119
*Important:* For more details about Apache reverse proxy configuration checkout the [documentation](https://httpd.apache.org/docs/current/mod/mod_proxy.html) - especially the [Securing your Server](https://httpd.apache.org/docs/current/mod/mod_proxy.html#access) section
121-
120+
122121
### Help
123122
Use `code-server --help` to view the usage for the CLI. This is also shown at the beginning of this section.

0 commit comments

Comments
 (0)
Please sign in to comment.