Bladeren bron

update README

Your Name 8 maanden geleden
bovenliggende
commit
3cc85830ab
1 gewijzigde bestanden met toevoegingen van 19 en 8 verwijderingen
  1. 19 8
      README.md

+ 19 - 8
README.md

@@ -25,30 +25,41 @@ This guide was primarily written to support someone with a Windows computer.  Th
 
 [^2]: This is just a name that people use to identify something.  Google owns many, for example: `www.google.com`, `google.com`, `gmail.com` are all domains.  On the internet one 'owns' a name by registering with Internet Corporation for Assigned Names and Numbers (ICANN).
 
+The [Debian](#brief) guide shows us a high level what we whish to accomplish with this guide, but we will need a few extra things.  We are going to assume that the Windows user already has `git` setup and they know how to use it.  They are going to need to connect to a remote server because Windows lacks several low-level API calls required by many reliable servers[^3].  The requirement to a remote server means one needs to be careful and run some commands on the local Windows host and some using `SecureShell` (SSH) on a remote host.  In addition files need to be synced between the local and remote side which means we need more tools and configs.  
+The installation of `Hugo` is the tiniest bit more complex[^4].
+
+The guide tends to be a little on the verbose side, both becuase I lack clarity, also because I hope the additional details are useful.  As a warning, when you fall off a cliff the guide can't catch you, it's just going to watch your inevitible tumble down the mountainside.  I suppose what mean is one should expect a few scrapes and bruises, expect frustrations and mistakes.
+
+[^3]: Idk is reliable is the right word.  Windows lacks the `epoll` API and does not support `select` or `poll`.  Furthermore access to the latter functions, it would rely on a third party [tools](https://www.cygwin.com/) to provide support.  That is what I actually mean by 'reliable'.  
+
+[^4]: Due to the differences between `Windows Powershell` the end-of-the-road 'powershell' that is installed on Windows, and `Powershell` the [actively developed](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) but not installed on any version of Windows.  
+
+This is supposed to be prerequisites.
+If you follow this first some you may be save yourself from difficulties later.  To follow this guide we adhere to not storing easily exploitable private keys, especially in a hostile environment like Windows.  We need several tools to support Windows' lack of priorities in this arena.  When we encrypt keys some programs have difficulty with the additional overhead of prompting users to decrypt said keys, oh well.
+
+
 ## <a name="brief" id="brief"></a>A Debian guide shows the road ahead
 ```
 # Debian version of static site using Hugo
 # --
+: "you will need to add a DNS record for the kyleguy.rome7.com with your domain registrar"
+# PART 1: install hugo and setup NginX configs for our webserver -----------------------------
 sudo apt install hugo;
-# setup NginX configs for our webserver
 git clone https://git.pebbleguy.com/Dan/pebbleguy.com;
-cd pebbleguy.com/scripts && ./certbot-wrapper.sh -h kyleguy.rome7.com -u kyle
-# Create the site
+cd pebbleguy.com/scripts && ./certbot-wrapper.sh -h kyleguy.rome7.com -u kyle;
+# PART 2: Create the site --------------------------------------------------------------------
 cd /mnt/external/projects && mkdir kyleguy && cd kyleguy && git init && touch README.md
 hugo new site web && cd web
 git submodule add https://github.com/theNewDynamic/gohugo-theme-ananke.git themes/ananke
 echo "theme = 'ananke'" >> hugo.toml
 sudo ln -s /mnt/external/projects/kyleguy/web/public/ /mnt/external/websites/kyleguy.rome7.com
-# Commit the website and push the repository to git.pebbleguy.com
+# PART 3: Commit the website and push the repository to git.pebbleguy.com --------------------
 git add --all && git commit -m'added a static site with hugo'
 git remote add origin http://git.pebbleguy.com/kyle/kyleguy.git
 git push -u origin master
-: "you'll need to add a DNS record for the domain kyleguy.rome7.com on your domain registrar"
 ```
 
-What we can see is that the user made sure that they had a DNS record for `kyleguy.rome7.com` then installed `hugo`.  They pulled a copy of the `pebbleguy.com` repository so that they could execute the `certbot-wrapper.sh` to setup a webserver with a certificate signed by a certificate authority.  They then setup a webroot and added a theme to their static site.  Lastly they committed their site contained in a new `git` repository to `git.pebbleguy.com`.  This is basically what we are going to do in this guide but we need some extra things.  We are going to assume that the Windows user already has `git` setup and they know how to use it.  They are going to need to connect to a remote server because Windows lacks several basic API calls needed for a reliable server.  Idk is reliable is the right word.  They lack the `epoll` API and do not support `select` or `poll` and would rely on a third party [tools](https://www.cygwin.com/).  That is what I actually mean by 'reliable'.  I was saying they need to connect to a remote server which means one needs to be careful and run some commands on the Windows host and some using `SecureShell` on a remote host.  In addition files need to be synced between the local and remote side which means we need a few more tools and configs.  The installation of `Hugo` is the tiniest bit more complex, due to the differences between `Windows Powershell` the end-of-the-road 'powershell' that is installed on Windows, and `Powershell` the [actively developed](https://learn.microsoft.com/en-us/powershell/scripting/install/installing-powershell-on-windows) but not installed on any version of Windows.  The guide tries to be a little on the verbose side, both becuase I lack clarity, also because this is just a guide hopefully details are useful, but when you fall off a cliff the guide can't catch you, it's just going to watch your inevitible tumble down the mountainside.
-
-This is supposed to be pre-requisites.  If you follow this first some you may be save yourself from difficulties later.  To follow this guide we adhere to not storing easily exploitable private keys, especially in a hostile environment like Windows.  We need several tools to support Windows' lack of priorities in this arena.  When we encrypt keys some programs have difficulty with the additional overhead of prompting users to decrypt said keys, oh well.
+What we see is that the user made sure that they had a DNS record for `kyleguy.rome7.com` then installed `hugo`.  They pulled a copy of the `pebbleguy.com` repository so that they could execute the `certbot-wrapper.sh` to setup a webserver with a certificate signed by a certificate authority.  They then setup a webroot and added a theme to their static site.  Lastly they committed their site contained in a new `git` repository to `git.pebbleguy.com`.  
 
 **Windows does not have ssh-keygen, install it or a replacement:**