|
|
@@ -5,20 +5,25 @@ title = 'Kyleguy Inception'
|
|
|
+++
|
|
|
|
|
|
# README.md
|
|
|
-What could be more helpful than a guide that is more interested in a party trick than attempting solve its stated purpose? Well, a guide that does both. That does not make sense but it's staying because my keyboard doesn't do deletes. My "trick" is that this `README.md` was used to create the site that this `README.md` is being displayed on. If you don't think about it too much it is indeed pretty cool. We are showing off static webpages. These are the fastest websites, but still maintain much of the flexibility developers are used to with dynamic pages.
|
|
|
+What could be more helpful than a guide more interested in a party trick than solving its stated purpose? Probably any other guide right? Our 'trick' is that this `README.md` is the same guide used to create the site that you are now reading. In the same manner, this [repository](https://git.pebbleguy.com/kyle/kyleguy) also contains this file and describes how it was [built](#repositorySetup). Alright. Maybe it isn't that cool of a trick but I bet if you didn't think about it too much you'd think so. We are showcasing static webpages. More percisely a static site generator.
|
|
|
|
|
|
- - [x] 1. [prerequisites](#prelude)
|
|
|
- - [x]   a. a domain
|
|
|
- - [x]   b. a webhost
|
|
|
- - [x]   b. developer tools/environment
|
|
|
+Why are we doing this? Static pages are what webservers were built for. Dynamic pages are largely tools for the developer. Our world is often a weird broken mess of wonderful things. There is a project, [squid](https://squid-cache.org), that can magically increase one's internet speed. The project has been around for nearly 30 years and it isn't magic, they just recognize that most the Internet is thoughtlessly dynamically generated. A static page is what browsers and servers are designed to handle and they struggle when pages are complicated black boxes[^1]. I am being a little harsh, it isn't that pages are slapped together thoughtlessly, I mean to say that given infinite 'thought' resource only what needed be dynamic would be.
|
|
|
|
|
|
-## <a name="prelude" id="prelude"></a>prerequisites
|
|
|
-We will be installing and maintaining a website therefore we need a domain. You will already need to have registered a domain for your use, this is not something this guide covers. You should prioritize the [instructions](#configureRegistrarDns) early due to the inherent delays in DNS propagation. You will also need access to Dan's server pebbleguy.com. Pebbleguy.com will serve as a location to store our files and it will host our website. Websites are forever changing it makes sense that a requirement would be that we need a place edit our site, we won't directly solve that problem but at times we will make an effort and will need both git and an interactive developer environment. These three things are really all that we need, each might hide difficulties, but nothing we cannot handle.
|
|
|
+[^1]: From the viewpoint of the webserver or browser software developer.
|
|
|
|
|
|
-This guide was primarily written to support someone with a Windows computer. Things may look and feel complex due to a bunch of tools, screenshots, button clicks and stuff but if you look at the [Debian](#brief) guide one can see we are't actually accomplishing that much. We can also see that goals of this guide could be completed in a number of different environments. There are a number of tools that fill in where Windows is lacking features or where a solid Microsoft application is not yet developed. These tools are pre-compiled for us and provided by their authors to Windows users at-large. This guide would not be possible without their contributions. I say this to clear up inevitable misunderstandings caused by us bringing diverse softwares together.
|
|
|
+ - [x] 1. [Prerequisites](#prelude)
|
|
|
+ - [x]   a. domain
|
|
|
+ - [x]   b. webhost
|
|
|
+ - [x]   c. tools
|
|
|
+ - [x] 2. [Repository Setup](#repositorySetup)
|
|
|
+ - [x]   a. [domain ](#configureRegistration)
|
|
|
|
|
|
-**klossary**
|
|
|
-> domain - *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).*
|
|
|
+## <a name="prelude" id="prelude"></a> Prerequisites
|
|
|
+We will be installing and maintaining a website therefore we need a domain[^2]. You will already need to have registered a domain for your use, this is not something this guide covers. You should prioritize the [instructions](#configureRegistrarDns) early due to the inherent delays in DNS propagation. You will also need access to Dan's server pebbleguy.com. Pebbleguy.com will serve as a location to store our files and it will host our website. Websites are forever changing it makes sense that a requirement would be that we need a place edit our site, we won't directly solve that problem but at times we will make an effort and will need both git and an interactive developer environment. These three things are really all that we need, each might hide difficulties, but nothing we cannot handle.
|
|
|
+
|
|
|
+This guide was primarily written to support someone with a Windows computer. Things may look and feel complex due to a bunch of tools, screenshots, button clicks and stuff but if you look at the [Debian](#brief) guide one can see we are't actually accomplishing that much. We can also see that goals of this guide could be completed in a number of different environments. There are several tools that fill in where Windows lacks features or where a solid Microsoft application is not yet developed. These tools are pre-compiled for us and provided by their authors to Windows users at-large. This guide would not be possible without their contributions. I say this to clear up inevitable misunderstandings caused by us gluing softwares together and the shortcomings that we will witness.
|
|
|
+
|
|
|
+[^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).
|
|
|
|
|
|
## <a name="brief" id="brief"></a>A Debian guide shows the road ahead
|
|
|
```
|
|
|
@@ -26,14 +31,11 @@ This guide was primarily written to support someone with a Windows computer. Th
|
|
|
# --
|
|
|
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
|
|
|
+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 /mnt/external/projects
|
|
|
-mkdir kyleguy && cd kyleguy && git init && touch README.md
|
|
|
-hugo new site web
|
|
|
-cd web
|
|
|
+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
|
|
|
@@ -41,7 +43,7 @@ sudo ln -s /mnt/external/projects/kyleguy/web/public/ /mnt/external/websites/kyl
|
|
|
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 need to add a DNS record for the domain kyleguy.rome7.com on your domain registrar"
|
|
|
+: "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.
|
|
|
@@ -300,8 +302,7 @@ username@pebbleguy:/mnt/external $ ls /mnt/external/websites
|
|
|
emma-kac gogs-webhooks KingsAndChaos kyleguy.rome7.com shootGame www.pebbleguy.com
|
|
|
```
|
|
|
|
|
|
-## repository setup
|
|
|
-
|
|
|
+## <a name="repositorySetup" id="repositorySetup"></a> Repository Setup
|
|
|
|
|
|
<a name="configureRegistrarDns" id="configureRegistrarDns"></a>**Configure the your domain registrar's DNS**
|
|
|
|
Your Name