Move documentation into separate doc directory and convert to markdown (#234)

* Move existing documentation to its own `doc` folder

* Convert setup_base_image_debian to Markdown

* Convert setup_base_image_other to Markdown

* Convert setup_base_image_raspi3 to Markdown

* Convert setup_babse_image_raspi4 to Markdown

* Convert setup_base_image_rock64 to Markdown

* Convert setup_base_image_rockpro64 to Markdown

* Update filepaths in code to point to new `doc` directory

doc/setup_base_image_debian.md

@@ -0,0 +1,71 @@
+# Setup Base Image (Debian)
+
+1. Setup Base OS
+
+   Install Debian 10.1.0 Net-install via CD
+
+   URL: [https://www.debian.org/CD/netinst/](https://www.debian.org/CD/netinst/)
+
+   Follow instructions:
+
+     - Graphical Install
+     - English, US, American English
+     - Hostname: myNode
+     - Domain Name: <LEAVE_EMPTY>
+     - Root Password: bolt
+     - Full Name: myNode
+     - Username: mynode
+     - Password: bolt
+     - Timezone: Central
+     - Partition: Guided Use Entire Disk, Continue, Continue, Continue, Yes
+     - CDs and Packages: No, Next, Next
+     - Software Selection: No GUI, No Print Server, Add SSH Server
+     - Install Grub: Yes, /dev/sda
+     - Install Complete: Continue
+
+2. Login as root / bolt
+
+3. Install basic Software
+
+   ```sh
+   apt-get -y install sudo
+   useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
+   adduser admin sudo
+   ```
+
+4. Delete mynode user
+
+   ```sh
+   deluser mynode
+   rm -rf /home/mynode
+   exit
+   ```
+
+5. Login as admin / bolt
+
+6. Delete root password
+
+   ```sh
+   sudo passwd -d root
+   ```
+
+7. Update packages
+
+   ```sh
+   sudo apt-get -y update
+   sudo apt-get -y upgrade
+   ```
+
+8. Install some basics
+
+   ```sh
+   sudo apt-get -y install tmux
+   ```
+
+9. Sync
+
+   ```sh
+   sync
+   ```
+
+10. Make image now (if imaging)

doc/setup_base_image_other.md

@@ -0,0 +1,59 @@
+# Setup Base Image (Other)
+
+1. Login as administrator
+
+2. Set hostname
+
+   ```sh
+   hostname myNode
+   ```
+
+3. Add admin user
+
+   ```sh
+   sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
+   sudo adduser admin sudo
+   ```
+
+4. Update OS
+
+   ```sh
+   sudo apt-get update
+   sudo apt-get -y upgrade
+   ```
+
+5. Install some basics
+
+   ```sh
+   sudo apt-get -y install tmux
+   ```
+
+6. Reboot
+
+   ```sh
+   sudo reboot
+   ```
+
+7. Log back in as admin
+
+8. Delete default users for your specific device (if any)
+
+   ```sh
+   # For example:
+   # sudo deluser pi
+   # sudo rm -rf /home/pi
+   ```
+
+9. Sync
+
+   ```sh
+   sync
+   ```
+
+10. Make image now (if imaging)
+
+    Final results:
+
+     - Image with SSH access
+     - Root user disabled
+     - Default user admin with password bolt

doc/setup_base_image_raspi3.md

@@ -0,0 +1,79 @@
+# Setup Base Image (Raspberry Pi 3)
+
+1. After Raspi Flash `touch` ssh file on rootfs
+
+2. Login as pi / raspberry
+
+3. Run `sudo raspi-config`
+
+   - Update 8: Get latest configuration tool
+   - Network Options 2: Hostname -> myNode
+   - Boot Options 3: Choose Desktop / CLI -> Console
+   - Boot Options 3: Wait for Network at Boot
+   - Localisation 4: I2 -> US -> Central
+   - Localisation 4: I4 -> US
+   - Advanced 7: Expand Filesystem
+   - Advanced 7: Memory Split -> 16
+   - Exit by selecting <Finish>, and <No> as no reboot is necessary
+
+4. Add admin user
+
+   ```sh
+   sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
+   sudo adduser admin sudo
+   ```
+
+5. Update OS
+
+   ```sh
+   sudo apt-get update
+   sudo apt-get -y upgrade
+   ```
+
+6. Install some basics
+
+   ```sh
+   sudo apt-get -y install tmux
+   ```
+
+7. Reboot
+
+   ```sh
+   sudo reboot
+   ```
+
+8. Log back in as admin
+
+9. Delete pi user
+
+   ```sh
+   sudo deluser pi
+   sudo rm -rf /home/pi
+   ```
+
+10. Install Log2Ram (Armbian has own solution)
+
+   ```sh
+   cd /tmp
+   wget https://github.com/azlux/log2ram/archive/v1.2.2.tar.gz -O log2ram.tar.gz
+   tar -xvf log2ram.tar.gz
+   mv log2ram-* log2ram
+   cd log2ram
+   chmod +x install.sh
+   sudo ./install.sh
+   cd ~
+   ```
+
+11. Sync
+
+   ```sh
+   sync
+   ```
+
+12. Make image now (if imaging)
+
+    Final results:
+
+     - Image with SSH access
+     - Root user disabled
+     - Default user admin with password bolt

doc/setup_base_image_raspi4.md

@@ -0,0 +1,79 @@
+# Setup Base Image (Raspberry Pi 4)
+
+1. After Raspi Flash `touch` ssh file on rootfs
+
+2. Login as pi / raspberry
+
+3. Run `sudo raspi-config`
+
+   - Update 8: Get latest configuration tool
+   - Network Options 2: Hostname -> myNode
+   - Boot Options 3: Choose Desktop / CLI -> Console
+   - Boot Options 3: Wait for Network at Boot
+   - Localisation 4: I2 -> US -> Central
+   - Localisation 4: I4 -> US
+   - Advanced 7: Expand Filesystem
+   - Advanced 7: Memory Split -> 16
+   - Exit by selecting <Finish>, and <No> as no reboot is necessary
+
+4. Add admin user
+
+   ```sh
+   sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
+   sudo adduser admin sudo
+   ```
+
+5. Update OS
+
+   ```sh
+   sudo apt-get update
+   sudo apt-get -y upgrade
+   ```
+
+6. Install some basics
+
+   ```sh
+   sudo apt-get -y install tmux
+   ```
+
+7. Reboot
+
+   ```sh
+   sudo reboot
+   ```
+
+8. Log back in as admin
+
+9. Delete pi user
+
+   ```sh
+   sudo deluser pi
+   sudo rm -rf /home/pi
+   ```
+
+10. Install Log2Ram (Armbian has own solution)
+
+   ```sh
+   cd /tmp
+   wget https://github.com/azlux/log2ram/archive/v1.2.2.tar.gz -O log2ram.tar.gz
+   tar -xvf log2ram.tar.gz
+   mv log2ram-* log2ram
+   cd log2ram
+   chmod +x install.sh
+   sudo ./install.sh
+   cd ~
+   ```
+
+11. Sync
+
+   ```sh
+   sync
+   ```
+
+12. Make image now (if imaging)
+
+    Final results:
+
+     - Image with SSH access
+     - Root user disabled
+     - Default user admin with password bolt

doc/setup_base_image_rock64.md

@@ -0,0 +1,62 @@
+# Setup Base Image (ROCK64)
+
+1. After Armbian Flash
+
+   - Login with root / 1234
+   - Change root password to something longish like boltbolt
+   - Create admin user with password bolt
+
+2. Login as admin
+
+3. Delete root password
+
+   ```sh
+   sudo passwd -d root
+   ```
+
+4. Set hostname
+
+   ```sh
+   echo "myNode" | sudo tee /etc/hostname
+   sudo sed -i 's/rock64/myNode/g' /etc/hosts
+   # OR armbian-config -> Personal -> Hostname
+   ```
+
+5. Overclock
+
+   ```sh
+   sudo sed -i "s/MAX_SPEED=.*/MAX_SPEED=1510000/" /etc/default/cpufrequtils
+   sudo systemctl restart cpufrequtils
+   ```
+
+6. Update packages
+
+   ```sh
+   sudo apt-get update
+   sudo apt-get -y upgrade
+   ```
+
+7. Install some necessary tools
+
+   ```sh
+   sudo apt-get -y install network-manager tmux
+   ```
+
+8. Regenerate MAC Address for Rock64
+
+   ```sh
+   . /usr/lib/armbian/armbian-common
+   CONNECTION="$(nmcli -f UUID,ACTIVE,DEVICE,TYPE connection show --active | tail -n1)"
+   UUID=$(awk -F" " '/ethernet/ {print $1}' <<< "${CONNECTION}")
+   get_random_mac
+   nmcli connection modify $UUID ethernet.cloned-mac-address $MACADDR
+   nmcli connection modify $UUID -ethernet.mac-address ""
+   ```
+
+9. Sync
+
+   ```sh
+   sync
+   ```
+
+10. Make image now (if imaging)

doc/setup_base_image_rockpro64.md

@@ -0,0 +1,55 @@
+# Setup Base Image (ROCKPro64)
+
+1. After Armbian Flash
+
+   - Login with root / 1234
+   - Change root password to something longish like boltbolt
+   - Create admin user with password bolt
+
+2. Login as admin
+
+3. Delete root password
+
+   ```sh
+   sudo passwd -d root
+   ```
+
+4. Set hostname
+
+   ```sh
+   echo "myNode" | sudo tee /etc/hostname
+   sudo sed -i 's/rock64/myNode/g' /etc/hosts
+   # OR armbian-config -> Personal -> Hostname
+   ```
+
+5. Update packages
+
+   ```sh
+   sudo apt-get update
+   sudo apt-get -y upgrade
+   ```
+
+6. Install some necessary tools
+
+   ```sh
+   sudo apt-get -y install network-manager tmux
+   ```
+
+7. Regenerate MAC Address for RockPro64
+
+   ```sh
+   . /usr/lib/armbian/armbian-common
+   CONNECTION="$(nmcli -f UUID,ACTIVE,DEVICE,TYPE connection show --active | tail -n1)"
+   UUID=$(awk -F" " '/ethernet/ {print $1}' <<< "${CONNECTION}")
+   get_random_mac
+   nmcli connection modify $UUID ethernet.cloned-mac-address $MACADDR
+   nmcli connection modify $UUID -ethernet.mac-address ""
+   ```
+
+8. Sync
+
+   ```sh
+   sync
+   ```
+
+9. Make image now (if imaging)

scripts/setup_new_debian.sh

@@ -10,7 +10,7 @@ clear
 echo "Step 1: "
 echo "  Install your a Debian Image:"
 echo "  Setup image for use with myNode:"
-echo "    See manual instructions in setup/setup_base_image_debian.txt"
+echo "    See manual instructions in doc/setup_base_image_debian.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1
@@ -45,4 +45,4 @@ echo "Congratulations! Your device is now ready!"
 echo "  Access it via a web browser at http://mynode.local/ or http://<device ip>/"
 echo "  Access it via SSH using the default credentials: admin / bolt"
 echo "  You should change your password on the settings page in the web GUI"
-echo ""
+echo ""

scripts/setup_new_other.sh

@@ -10,7 +10,7 @@ clear
 echo "Step 1: "
 echo "  Install your own Linux distro: Debian, Armbian, Raspbian, etc...:"
 echo "  Setup image for use with myNode:"
-echo "    See manual instructions in setup/setup_base_image_other.txt"
+echo "    See manual instructions in doc/setup_base_image_other.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1

scripts/setup_new_raspi3.sh

@@ -11,7 +11,7 @@ echo "Step 1: "
 echo "  Flash SD Card with Raspberry Pi Image: out/base_images/raspi3_base.img.gz"
 echo "  OR"
 echo "  If you would rather create your own base image, follow the"
-echo "  manual instructions in setup/setup_base_image_raspi3.txt"
+echo "  manual instructions in doc/setup_base_image_raspi3.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1
@@ -46,4 +46,4 @@ echo "Congratulations! Your device is now ready!"
 echo "  Access it via a web browser at http://mynode.local/ or http://<device ip>/"
 echo "  Access it via SSH using the default credentials: admin / bolt"
 echo "  You should change your password on the settings page in the web GUI"
-echo ""
+echo ""

scripts/setup_new_raspi4.sh

@@ -11,7 +11,7 @@ echo "Step 1: "
 echo "  Flash SD Card with Raspberry Pi Image: out/base_images/raspi4_base.img.gz"
 echo "  OR"
 echo "  If you would rather create your own base image, follow the"
-echo "  manual instructions in setup/setup_base_image_raspi4.txt"
+echo "  manual instructions in doc/setup_base_image_raspi4.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1
@@ -46,4 +46,4 @@ echo "Congratulations! Your device is now ready!"
 echo "  Access it via a web browser at http://mynode.local/ or http://<device ip>/"
 echo "  Access it via SSH using the default credentials: admin / bolt"
 echo "  You should change your password on the settings page in the web GUI"
-echo ""
+echo ""

scripts/setup_new_rock64.sh

@@ -11,7 +11,7 @@ echo "Step 1: "
 echo "  Flash SD Card with Rock64 Image: out/base_images/rock64_base.img.gz"
 echo "  OR"
 echo "  If you would rather create your own base image, follow the"
-echo "  manual instructions in setup/setup_base_image_rock64.txt"
+echo "  manual instructions in doc/setup_base_image_rock64.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1
@@ -46,4 +46,4 @@ echo "Congratulations! Your device is now ready!"
 echo "  Access it via a web browser at http://mynode.local/ or http://<device ip>/"
 echo "  Access it via SSH using the default credentials: admin / bolt"
 echo "  You should change your password on the settings page in the web GUI"
-echo ""
+echo ""

scripts/setup_new_rockpro64.sh

@@ -11,7 +11,7 @@ echo "Step 1: "
 echo "  Flash SD Card with Rock64 Image: out/base_images/rockpro64_base.img.gz"
 echo "  OR"
 echo "  If you would rather create your own base image, follow the"
-echo "  manual instructions in setup/setup_base_image_rockpro64.txt"
+echo "  manual instructions in doc/setup_base_image_rockpro64.md"
 echo ""
 echo "Press a key when complete..."
 read -n 1
@@ -46,4 +46,4 @@ echo "Congratulations! Your device is now ready!"
 echo "  Access it via a web browser at http://mynode.local/ or http://<device ip>/"
 echo "  Access it via SSH using the default credentials: admin / bolt"
 echo "  You should change your password on the settings page in the web GUI"
-echo ""
+echo ""

setup/setup_base_image_debian.txt

@@ -1,53 +0,0 @@
-###
-### Setup Base OS
-###
-
-# Install Debian 10.1.0 Net-install via CD
-#  URL: https://www.debian.org/CD/netinst/
-#  Follow instructions:
-#  - Graphical Install
-#  - English, US, American English
-#  - Hostname: myNode
-#  - Domain Name: <Leave Empty>
-#  - Root Password: bolt
-#  - Full Name: myNode
-#  - Username: mynode
-#  - Password: bolt
-#  - Timezone: Central
-#  - Partition: Guided Use Entire Disk, Continue, Continue, Continue, Yes
-#  - CDs and Packages: No, Next, Next
-#  - Software Selection: No GUI, No Print Server, Add SSH Server
-#  - Install Grub: Yes, /dev/sda
-#  - Install Complete: Continue
-
-# Login as root / bolt
-
-# Install basic Software
-apt-get -y install sudo
-useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
-adduser admin sudo
-
-# Delete mynode user
-deluser mynode
-rm -rf /home/mynode
-
-exit
-# Login as admin / bolt
-
-# Delete root password
-sudo passwd -d root
-
-# Update packages
-sudo apt-get -y update
-sudo apt-get -y upgrade
-
-# Install some basics
-sudo apt-get -y install tmux
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-###  (if imaging)  ###
-######################

setup/setup_base_image_other.txt

@@ -1,45 +0,0 @@
-###
-### Setup Base OS
-###
-
-# Login as administrator
-
-# Set hostname
-hostname myNode
-
-
-# Add admin user
-sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
-sudo adduser admin sudo
-
-# Update OS
-sudo apt-get update
-sudo apt-get -y upgrade
-
-# Install some basics
-sudo apt-get -y install tmux
-
-# Reboot
-sudo reboot
-
-
-### Log back in as admin
-
-
-# Delete default users for your specific device (if any)
-# For example:
-# sudo deluser pi
-# sudo rm -rf /home/pi
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-######################
-
-
-# Final results
-# - Image with SSH access
-# - Root user disabled
-# - Default user admin with password bolt

setup/setup_base_image_raspi3.txt

@@ -1,65 +0,0 @@
-###
-### Setup Base OS
-###
-
-# MANUAL: After Raspi Flash
-#  - Touch ssh file on rootfs
-
-# Login as pi / raspberry
-
-# MANUAL: Run sudo raspi-config
-    Update 8: Get latest configuration tool
-    Network Options 2: Hostname -> myNode
-    Boot Options 3: Choose Desktop / CLI -> Console
-    Boot Options 3: Wait for Network at Boot
-    Localisation 4: I2 -> US -> Central
-    Localisation 4: I4 -> US
-    Advanced 7: Expand Filesystem 
-    Advanced 7: Memory Split -> 16
-    Exit by selecting <Finish>, and <No> as no reboot is necessary
-    
-# Add admin user
-sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
-sudo adduser admin sudo
-
-# Update OS
-sudo apt-get update
-sudo apt-get -y upgrade
-
-# Install some basics
-sudo apt-get -y install tmux
-
-# Reboot
-sudo reboot
-
-
-### Log back in as admin
-
-
-# Delete pi user
-sudo deluser pi
-sudo rm -rf /home/pi
-
-
-# Install Log2Ram (Armbian has own solution)
-cd /tmp
-wget https://github.com/azlux/log2ram/archive/v1.2.2.tar.gz -O log2ram.tar.gz
-tar -xvf log2ram.tar.gz
-mv log2ram-* log2ram
-cd log2ram
-chmod +x install.sh
-sudo ./install.sh
-cd ~
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-######################
-
-
-# Final results
-# - Image with SSH access
-# - Root user disabled
-# - Default user admin with password bolt

setup/setup_base_image_raspi4.txt

@@ -1,65 +0,0 @@
-###
-### Setup Base OS
-###
-
-# MANUAL: After Raspi Flash
-#  - Touch ssh file on rootfs
-
-# Login as pi / raspberry
-
-# MANUAL: Run sudo raspi-config
-    Update 8: Get latest configuration tool
-    Network Options 2: Hostname -> myNode
-    Boot Options 3: Choose Desktop / CLI -> Console
-    Boot Options 3: Wait for Network at Boot
-    Localisation 4: I2 -> US -> Central
-    Localisation 4: I4 -> US
-    Advanced 7: Expand Filesystem 
-    Advanced 7: Memory Split -> 16
-    Exit by selecting <Finish>, and <No> as no reboot is necessary
-    
-# Add admin user
-sudo useradd -p $(openssl passwd -1 bolt) -m -s /bin/bash admin
-sudo adduser admin sudo
-
-# Update OS
-sudo apt-get update
-sudo apt-get -y upgrade
-
-# Install some basics
-sudo apt-get -y install tmux
-
-# Reboot
-sudo reboot
-
-
-### Log back in as admin
-
-
-# Delete pi user
-sudo deluser pi
-sudo rm -rf /home/pi
-
-
-# Install Log2Ram (Armbian has own solution)
-cd /tmp
-wget https://github.com/azlux/log2ram/archive/v1.2.2.tar.gz -O log2ram.tar.gz
-tar -xvf log2ram.tar.gz
-mv log2ram-* log2ram
-cd log2ram
-chmod +x install.sh
-sudo ./install.sh
-cd ~
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-######################
-
-
-# Final results
-# - Image with SSH access
-# - Root user disabled
-# - Default user admin with password bolt

setup/setup_base_image_rock64.txt

@@ -1,45 +0,0 @@
-###
-### Setup Base OS
-###
-
-# After Armbian Flash
-#  - Login with root / 1234
-#  - Change root password to something longish like boltbolt
-#  - Create admin user with password bolt
-
-# Login as admin
-
-# Delete root password
-sudo passwd -d root
-
-# Set hostname
-echo "myNode" | sudo tee /etc/hostname
-sudo sed -i 's/rock64/myNode/g' /etc/hosts
-# OR armbian-config -> Personal -> Hostname
-
-# Overclock
-sudo sed -i "s/MAX_SPEED=.*/MAX_SPEED=1510000/" /etc/default/cpufrequtils 
-sudo systemctl restart cpufrequtils
-
-# Update packages
-sudo apt-get update
-sudo apt-get -y upgrade
-
-# Install some necessary tools
-sudo apt-get -y install network-manager tmux
-
-# Regenerate MAC Address for Rock64
-. /usr/lib/armbian/armbian-common
-CONNECTION="$(nmcli -f UUID,ACTIVE,DEVICE,TYPE connection show --active | tail -n1)"
-UUID=$(awk -F" " '/ethernet/ {print $1}' <<< "${CONNECTION}")
-get_random_mac
-nmcli connection modify $UUID ethernet.cloned-mac-address $MACADDR
-nmcli connection modify $UUID -ethernet.mac-address ""
-
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-######################

setup/setup_base_image_rockpro64.txt

@@ -1,41 +0,0 @@
-###
-### Setup Base OS
-###
-
-# After Armbian Flash
-#  - Login with root / 1234
-#  - Change root password to something longish like boltbolt
-#  - Create admin user with password bolt
-
-# Login as admin
-
-# Delete root password
-sudo passwd -d root
-
-# Set hostname
-echo "myNode" | sudo tee /etc/hostname
-sudo sed -i 's/rockpro64/myNode/g' /etc/hosts
-# OR armbian-config -> Personal -> Hostname
-
-# Update packages
-sudo apt-get update
-sudo apt-get -y upgrade
-
-# Install some necessary tools
-sudo apt-get -y install network-manager tmux
-
-# Regenerate MAC Address for RockPro64
-. /usr/lib/armbian/armbian-common
-CONNECTION="$(nmcli -f UUID,ACTIVE,DEVICE,TYPE connection show --active | tail -n1)"
-UUID=$(awk -F" " '/ethernet/ {print $1}' <<< "${CONNECTION}")
-get_random_mac
-nmcli connection modify $UUID ethernet.cloned-mac-address $MACADDR
-nmcli connection modify $UUID -ethernet.mac-address ""
-
-
-# Sync
-sync
-
-######################
-### MAKE IMAGE NOW ###
-######################