From 77c5b06006c8c9718e93b10f57577ab932ddeab7 Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Fri, 8 Mar 2019 14:19:01 +0330 Subject: [PATCH 1/5] Fixed documentation based on latest release --- doc/admin/install/aws.md | 6 +++++- doc/admin/install/digitalocean.md | 6 +++++- doc/admin/install/google_cloud.md | 11 ++++++++--- 3 files changed, 18 insertions(+), 5 deletions(-) diff --git a/doc/admin/install/aws.md b/doc/admin/install/aws.md index 6be6cd260032..db7ee6f9f771 100644 --- a/doc/admin/install/aws.md +++ b/doc/admin/install/aws.md @@ -35,7 +35,11 @@ If you're just starting out, we recommend [installing code-server locally](../.. - 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: ``` - wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux + wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz + ``` +- Extract the downloaded tar.gz file with this command: + ``` + tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` - If you run into any permission errors, make the binary executable by running: ``` diff --git a/doc/admin/install/digitalocean.md b/doc/admin/install/digitalocean.md index e702f50a421e..7a19d30814ac 100644 --- a/doc/admin/install/digitalocean.md +++ b/doc/admin/install/digitalocean.md @@ -18,7 +18,11 @@ If you're just starting out, we recommend [installing code-server locally](../.. - 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 ``` - wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux + wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz + ``` +- Extract the downloaded tar.gz file with this command: + ``` + tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` - If you run into any permission errors when attempting to run the binary: ``` diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index 9c5e4f6bcef0..fcb713207f82 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -26,14 +26,19 @@ gcloud compute ssh --zone [region] [instance name] ``` 2. Download the binary using the link we copied to clipboard ``` -wget https://github.com/codercom/code-server/releases/download/0.1.4/code-server-linux +wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz ``` -3. Make the binary executable if you run into any errors regarding permission: +3. Extract the downloaded tar.gz file with this command: +``` +tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz +``` + +4. 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 +5. Start the code-server ``` sudo ./code-server-linux -p 80 ``` From 42621f7296fd03652f0f9463ab11cd2008643cf4 Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Fri, 8 Mar 2019 14:21:31 +0330 Subject: [PATCH 2/5] Fixed google-cloud documentation steps order --- doc/admin/install/google_cloud.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index fcb713207f82..444f1b5046c4 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -32,7 +32,6 @@ wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-s ``` tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` - 4. Make the binary executable if you run into any errors regarding permission: ``` chmod +x code-server-linux @@ -43,9 +42,9 @@ tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz 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. +6. 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"** +7. 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"** +8. 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). \ No newline at end of file From 68a4737b450ecbff0651810300a32bb23e886972 Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Mon, 11 Mar 2019 00:57:30 +0330 Subject: [PATCH 3/5] Edited docs based on the latest release versions --- doc/admin/install/aws.md | 8 ++++---- doc/admin/install/digitalocean.md | 6 +++--- doc/admin/install/google_cloud.md | 23 +++++++++++++++++------ 3 files changed, 24 insertions(+), 13 deletions(-) diff --git a/doc/admin/install/aws.md b/doc/admin/install/aws.md index db7ee6f9f771..593e3d8c7204 100644 --- a/doc/admin/install/aws.md +++ b/doc/admin/install/aws.md @@ -32,12 +32,12 @@ 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 and download the latest Linux release from this URL: ``` - wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz + https://github.com/codercom/code-server/releases/latest ``` -- Extract the downloaded tar.gz file with this command: +- Extract the downloaded tar.gz file with this command, for example: ``` tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` diff --git a/doc/admin/install/digitalocean.md b/doc/admin/install/digitalocean.md index 7a19d30814ac..4020084874fa 100644 --- a/doc/admin/install/digitalocean.md +++ b/doc/admin/install/digitalocean.md @@ -16,11 +16,11 @@ 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 and download the latest Linux release from this URL: ``` - wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz + https://github.com/codercom/code-server/releases/latest ``` -- Extract the downloaded tar.gz file with this command: +- Extract the downloaded tar.gz file with this command, for example: ``` tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index 444f1b5046c4..df680d358f35 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -24,27 +24,38 @@ If you're just starting out, we recommend [installing code-server locally](../.. ``` gcloud compute ssh --zone [region] [instance name] ``` -2. Download the binary using the link we copied to clipboard + +2. Find and download the latest Linux release from this URL: ``` -wget https://github.com/codercom/code-server/releases/download/1.31.1-100/code-server-1.31.1-100-linux-x64.tar.gz +https://github.com/codercom/code-server/releases/latest ``` -3. Extract the downloaded tar.gz file with this command: + +3. Extract the downloaded tar.gz file with this command, for example: ``` tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz ``` + 4. Make the binary executable if you run into any errors regarding permission: - ``` - chmod +x code-server-linux - ``` +``` +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) + 5. 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 + 6. Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. > example: 32.32.32.234 + 7. 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"** + 8. 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). \ No newline at end of file From 54d5b33d0fa56331f60c53a07faf2dea8ebf66ed Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Sat, 16 Mar 2019 12:48:13 +0330 Subject: [PATCH 4/5] Make docs more dynamic based on Releases --- doc/admin/install/aws.md | 14 +++++++++++--- doc/admin/install/digitalocean.md | 14 +++++++++++--- doc/admin/install/google_cloud.md | 28 +++++++++++++++++++--------- 3 files changed, 41 insertions(+), 15 deletions(-) diff --git a/doc/admin/install/aws.md b/doc/admin/install/aws.md index 593e3d8c7204..cab9732bd879 100644 --- a/doc/admin/install/aws.md +++ b/doc/admin/install/aws.md @@ -33,17 +33,25 @@ 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. -- Find and download the latest Linux release from this URL: +- 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-1.31.1-100-linux-x64.tar.gz + 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 4020084874fa..41600be24d53 100644 --- a/doc/admin/install/digitalocean.md +++ b/doc/admin/install/digitalocean.md @@ -16,17 +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 -- Find and download the latest Linux release from this URL: +- 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-1.31.1-100-linux-x64.tar.gz + 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 df680d358f35..2dcc5bbc4dc8 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -25,36 +25,46 @@ If you're just starting out, we recommend [installing code-server locally](../.. gcloud compute ssh --zone [region] [instance name] ``` -2. Find and download the latest Linux release from this URL: +2. Find the latest Linux release from this URL: ``` https://github.com/codercom/code-server/releases/latest ``` -3. Extract the downloaded tar.gz file with this command, for example: +3. 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): ``` -tar -xvzf code-server-1.31.1-100-linux-x64.tar.gz +wget https://github.com/codercom/code-server/releases/download/{version}/code-server-{version}-linux-x64.tar.gz ``` -4. Make the binary executable if you run into any errors regarding permission: +4. Extract the downloaded tar.gz file with this command, for example: ``` -chmod +x code-server-linux +tar -xvzf code-server-{version}-linux-x64.tar.gz +``` + +5. Navigate to extracted directory with this command: +``` +cd code-server-{version}-linux-x64 +``` + +6. 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) -5. Start the code-server +7. 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 -6. Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. +8. Access code-server from the public IP of your Google Cloud instance we noted earlier in your browser. > example: 32.32.32.234 -7. 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"** +9. 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"** -8. Then click **"proceed anyway"** +10. Then click **"proceed anyway"** --- From 1bfdd3e6b631860aaf823b0e3f5b2620b12af607 Mon Sep 17 00:00:00 2001 From: Moien Tajik Date: Sat, 16 Mar 2019 23:40:07 +0330 Subject: [PATCH 5/5] Changed ordered list to unordered list --- doc/admin/install/google_cloud.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/doc/admin/install/google_cloud.md b/doc/admin/install/google_cloud.md index 86a517e24378..7411e7f6740e 100644 --- a/doc/admin/install/google_cloud.md +++ b/doc/admin/install/google_cloud.md @@ -20,51 +20,51 @@ 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. Find the latest Linux release from this URL: +- Find the latest Linux release from this URL: ``` https://github.com/codercom/code-server/releases/latest ``` -3. 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): +- 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 ``` -4. Extract the downloaded tar.gz file with this command, for example: +- Extract the downloaded tar.gz file with this command, for example: ``` tar -xvzf code-server-{version}-linux-x64.tar.gz ``` -5. Navigate to extracted directory with this command: +- Navigate to extracted directory with this command: ``` cd code-server-{version}-linux-x64 ``` -6. Make the binary executable if you run into any errors regarding permission: +- 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) -7. Start the code-server +- 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 -8. 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 -9. 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"** +- 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"** -10. Then click **"proceed anyway"** +- Then click **"proceed anyway"** ---