91a98b8082
* Fixed documentation based on latest release * Fixed google-cloud documentation steps order * Edited docs based on the latest release versions * Make docs more dynamic based on Releases * Changed ordered list to unordered list
70 lines
4.6 KiB
Markdown
70 lines
4.6 KiB
Markdown
# Deploy on AWS
|
|
|
|
This tutorial shows you how to deploy `code-server` on an EC2 AWS 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. You can also try out the IDE on a container hosted [by Coder](http://coder.com/signup)
|
|
|
|
---
|
|
|
|
## 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 16.04 LTS (HVM), SSD Volume Type (`ami-0f9cf087c1f27d9b1)` at this time of writing)
|
|
- 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")
|
|
> 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**
|
|
---
|
|
### 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" ubuntu@ec2-3-45-678-910.compute-1.amazonaws.co`
|
|
- 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/codercom/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/codercom/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
|
|
```
|
|
sudo ./code-server-linux -p 80
|
|
```
|
|
- 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">
|
|
- Then click **"proceed anyway"**<img src="../../assets/chrome_confirm.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
|
|
|
|
> 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/codercom/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).
|