Update markdown text

This commit is contained in:
LMurphy001 2021-08-25 23:17:04 -04:00
parent 37f4479297
commit 030734f351
12 changed files with 199 additions and 135 deletions

View File

@ -2,41 +2,41 @@
Currently, the official catalogue of Coop-Cloud apps is at [App catalogue]( https://docs.coopcloud.tech/apps/). There's an experimental version of the catalogue in the works; you can see the link to it in the image.
![00](00.png "00")
![00](../res/custom-html-deploy/00.png "00")
We'll be deploying Custom HTML by following the instructions in "Basic usage" below.
![01](0.1.png "0.1")
![01](../res/custom-html-deploy/0.1.png "0.1")
1. Let's create a minimal HTML5 web page. Launch your WSL Linux system. Create a file called index.html. The example below uses the nano text editor.
![04](04.png "04")
![04](../res/custom-html-deploy/04.png "04")
1. Assuming you have previously copied basic HTML5 code into the clipboard, you can right-click the top of the Linux command window, slide down to Edit, slide over to Paste and click on it.
![05](05.png "05")
![05](../res/custom-html-deploy/05.png "05")
This is what nano looks like after pasting a minimal HTML5 document into it. Use Ctrl-O to save the file, and Ctrl-X to exit the nano editor.
![06](06.png "06")
![06](../res/custom-html-deploy/06.png "06")
1. Create the custom html app on your Capsul using Abra. The app is associated with the server named *coolstuff.ninja*. It will be listening at the domain name *coolstuff.ninja*, that is, after it is deployed, when you type https://coolstuff.ninja, you will see the minimal html5 page we've just saved in index.html. The --app-name option tells Abra to name the app *custom-html-ninj*.
> abra app new custom-html --server coolstuff.ninja --domain coolstuff.ninja --app-name custom-html-ninj
![07](07.png "07")
![07](../res/custom-html-deploy/07.png "07")
1. After abra finishes adding the new app, you can check out its configuration:
> abra app custom-html-ninj config
![08](08.png "08")
![08](../res/custom-html-deploy/08.png "08")
This opens custom-html-ninj's configuration in a text editor, and you could update any values which need to be updated. In this case, everything looks good, so we don't make any changes.
![09](09.png "09")
![09](../res/custom-html-deploy/09.png "09")
1. It's time to deploy the app. It's a very basic app, and so the command line to deploy it is very simple. Type 'y' to confirm the deployment. After a few moments, you should see *SUCCESS: Yay! App should be available at **domain-name***.
You need to copy the index.html file into the custom-html-ninj app.
> abra app custom-html-ninj cp index.html app:/usr/share/nginx/html
![10](10.png "10")
![10](../res/custom-html-deploy/10.png "10")
1. Finally, open your website using your browser. https://your-domain-name
![11](11.png "11")
![11](../res/custom-html-deploy/11.png "11")
You should see "This is the Title" in the page's title, and "This is the page content." on the page.

View File

@ -1,11 +1,22 @@
![Add traefik app to server](03.png "Add traefik app to server")
# Add the Traefik App to Your Capsul:
1. Add app to server
![Add traefik app to server](../res/traefik/03.png "Add traefik app to server")
![Open editor for traefik app config](04.png "Open editor for traefik app config")
2. Open Traefik's configuration file:
![Open editor for traefik app config](../res/traefik/04.png "Open editor for traefik app config")
![Change Lets Encrypt email address](05.png "Change Lets Encrypt email address")
3. Update the Let's Encrypt email address:
![Change Lets Encrypt email address](../res/traefik/05.png "Change Lets Encrypt email address")
![Deploy traefik, wait](06.png "Deply traefik, wait")
4. Deploy traefik
![Deploy traefik, wait](../res/traefik/06.png "Deploy traefik, wait")
![Use ps to check traefik state](07.png "Use ps to check traefik state")
5. Use ps to check if traefik is up and running.
![Use ps to check traefik state](../res/traefik/07.png "Use ps to check traefik state")
![Open traefik dashboard in browser](08.png "Open traefik dashboard in browser")
6. View traefik's dashboard by opening it in the browser
![Open traefik dashboard in browser](../res/traefik/08.png "Open traefik dashboard in browser")
The next step is to install your first app!
| [Previous](setup-server.md) | [Next](add-1stapp-deploy) | [Top](../README.md) |

View File

@ -1,16 +1,16 @@
# Create an account with yolo.servers.coop
1. Open <https://yolo.servers.coop> in your browser. Click on *Login* in the upper right corner.
![yolo home page](01-yolo-home-page.png "yolo home page")
![yolo home page](../res/coop-cloud-acct/01-yolo-home-page.png "yolo home page")
1. Fill in your email address in the box. You will need to use this email address multiple times, so do not use a throw-away email address. Click the *Log In* button.
![yolo login page](02-yolo-login.png "yolo login page")
![yolo login page](../res/coop-cloud-acct/02-yolo-login.png "yolo login page")
1. Open your email client and look for a new email with subject **Click This Link to Login to Capsul** and open the email.
![new email](04-email-click-this-subject.png "new email")
![new email](../res/coop-cloud-acct/04-email-click-this-subject.png "new email")
The email message contains an authorization link to your new account on yolo.servers.coop. Click the link, or copy and paste it into your browser's address bar.
![click link in email](05-email-click-this.png "click link in email message")
![click link in email](../res/coop-cloud-acct/05-email-click-this.png "click link in email message")
The browser will open a page with your email address in the upper right corner.
When the browser opens a page with your email address in the upper right corner, you have created an account with yolol.servers.coop.
| [Next]() | [Top](../README.md) |
| [Next](upload-pub-key.md) | [Top](../README.md) |

View File

@ -1,24 +1,32 @@
# Create a Capsul in Your Yolo Account
**Capsul** is software by [Cyberia Club](https://cyberia.club/) for "small virtual machine (vm) as a service."
1. Add funds to your account.
1. Before you can create a Capsule, you must add funds to your account.
1. Click the *Account Balance* link. The method used for payment is called Stripe.
1. Click on the *Add funds with the Credit/Debit (stripe)* link. Fill in an amount in the box. For example, $20.
1. Click on *Pay with Stripe*.
1. Your browser will open the Stripe page. Fill in your email address and your card information. You have the option to save the information so you can pay faster next time.
1. Click the *Pay $20.00* button when done. Wait for it to verify your payment.
1. Return to the *Account Balance* section and verify your ACCOUNT BALANCE
1. Click the *Capsuls* link, and the *Create one!* link. This will open the **CREATE CAPSUL** page.
1. Return to the *Account Balance* section and verify your ACCOUNT BALANCE
1. Click the *Capsuls* link, and then the *Create one!* link. This will open the **CREATE CAPSUL** page.
1. You will see your *account balance*
1. Pick a Capsul Size from the drop-down box. This screenshot shows size *f1-xs* selected.
1. Leave *Debian 10 (Buster)* as the operating system; it's the only one available for Capsuls at this time.
1. Put a check mark in the box next to the name of your public SSH key. In this screenshot, it's named *user-name@host-name*.
1. Pick a Capsul Size from the drop-down box. This screenshot shows size **f1-xs** selected.
1. Leave **Debian 10 (Buster)** as the operating system; it's the only one available for Capsuls at this time.
1. Put a **check mark** in the box next to the name of your public SSH key. In this screenshot, it's named *user-name@host-name*.
1. Click on the *Create* button.
1. Wait for your Capsul to be created and initialized. It shouldn't be more than a minute.
![Create capsule](15-yolo-create-capsule.png "Create capsule")
![Create capsule](../res/create-capsule/15-yolo-create-capsule.png)
1. Check out your new Capsul!
1. Click the Capsul *id* link, which is capsul-fk46nit117 in this example. ![capsule created](16-yolo-capsule-created.png "capsule created")
1. You'll see the details for your new Capsul. You will need two items from this page for later: the *IPv4 Address* (a.k.a. ip address) and the **SSH HOST KEY FINGERPRINTS**.
![capsule details](17-yolo-capsule-details.png "capsule details")
1. It's recommended you copy the fingerprints into a plain text file; Notepad is fine for this: ![save capsul host fingerprints](18-win-notepad-host-fingerprints.png "save capsul host fingerprints")
1. Click the Capsul *id* link, which is capsul-fk46nit117 in this example.
![capsule created](../res/create-capsule/16-yolo-capsule-created.png "capsule created")
1. You'll see the details for your new Capsul. You will need to know two items from this page for later use: the *IPv4 Address* (a.k.a. ip address) and the **SSH HOST KEY FINGERPRINTS**.
![capsule details](../res/create-capsule/17-yolo-capsule-details.png "capsule details")
1. It's recommended you copy the fingerprints into a plain text file; Notepad is fine for this: ![save capsul host fingerprints](../res/create-capsule/18-win-notepad-host-fingerprints.png "save capsul host fingerprints")
*Congratulations! You have created your Capsul!*
| [Previous](upload-pub-key.md) | [Next](ssh-to-capsul-from-win.md) | [Top](../README.md) |

View File

@ -1,23 +1,38 @@
![01](01.png "01")
# Install Abra on Local Linux System
![02](02.png "02")
After installing WSL2 and Debian (or other Linux distribution) on your Windows system, you are ready to install the *abra* tool.
![03](03.png "03")
Here is the description of abra from it's git repository: abra is a command-line tool for managing your own Co-op Cloud. It can provision new servers, create applications, deploy them, run backup and restore operations and a whole lot of other things. It is the go-to tool for day-to-day operations when managing a Co-op Cloud instance. Abra is undergoing a rewrite and so it is deprecated. It's still in use on a daily basis, but it will be replaced.
![04](04.png "04")
1. On a fresh Debian installation, you should run the following two commands to upgrade it:
![05](05.png "05")
>sudo apt-get update
![06](06.png "06")
![update](../res/install-abra-wsl2-linux/apt-get-update.png)
![07](07.png "07")
>sudo apt-get upgrade
![08](08.png "08")
![upgrade](../res/install-abra-wsl2-linux/apt-get-upgrade.png)
![09](09.png "09")
1. To download the script which will install abra, we need *curl*. Install curl and check it:
![10](10.png "10")
> sudo apt install curl
![11](11.png "11")
![inst-curl](../res/install-abra-wsl2-linux/inst-curl.png)
![check-curl](../res/install-abra-wsl2-linux/chk-curl.png)
| [Previous](../04-Install-WSL2-Linux/README.md) | [Next](../06-WSL2-Linux-ssh/README.md) | [Top](../README.md) |
1. Now we are ready to get the abra installation script:
![inst-abra-locally](../res/install-abra-wsl2-linux/get-abra-inst.png)
![dl-abra](../res/install-abra-wsl2-linux/dl-abra-inst-script.png)
1. Run the abra installation script with bash:
![inst-abra](../res/install-abra-wsl2-linux/inst-abra.png)
1. The abra installation script will ask you if you want to install *docker*. Answer "y"
![inst-docker](../res/install-abra-wsl2-linux/inst-docker.png)
1. When abra installation script completes, update your PATH.
![update-path](../res/install-abra-wsl2-linux/update-path.png)
| [Previous](inst-wsl2-linux.md) | [Next](ssh-to-capsul-from-wsl.md) | [Top](../README.md) |

View File

@ -1,31 +1,20 @@
1. Open [Install server prerequisites](https://docs.coopcloud.tech/deploy#install-server-prerequisites) and scroll down to **Install server prerequisites**. Click on the [*install documentation*](https://docs.docker.com/engine/install/) link.
![01](01.png "01")
1. You will see the page below. Scroll to the **Server** section and find the link for *Debian* and click on it.
![02](02.png "02")
1. fill in 1
![03](03.png "03")
1. fill in 2
![04](04.png "04")
1. fill in 3
![05](05.png "05")
1. fill in 4
![07](07.png "07")
1. fill in 5
![08](08.png "08")
1. fill in 6
![09](09.png "09")
1. fill in 7
![10](10.png "10")
1. fill in 8
![11](11.png "11")
1. fill in 9
![12](12.png "12")
1. fill in 10
![13](13.png "13")
1. fill in 11
![14](14.png "14")
1. fill in 12
![15](15.png "15")
1. fill in 13
# Install Docker Engine on Capsul
| [Previous](../02-Setup-DNS-Records/README.md) | [Next](../04-Install-WSL2-Linux/README.md) | [Top](../README.md) |
1. On Windows, open a cmd.exe window and connect to your capsul using the ssh command. ![ssh-login](../res/install-docker-capsul/ssh-to-capsul.png)
1. In your browser, open https://docs.docker.com/engine/install/debian/ and follow the instructions to **Install Docker Engine on Debian.** After you finish these steps, be sure to do the last step, to add the *user* to the *docker* group.
![000](../res/install-docker-capsul/000.png)
![001](../res/install-docker-capsul/001.png)
![002](../res/install-docker-capsul/002.png)
# Add *user* to the *docker* Group
After installing docker on your capsule, use *sudo usermod* command to add *user* to the *docker* group. Be sure to logout for this change to take effect. When you ssh back into the capsul, the *id* command shows which groups *user* is in.
![13](../res/install-docker-capsul/13.png)
![14](../res/install-docker-capsul/14.png)
![15](../res/install-docker-capsul/15.png)
After installing docker on the capsule and confirming that *user* is in the *docker* group, continue to the next step.
| [Previous](setup-dns.md) | [Next](inst-wsl2-linux.md) | [Top](../README.md) |

View File

@ -22,26 +22,26 @@ If you live your computing life on the bleeding edge, you can get a preview of W
## Lets Do It!!!
Without further ado, let's get WSL2 installed on Windows 10! This guide is following the instructions from this page: [Windows Subsystem for Linux Installation Guide for Windows 10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
There are two options available for install, simplified and manual. This guide goes through the six manual steps. **Note:** If you run into problems, there's a [troubleshooting](https://docs.microsoft.com/en-us/windows/wsl/install-win10#troubleshooting-installation) section at the bottom of the page. ![01](01.png "01")
There are two options available for install, simplified and manual. This guide goes through the six manual steps. **Note:** If you run into problems, there's a [troubleshooting](https://docs.microsoft.com/en-us/windows/wsl/install-win10#troubleshooting-installation) section at the bottom of the page. ![01](../res/install-wsl2-linux/01.png "01")
1. The first step (of six) is to enable the "Windows Subsystem for Linux" feature, aka the Microsoft-Windows-Subsystem-Linux feature. Open an Administrator PowerShell window and run the dism.exe command as shown. Do **NOT** restart your computer yet.
> dism.exe /online /enable-feature /featurename:Microsoft-Windows-Subsystem-Linux /all /norestart
![02](02.png "02")
![03](03.png "03")
![02](../res/install-wsl2-linux/02.png "02")
![03](../res/install-wsl2-linux/03.png "03")
1. The second step (of six) is to make sure your computer meets the requirements shown in the screenshot below, **Step 2- Check Requirements for running WSL 2.** The document says you need version 1903 or higher, with Build 18362 or higher.
You can press Windows logo key + r, type *winver*, press *OK* button, to see your current Windows version and build.
![04](04.5.png)
![04](../res/install-wsl2-linux/04.5.png)
If necessary, go to Settings > Update & Security > Windows Update and click *Check for updates* button to install more Windows Updates.
If your computer gets stuck with Windows Updates, this page may help: [Windows Update Assistant](https://www.microsoft.com/software-download/windows10).
![04](04.png "04")
![04](../res/install-wsl2-linux/04.png "04")
***The purple Note at the bottom of the screenshot might be useful.***
@ -49,53 +49,53 @@ There are two options available for install, simplified and manual. This guide g
> dism.exe /online /enable-feature /featurename:VirtualMachinePlatform /all /norestart
![06](06.png "06")
![06](../res/install-wsl2-linux/06.png "06")
![07](07.png "07")
![07](../res/install-wsl2-linux/07.png "07")
***RESTART YOUR COMPUTER*** to complete the WSL install:
![08](08.png "08")
![08](../res/install-wsl2-linux/08.png "08")
1. Step 4 of 6 is to download Microsoft's Linux Kernel Update and install it. Click the link *WSL2 Linux kernel update package for x64 machines* and save the .msi file to disk.
![09](09.png "09")
![10](10.png "10")
![09](../res/install-wsl2-linux/09.png "09")
![10](../res/install-wsl2-linux/10.png "10")
After saving the .msi file to disk, find the downloaded file in File Explorer. Double-click the wsl_update_x64.msi installer package to install it.
![11](11.png "11")
![12](12.png "12")
![11](../res/install-wsl2-linux/11.png "11")
![12](../res/install-wsl2-linux/12.png "12")
1. Step 5 of 6 is to make WSL2 your default version, instead of WSL being your default version. Run the wsl command shown below. You should see "The operation completed successfully."
> wsl --set-default-version 2
![13](13.png "13")
![14](14.png "14")
![13](../res/install-wsl2-linux/13.png "13")
![14](../res/install-wsl2-linux/14.png "14")
1. Step 6 of 6 is to install your distribution of Linux. In this guide I'll be installing Debian 10 Buster.
![15](15.png "15")
![15](../res/install-wsl2-linux/15.png "15")
The web page shows the following listing to various Linux Distributions. Clicking on the link will take you to the Distribution in the Microsoft Store.
![16](16.png "16")
![16](../res/install-wsl2-linux/16.png "16")
You can also view the list of Linux Distributions by running a wsl command:
> wsl --list --online
![18](18.png "18")
![18](../res/install-wsl2-linux/18.png "18")
Pick which Linux distribution you want to install, and either click one of the links on Microsoft's web page, or do a search in the Microsoft Store.
When you've found your distro in the store, you first need to click the *Get* button and then the *Launch* button.
If you see a popup window like this, you can close it. You don't need a Windows account to get and install Linux distros from the Microsoft Store.
![19](19.png "19")
![19](../res/install-wsl2-linux/19.png "19")
Here's the Debian distro in the store. I've already gotten it once before, so I don't see the *Get* button. I just need to install and launch it.:
![20](20.png "20")
![21](21.png "21")
![20](../res/install-wsl2-linux/20.png "20")
![21](../res/install-wsl2-linux/21.png "21")
Here's the Microsoft page image for Getting and Launching the Ubuntu distro. Note that the first time you launch a Linux distro, it will take a few moments to initialize it.
![22](22.png "22")
![22](../res/install-wsl2-linux/22.png "22")
Screenshots of my installation of the Debian distro:
![23](23.png "23")
![23](../res/install-wsl2-linux/23.png "23")
You Linux username does not need to be the same as your Windows username.
![24](24.png "24")
![24](../res/install-wsl2-linux/24.png "24")
Woo hoo! The installation of WSL2 and your Linux distribution is complete.
| [Previous](../03-Install-docker-on-Capsul/README.md) | [Next](../05-Install-Abra-on-WSL2-Linux/README.md) | [Top](../README.md) |
| [Previous](inst-docker-on-capsul.md) | [Next](inst-abra.md) | [Top](../README.md) |

View File

@ -2,12 +2,12 @@ Your Capsul needs a hostname, also known as a domain name. There are many servic
Each domain registrar has a different user interface for managing DNS records. Set up three 'A' records. One for the domain itself, one for www.your-domain-name, and one for subdomains of the domain. It will look something like this:
![set up dns records](01-setup-dns-records.png "set up dns records")
![set up dns records](../res/link-dns-records/01-setup-dns-records.png)
**Be sure to remove CNAME and ALIAS records.**
After you save your updated DNS records, you can verify they've been propagated with the [DNS Checker](https://dnschecker.org/) website. The green check marks indicate the name has been propagated.
![check dns propagation](02-check-dns-propagation.png "check dns propagation")
![check dns propagation](../res/link-dns-records/02-check-dns-propagation.png)
| [Previous](../01-CreateCapsul-and-Login/README.md) | [Next](../03-Install-docker-on-Capsul/README.md) | [Top](../README.md) |
| [Previous](ssh-to-capsul-from-win.md) | [Next](inst-docker-on-capsul.md) | [Top](../README.md) |

View File

@ -1,5 +1,17 @@
![Add server to Abra](01.png "Add server to Abra")
# Add Server and Initialize It
![Initialize docker swarm for server](02.png "Initialize docker swarm for server")
First, add your server to abra. Change *your-domain-name* to your capsul's DNS name, and be sure to specify *user* as the Linux username on the Capsul.
! [Previous](../06-WSL2-Linux-ssh/README.md) | [Next](../08-Deploy-first-app/README.md) | [Top](../README.md) |
> abra server add your-domain-name user
![Add server to Abra](..\res\create-init-context\01.png "Add server to Abra")
Next, after creating the server, initialize the docker swarm.
> abra server your-domain-name init
![Initialize docker swarm for server](..\res\create-init-context\02.png "Initialize docker swarm for server")
The next step is to install Traefik.
| [Previous](ssh-to-capsul-from-wsl.md) | [Next](add-traefik-deploy.md) | [Top](../README.md) |

View File

@ -1,16 +1,23 @@
# Remotely login to your new Capsul using ssh.
1. Open a cmd.exe window
1. Run ssh command. The name of the Linux user on the Capsul is **user**. You'll use the IPv4 address from a previous step.
1. Run the ssh command. The user name of the Linux user on the Capsul is **user**. You'll use the IPv4 address you noted from a previous step.
1. When you run the ssh command, you'll see a line saying the authenticity of the host can't be established. It will show you the key fingerprint.
1. Use the mouse to copy the fingerprint string to the clipboard
1. Open the Capsul fingerprints text file you saved in the previous step.
1. Search for the key fingerprint by pasting it from the clipboard into the text editor's search query box. You should see that the fingerprint from the ssh command matches the fingerprint you saved when you created your Capsul.
1. If it matches, enter "yes" in the command line window prompt "Are you sure you want to continue connecting".
![run ssh and match fingerprints](19-win-match-ssh-fingerprint.png "run ssh and match fingerprints")
1. You are now logged into your remote Capsule. ![first capsule login](20-win-first-capsul-login.png "first capsule login")
1. The default login shell for **user** is dash. If you prefer the bash shell, you can change it with the chsh command, as shown:
![change default shell to bash](21-capsul-change-to-bash-shell.png "change default shell to bash")
1. If it matches, enter "yes" in the command line window prompt "Are you sure you want to continue connecting". ![run ssh and match fingerprints](../res/win-ssh-to-capsul/19-win-match-ssh-fingerprint-shortened.png )
1. You are now logged into your remote Capsule. ![first capsule login](../res/win-ssh-to-capsul/20-win-first-capsul-login.png)
1. The default login shell for **user** is dash. If you prefer the bash shell, you can change it with the chsh command, as shown: ![change default shell to bash](../res/win-ssh-to-capsul/21-capsul-change-to-bash-shell.png)
***Congratulations!*** You have logged into your Capsul from your local Windows computer.
| [Previous](create_capsul.md) | [Next](setup-dns.md) | [Top](../README.md) |

View File

@ -25,25 +25,26 @@ Previously, we logged into the remote capsule using ssh in a Windows cmd.exe win
1. When you try the ssh command, it will say the authenticity of the host can't be established. Copy the fingerprint from the Linux command window to the clipboard.
![run ssh and copy key fingerprint to clipboard](01.png "run ssh and copy key fingerprint to clipboard")
![run ssh and copy key fingerprint to clipboard](../res/wsl-ssh-to-capsul/01.png "run ssh and copy key fingerprint to clipboard")
1. Open your Capsul fingerprints file in Notepad. Compare the fingerprint from the Linux command line *ssh* to the fingerprint in Notepad.
![open fingerprints in notepad and match](02.png "open fingerprints in notepad and match")
![open fingerprints in notepad and match](../res/wsl-ssh-to-capsul/02.png "open fingerprints in notepad and match")
1. If the fingerprints match, type yes and press enter.
![enter 'yes' if fingerprints match](03.png "enter 'yes' if fingerprints match")
![enter 'yes' if fingerprints match](../res/wsl-ssh-to-capsul/03.png "enter 'yes' if fingerprints match")
1. Close the ssh connection to your Capsul's ip address.
1. Open a ssh connection using your Capsul's domain name instead of the ip address.
> ssh user@capsul-domain-name
![run ssh again using domain name instead of ip address](05.png "run ssh again using domain name instead of ip address")
![run ssh again using domain name instead of ip address](../res/wsl-ssh-to-capsul/05.png "run ssh again using domain name instead of ip address")
1. Again, compare the fingerprint of the ssh command with the fingerprint in the capsul-fingerprints file. If they match, type *yes* and Enter. This causes the domain name to be added to the list of known hosts.
1. Close the ssh connection to your remote capsule.
1. Now that you've confirmed your WSL2 Linux system can login to your remote Capsul, proceed with the next step.
Now that you've confirmed your WSL2 Linux system can login to your remote Capsul, proceed with the next step.
[Previous](../05-Install-Abra-on-WSL2-Linux/README.md) | [Next](../07-Setup-Server-Deploy-Traefik/README.md) | [Top](../README.md) |
[Previous](inst-abra.md) | [Next](setup-server.md) | [Top](../README.md) |

View File

@ -1,24 +1,45 @@
# Upload Public SSH Key to Yolo
# Upload Public SSH Key to Your Yolo Account
There is no front-end to your capsul. All access to it will be remote, for example, with *ssh*. You need to create SSH keys and upload them to your account before you can create your capsul.
There is no front-end to your capsul. All access to it will be remote, for example, with *ssh*. You need to create SSH keys and upload your public key to your account before you can create a capsul.
Create SSH Keys on your local Windows computer. This guide explains how to do so using Window's built-in OpenSSH feature. If you prefer [PuTTY](https://en.wikipedia.org/wiki/PuTTY), you can skip these steps and use that instead.
This guide explains how to create SSH Keys on your local Windows computer. The steps describe using Window's built-in OpenSSH feature. If you prefer [PuTTY](https://en.wikipedia.org/wiki/PuTTY), you can skip these steps and use that instead.
1. Open an Administrator PowerShell window.
![open administrator powershell on windows](08-win-admin-power-shell.png "open administrator powershell on windows")
![open administrator powershell on windows](../res/upload-pub-key/08-win-admin-power-shell.png)
1. Use the *get-WindowsCapability* command to find out if Windows already has the OpenSSH client installed.
![is openssh client installed on windows?](09-win-is-openssh-installed.png "is openssh client installed on windows?")
>get-WindowsCapability -Online | ? Name -like 'OpenSSH.client*'
![is openssh client installed on windows?](../res/upload-pub-key/09-win-is-openssh-installed.png)
If you see "State : Installed" in the response, you don't need to add it. If it is not installed, use the *Add-WindowsCapability* command to add it.
![install openssh client on windows if needed](10-win-install-OpenSSH.png "install openssh client on windows if needed")
1. Use the Windows command line:
1. Open a cmd.exe window.
1. *cd* to your home directory. In this example, the home directory is c:\users\userid.
1. Use *dir* to discover if you already have a *.ssh* subdirectory in your home directory.
1. If necessary, use *mkdir .ssh* to create the subdirectory.
1. Run *ssh-keygen.exe* to generate an SSH key pair. Press *enter* key to accept the default filename. Press *enter* key twice to skip adding a passphrase. Your key pair identification is then saved in the *.ssh* subdirectory. You will see a key fingerprint ending in `your-Windows-username@your-Windows-hostname`. You'll also see the key's randomart image.
![create ssh key using ssh-keygen.exe](11-win-ssh-keygen.png "create ssh key using ssh-keygen.exe")
1. Launch Notepad.exe and open file *c:\users\userid\\.ssh\id_rsa.pub*. Select all of the file's contents and copy to the clipboard. ![copy public ssh key to clipboard using notepad.exe](12-win-notepad-cp-pub-ssh-key.png "copy public ssh key to clipboard using notepad.exe")
1. Go to the [**SSH PUBLIC KEYS**](find/the/link/to/this) page in your browser. You'll see a box labeled *File Contents*. Paste your public key from the clipboard into the box. Then, click the *Upload* button. ![paste public key into yolo SSH PUBLIC KEYS page](13-yolo-paste-public-key.png "paste public key into yolo SSH PUBLIC KEYS page")
> Add-WindowsCapability -Online -Name OpenSSH.client~~~~0.0.1.0
1. Your uploaded public key will appear near the top of the page. ![your uploaded public key appears on yolo page](14-yolo-SSH-key-uploaded.png "your uploaded public key appears on yolo page")
![install openssh client on windows if needed](../res/upload-pub-key/10-win-install-OpenSSH.png)
1. Open the Windows cmd.exe command window. Make sure you have a subdirectory named .ssh in your home directory.
> cmd.exe
cd %USERPROFILE%
dir .ssh
mkdir .ssh
c:\windows\system32\OpenSSH\ssh-keygen.exe
Run *ssh-keygen.exe* to generate an SSH key pair. Press *enter* key to accept the default filename. Press *enter* key twice to skip adding a passphrase. Your key pair identification is then saved in the *.ssh* subdirectory. You will see a key fingerprint ending in `your-windows-username@your-windows-hostname`. You'll also see the key's randomart image.
![create ssh key using ssh-keygen.exe](../res/upload-pub-key/11-win-ssh-keygen.png)
1. Launch Notepad.exe and open file *c:\users\userid\\.ssh\id_rsa.pub*. Select all of the file's contents and copy to the clipboard.
![copy public ssh key to clipboard](../res/upload-pub-key/12-win-notepad-cp-pub-ssh-key.png)
1. Open your browser and go to the [**SSH PUBLIC KEYS**](https://yolo.servers.coop/console/keys) page in your browser. You'll see a box labeled *File Contents*. Paste your public key from the clipboard into the box. Then, click the *Upload* button.
![paste public key into yolo SSH PUBLIC KEYS page](../res/upload-pub-key/13-yolo-paste-public-key.png)
1. Your uploaded public key will appear near the top of the page. ![your uploaded public key appears on yolo page](../res/upload-pub-key/14-yolo-SSH-key-uploaded.png "your uploaded public key appears on yolo page")
*Congratulations, you have uploaded your public SSH key to your yolo account.*
| [Previous](create-acct.md) | [Next](create_capsul.md) | [Top](../README.md) |