From 91a98b8082e03b5aa78d680f5f9cc998bc168acf Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Mon, 18 Mar 2019 19:15:20 +0330 Subject: [PATCH] Fixed documentation download links based on latest version (#130) * 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 --- doc/admin/install/aws.md | 20 ++++++++++--- doc/admin/install/digitalocean.md | 18 ++++++++++-- doc/admin/install/google_cloud.md | 49 +++++++++++++++++++++++-------- 3 files changed, 68 insertions(+), 19 deletions(-) diff --git a/doc/admin/install/aws.md b/doc/admin/install/aws.md index 2cda4d4b7..90038fdc4 100644 --- a/doc/admin/install/aws.md +++ b/doc/admin/install/aws.md @@ -32,14 +32,26 @@ If you're just starting out, we recommend [installing code-server locally](../.. ``` >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 -- At this point it is time to download the `code-server` binary. We will of course want the linux version. Make sure you copy the link for the latest linux version on our [releases page](https://github.com/codercom/code-server/releases) -- With the URL in the clipboard, run: +- 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: ``` - wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux + 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-linux + 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 diff --git a/doc/admin/install/digitalocean.md b/doc/admin/install/digitalocean.md index 7512933e6..1a83d7bdb 100644 --- a/doc/admin/install/digitalocean.md +++ b/doc/admin/install/digitalocean.md @@ -16,13 +16,25 @@ If you're just starting out, we recommend [installing code-server locally](../.. - Open a terminal on your computer and SSH into your instance > example: ssh root@203.0.113.0 - Once in the SSH session, visit code-server [releases page](https://github.com/codercom/code-server/releases/) and copy the link to the download for the latest linux release -- In the shell run the below command with the URL from your clipboard +- Find the latest Linux release from this URL: ``` - wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux + 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 when attempting to run the binary: ``` - chmod +x code-server-linux + 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 diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index 05fc39105..867588e1e 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -20,27 +20,52 @@ If you're just starting out, we recommend [installing code-server locally](../.. ## Final Steps -1. SSH into your Google Cloud VM +- SSH into your Google Cloud VM ``` gcloud compute ssh --zone [region] [instance name] ``` -2. Download the binary using the link we copied to clipboard + +- Find the latest Linux release from this URL: ``` -wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux +https://github.com/codercom/code-server/releases/latest ``` -3. Make the binary executable if you run into any errors regarding permission: - ``` - chmod +x code-server-linux - ``` -> To ensure the connection between you and your server is encrypted view our guide on [securing your setup](../../security/ssl.md) -4. Start the code-server + +- 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 +``` + +- Make the binary executable if you run into any errors regarding permission: +``` +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-linux -p 80 ``` + > 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 -5. Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. + +- Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. > example: 32.32.32.234 -6. 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"** -7. Then click **"proceed anyway"** + +- 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/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).