forked from coder/code-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request coder#916 from cdr/doc-rewrite
Rewrite and update documentation
- Loading branch information
Showing
12 changed files
with
716 additions
and
259 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,66 +1,116 @@ | ||
| # Deploy on AWS | ||
| # Deploy on AWS EC2 | ||
|
|
||
| This tutorial shows you how to deploy `code-server` on an EC2 AWS instance. | ||
| This tutorial shows you how to deploy `code-server` on an AWS EC2 instance. | ||
|
|
||
| If you're just starting out, we recommend [installing code-server locally](../../self-hosted/index.md). It takes only a few minutes and lets you try out all of the features. | ||
| If you're just starting out, we recommend | ||
| [installing code-server locally](self-hosted-docs). It takes only a few minutes | ||
| and lets you try out all of the features locally. | ||
|
|
||
| If you get stuck or need help at anytime, [file an issue](create-issue), | ||
| [tweet (@coderhq)](twitter-coderhq) or [email](email-coder). | ||
|
|
||
| [self-hosted-docs]: ../../self-hosted/index.md | ||
| [create-issue]: https://github.com/cdr/code-server/issues/new?title=Improve+AWS+quickstart+guide | ||
| [twitter-coderhq]: https://twitter.com/coderhq | ||
| [email-coder]: mailto:[email protected]?subject=AWS%20quickstart%20guide | ||
|
|
||
| --- | ||
|
|
||
| ### Creating an Instance using the AWS Launch Wizard | ||
|
|
||
| 1. Click **Launch Instance** from your [EC2 dashboard](ec2-home). | ||
| 2. Select the "Ubuntu Server 18.04 LTS (HVM), SSD Volume Type" AMI.. | ||
| 3. 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**. | ||
| 4. 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](ec2-sg-docs) to allow | ||
| > access from known IP addresses only. | ||
| 5. Click **Launch**. | ||
| 6. You will be prompted to create a keypair. | ||
| > A key pair consists of a public key that AWS stores, and a private key file | ||
| > that you store. For Linux AMIs, the private key file allows you to | ||
| > securely SSH into your instance. | ||
| 7. From the dropdown choose "create a new pair", give the key pair a name. | ||
| 8. Click **Download Key Pair**. This is necessary before you proceed. A `.pem` | ||
| file will be downloaded. make sure you store is in a safe location because it | ||
| can't be retrieved once we move on. | ||
| 9. Finally, click **Launch Instances**. | ||
|
|
||
| [ec2-home]: https://console.aws.amazon.com/ec2/v2/home | ||
| [ec2-sg-docs]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-network-security.html?icmpid=docs_ec2_console | ||
|
|
||
| --- | ||
|
|
||
| ## Deploy to EC2 | ||
|
|
||
| ### Use the AWS wizard | ||
|
|
||
| - Click **Launch Instance** from your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home). | ||
| - 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 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 | ||
| > A key pair consists of a public key that AWS stores, and a private key file that you store. Together, they allow you to connect to your instance securely. For Windows AMIs, the private key file is required to obtain the password used to log into your instance. For Linux AMIs, the private key file allows you to securely SSH into your instance. | ||
| - From the dropdown choose "create a new pair", give the key pair a name | ||
| - Click **Download Key Pair** | ||
| > This is necessary before you proceed. A `.pem` file will be downloaded. make sure you store is in a safe location because it can't be retrieved once we move on. | ||
| - Finally, click **Launch Instances** | ||
| ### Installing code-server onto an AWS Instance | ||
|
|
||
| 1. First head to your [EC2 dashboard](ec2-home) and choose **Instances** on the | ||
| left sidebar. | ||
| 2. Select the instance you just created, and in the description tab at the | ||
| bottom of the screen copy the **Public DNS (IPv4)** address using the copy to | ||
| clipboard button. | ||
| 3. Open a terminal on your computer and use the following command to SSH into | ||
| your EC2 instance. If you're using Windows, you can use [PuTTY](putty-guide) | ||
| to open an SSH connection. | ||
| ``` | ||
| ssh -i "path/to/your/keypair.pem" ubuntu@(paste the public DNS here) | ||
| ``` | ||
| > For example: `ssh -i "/Users/John/Downloads/TestInstance.pem" [email protected]` | ||
| 4. If you get a warning about an unknown server key fingerprint, type "yes" to | ||
| approve the remote host. | ||
| 5. You should see a prompt for your EC2 instance like so: | ||
| <img src="../../assets/aws_ubuntu.png"> | ||
| 6. At this point it is time to download the `code-server` binary. We will, of | ||
| course, want the linux version. Find the latest code-server release from the | ||
| [GitHub releases](code-server-latest) page. | ||
| 7. Right click the Linux x64 `.tar.gz` release asset and copy the URL. In the | ||
| SSH terminal, run the following command: | ||
| ``` | ||
| wget (paste the URL here) | ||
| ``` | ||
| 8. Extract the downloaded file with the following command: | ||
| ``` | ||
| tar -xvzf code-server*.tar.gz | ||
| ``` | ||
| 9. Navigate to extracted directory with this command: | ||
| ``` | ||
| cd code-server*/ | ||
| ``` | ||
| 10. Ensure the code-server binary is executable with the following command: | ||
| ``` | ||
| chmod +x code-server | ||
| ``` | ||
| 11. Finally, to start code-server run this command: | ||
| ``` | ||
| ./code-server | ||
| ``` | ||
| 12. code-server will start up, and the password will be printed in the output. | ||
| Make sure to copy the password for the next step. | ||
| 13. 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"> | ||
|
|
||
| [putty-guide]: https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/putty.html | ||
| [code-server-latest]: https://github.com/cdr/code-server/releases/latest | ||
|
|
||
| --- | ||
| ### SSH Into EC2 Instance | ||
| - First head to your [EC2 dashboard](https://console.aws.amazon.com/ec2/v2/home) and choose instances from the left panel | ||
| - In the description of your EC2 instance copy the public DNS (iPv4) address using the copy to clipboard button | ||
| - Open a terminal on your computer and use the following command to SSH into your EC2 instance | ||
| ``` | ||
| ssh -i "path/to/your/keypair.pem" ubuntu@(paste the public DNS here) | ||
| ``` | ||
| >example: `ssh -i "/Users/John/Downloads/TestInstance.pem" [email protected]` | ||
| - You should see a prompt for your EC2 instance like so<img src="../../assets/aws_ubuntu.png"> | ||
| - At this point it is time to download the `code-server` binary. We will of course want the linux version. | ||
| - Find the latest Linux release from this URL: | ||
| ``` | ||
| https://github.com/cdr/code-server/releases/latest | ||
| ``` | ||
| - Replace {version} in the following command with the version found on the releases page and run it (or just copy the download URL from the releases page): | ||
| ``` | ||
| wget https://github.com/cdr/code-server/releases/download/{version}/code-server{version}-linux-x64.tar.gz | ||
| ``` | ||
| - Extract the downloaded tar.gz file with this command, for example: | ||
| ``` | ||
| tar -xvzf code-server{version}-linux-x64.tar.gz | ||
| ``` | ||
| - Navigate to extracted directory with this command: | ||
| ``` | ||
| cd code-server{version}-linux-x64 | ||
| ``` | ||
| - If you run into any permission errors, make the binary executable by running: | ||
| ``` | ||
| 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) | ||
| - Finally, run | ||
| ``` | ||
| ./code-server | ||
| ``` | ||
| - 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"> | ||
|
|
||
| > 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 | ||
| --- | ||
| > 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:[email protected]?subject=Self-hosted%20quickstart%20guide). | ||
|
|
||
| ### Post Installation Steps | ||
|
|
||
| To ensure the connection between you and your server is encrypted, view our | ||
| guides on [securing your setup](security-guide). | ||
|
|
||
| For instructions on how to keep the server running after you end your SSH | ||
| session please checkout [how to use systemd](systemd-guide). systemd will run | ||
| code-server for you in the background as a service and restart it for you if it | ||
| crashes. | ||
|
|
||
| [security-guide]: ../../security/index.md | ||
| [systemd-guide]: https://www.digitalocean.com/community/tutorials/how-to-configure-a-linux-service-to-start-automatically-after-a-crash-or-reboot-part-1-practical-examples |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,47 +2,124 @@ | |
|
|
||
| This tutorial shows you how to deploy `code-server` to a single node running on DigitalOcean. | ||
|
|
||
| If you're just starting out, we recommend [installing code-server locally](../../self-hosted/index.md). It takes only a few minutes and lets you try out all of the features. | ||
| If you're just starting out, we recommend | ||
| [installing code-server locally](self-hosted-docs). It takes only a few minutes | ||
| and lets you try out all of the features locally. | ||
|
|
||
| If you get stuck or need help at anytime, [file an issue](create-issue), | ||
| [tweet (@coderhq)](twitter-coderhq) or [email](email-coder). | ||
|
|
||
| [self-hosted-docs]: ../../self-hosted/index.md | ||
| [create-issue]: https://github.com/cdr/code-server/issues/new?title=Improve+DigitalOcean+quickstart+guide | ||
| [twitter-coderhq]: https://twitter.com/coderhq | ||
| [email-coder]: mailto:[email protected]?subject=DigitalOcean%20quickstart%20guide | ||
|
|
||
| --- | ||
|
|
||
| ## Use the "Create Droplets" wizard | ||
|
|
||
| [Open your DigitalOcean dashboard](https://cloud.digitalocean.com/droplets/new) to create a new droplet | ||
|
|
||
| - **Choose an image -** Select the **Distributions** tab and then choose Ubuntu | ||
| - **Choose a size -** We recommend at least 4GB RAM and 2 CPU, more depending on team size and number of repositories/languages enabled. | ||
| - Launch your instance | ||
| - Open a terminal on your computer and SSH into your instance | ||
| > example: ssh [email protected] | ||
| - Once in the SSH session, visit code-server [releases page](https://github.com/cdr/code-server/releases/) and copy the link to the download for the latest linux release | ||
| - Find the latest Linux release from this URL: | ||
| ``` | ||
| https://github.com/cdr/code-server/releases/latest | ||
| ``` | ||
| - Replace {version} in the following command with the version found on the releases page and run it (or just copy the download URL from the releases page): | ||
| ``` | ||
| wget https://github.com/cdr/code-server/releases/download/{version}/code-server{version}-linux-x64.tar.gz | ||
| ``` | ||
| - Extract the downloaded tar.gz file with this command, for example: | ||
| ``` | ||
| tar -xvzf code-server{version}-linux-x64.tar.gz | ||
| ``` | ||
| - Navigate to extracted directory with this command: | ||
| ``` | ||
| cd code-server{version}-linux-x64 | ||
| ``` | ||
| - If you run into any permission errors when attempting to run the binary: | ||
| ``` | ||
| 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) | ||
| - Finally start the code-server | ||
| ``` | ||
| ./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 | ||
| - 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"> | ||
| ### Recommended: Using the Marketplace | ||
|
|
||
| [](https://marketplace.digitalocean.com/apps/code-server?action=deploy) | ||
|
|
||
| 1. On the **Create Droplets** page, choose a plan for your new code-server | ||
| instance. We recommend picking an instance with at least 4 GB of RAM and 2 | ||
| CPU cores, or more depending on team size and number of | ||
| repositories/languages enabled. | ||
| 2. Optionally enable backups and add block storage. | ||
| 3. Choose the closest available region to your physical location to reduce | ||
| latency. | ||
| 4. Select an SSH key that you already have in your account, or click **New SSH | ||
| Key** and follow the tutorial on how to make your own SSH key. | ||
| 5. Click **Create Droplet**, then click on the droplet to expand it. | ||
| 6. While you're waiting for the droplet to deploy, copy the **IPv4** address. | ||
| 7. Once the droplet is ready, connect using SSH with the key you specified or | ||
| created earlier. You should be greeted with information on how to access your | ||
| code-server instance and how to view/change the password. | ||
| > You can SSH into your server using PuTTY or by running | ||
| > `ssh root@(paste ipv4 address here)`. | ||
| 8. In the droplet's terminal, run `cat /etc/code-server/pass` to view the | ||
| code-server password. | ||
| 9. Open your browser and visit `https://$public_ip` (where `$public_ip` | ||
| is your Droplet'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"> | ||
|
|
||
| --- | ||
| > 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:[email protected]?subject=Self-hosted%20quickstart%20guide). | ||
|
|
||
| ### Using the "Create Droplets" Wizard | ||
|
|
||
| If you used the Marketplace to set up code-server, you don't need to follow this | ||
| section. | ||
|
|
||
| [Open your DigitalOcean dashboard](create-droplet) to create a new droplet. | ||
|
|
||
| 1. **Choose an image:** Select the **Distributions** tab and then choose | ||
| **Ubuntu 18.04.3 (LTS) x64**. | ||
| 2. **Choose a size:** We recommend at least 4GB RAM and 2 CPU, or more depending | ||
| on team size and number of repositories/languages enabled. | ||
| 3. Select an SSH key that you already have in your account, or click **New SSH | ||
| Key** and follow the tutorial on how to make your own SSH key. | ||
| 4. Click **Create Droplet**, then click on the droplet to expand it. | ||
| 5. While you're waiting for the droplet to deploy, copy the **IPv4** address. | ||
| 6. Once the droplet is ready, connect using SSH with the key you specified or | ||
| created earlier. You should be greeted with information on how to access your | ||
| code-server instance and how to view/change the password. | ||
| > You can SSH into your server using PuTTY or by running | ||
| > `ssh root@(paste ipv4 address here)`. | ||
| 7. If you get a warning about an unknown server key fingerprint, type "yes" to | ||
| approve the remote host. | ||
| 8. You should see a prompt for your Droplet like so: | ||
| <img src="../../assets/digitalocean_ubuntu.png"> | ||
| 9. At this point it is time to download the `code-server` binary. We will, of | ||
| course, want the linux version. Find the latest code-server release from the | ||
| [GitHub releases](code-server-latest) page. | ||
| 10. Right click the Linux x64 `.tar.gz` release asset and copy the URL. In the | ||
| SSH terminal, run the following command: | ||
| ``` | ||
| wget (paste the URL here) | ||
| ``` | ||
| 11. Extract the downloaded file with the following command: | ||
| ``` | ||
| tar -xvzf code-server*.tar.gz | ||
| ``` | ||
| 12. Navigate to extracted directory with this command: | ||
| ``` | ||
| cd code-server*/ | ||
| ``` | ||
| 13. Ensure the code-server binary is executable with the following command: | ||
| ``` | ||
| chmod +x code-server | ||
| ``` | ||
| 14. Finally, to start code-server run this command: | ||
| ``` | ||
| ./code-server | ||
| ``` | ||
| 12. code-server will start up, and the password will be printed in the output. | ||
| Make sure to copy the password for the next step. | ||
| 13. Open your browser and visit `https://$public_ip:8443/` (where `$public_ip` | ||
| is your Droplet'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"> | ||
|
|
||
| [create-droplet]: https://cloud.digitalocean.com/droplets/new | ||
| [code-server-latest]: https://github.com/cdr/code-server/releases/latest | ||
|
|
||
| --- | ||
|
|
||
| ### Post Installation Steps | ||
|
|
||
| To ensure the connection between you and your server is encrypted, view our | ||
| guides on [securing your setup](security-guide). | ||
|
|
||
| For instructions on how to keep the server running after you end your SSH | ||
| session please checkout [how to use systemd](systemd-guide). systemd will run | ||
| code-server for you in the background as a service and restart it for you if it | ||
| crashes. (Note: this doesn't apply for users of the Marketplace Droplet image.) | ||
|
|
||
| [security-guide]: ../../security/index.md | ||
| [systemd-guide]: https://www.digitalocean.com/community/tutorials/how-to-configure-a-linux-service-to-start-automatically-after-a-crash-or-reboot-part-1-practical-examples | ||
Oops, something went wrong.