diff --git a/doc/admin/install/aws.md b/doc/admin/install/aws.md index 2018ee09..9d158ef2 100644 --- a/doc/admin/install/aws.md +++ b/doc/admin/install/aws.md @@ -11,9 +11,9 @@ If you're just starting out, we recommend [installing code-server locally](../.. ### Use the AWS wizard - Click **Launch Instance** from your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home). -- Select the Ubuntu Server 16.04 LTS (HVM), SSD Volume Type (`ami-0f9cf087c1f27d9b1)` at this time of writing) +- Select the Ubuntu Server 18.04 LTS (HVM), SSD Volume Type - 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** -- 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") +- 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" > 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. - Click **Launch** - 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](../.. > To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md) - Finally, run ``` - sudo ./code-server -p 80 + ./code-server ``` -- 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"** -- Then click **"proceed anyway"** +- 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**. > 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 - > 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. - --- > 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). diff --git a/doc/admin/install/digitalocean.md b/doc/admin/install/digitalocean.md index e167694d..a3aaa037 100644 --- a/doc/admin/install/digitalocean.md +++ b/doc/admin/install/digitalocean.md @@ -39,11 +39,10 @@ If you're just starting out, we recommend [installing code-server locally](../.. > To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md) - Finally start the code-server ``` - sudo ./code-server -p 80 + ./code-server ``` > 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 -- 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"** -- Then click **"proceed anyway"** +- 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**. --- > 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). diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index 32a16f59..c87654a5 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -12,8 +12,9 @@ If you're just starting out, we recommend [installing code-server locally](../.. - [Open your Google Cloud console](https://console.cloud.google.com/compute/instances) to create a new VM instance and click **Create Instance** - 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) - Choose Ubuntu 16.04 LTS as your boot disk -- Check the boxes for **Allow HTTP traffic** and **Allow HTTPS traffic** in the **Firewall** section +- Expand the "Management, security, disks, networking, sole tenancy" section, go to the "Networking" tab, then under network tags add "code-server" - Create your VM, and **take note** of its public IP address. +- 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. - Copy the link to download the latest Linux binary from our [releases page](https://github.com/cdr/code-server/releases) --- @@ -53,19 +54,13 @@ chmod +x code-server > To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md) - Start the code-server -``` -sudo ./code-server -p 80 -``` + ``` + ./code-server + ``` +- 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**. > 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 -- Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. -> example: 32.32.32.234 - -- 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"** - -- Then click **"proceed anyway"** - --- > 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). diff --git a/doc/assets/chrome_confirm.png b/doc/assets/chrome_confirm.png deleted file mode 100644 index 037029e1..00000000 Binary files a/doc/assets/chrome_confirm.png and /dev/null differ diff --git a/doc/self-hosted/index.md b/doc/self-hosted/index.md index 008aac3b..17bf6c96 100644 --- a/doc/self-hosted/index.md +++ b/doc/self-hosted/index.md @@ -25,8 +25,7 @@ It takes just a few minutes to get your own self-hosted server running. If you'v > NOTE: Be careful with your password as sharing it will grant those users access to your server's file system ### Things To Know -- 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"** -- Then click **"proceed anyway"** +- 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**. ## Usage 
code-server --help
@@ -94,7 +93,7 @@ Options: } } ``` - + ### Apache Reverse Proxy 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. ``` @@ -106,7 +105,7 @@ Options: RewriteRule /(.*) ws://localhost:8443/$1 [P,L] RewriteCond %{HTTP:Upgrade} !=websocket [NC] RewriteRule /(.*) http://localhost:8443/$1 [P,L] - + ProxyRequests off RequestHeader set X-Forwarded-Proto https @@ -118,6 +117,6 @@ Options: ``` *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 - + ### Help Use `code-server --help` to view the usage for the CLI. This is also shown at the beginning of this section.