DShield-ISC · jullrich · Mar 8, 2023 · Mar 8, 2023 · Mar 8, 2023
diff --git a/README.md b/README.md
@@ -18,65 +18,11 @@ If there is the need for other distros, "someone" has to check and maintain the
 
 ## Installation
 
-** For more detailed instructions with screen shots, see https://isc.sans.edu/honeypotinstall.pdf . **
-
-In order to use the installation script on the Raspberry Pi, you will need to first prepare it.
-
-- Download and install the [Raspberry Pi Imager] (https://www.raspberrypi.com/software/)
-- Select "Raspberry Pi OS Lite (32-bit)" as your operating system. The default selection will work too if you prefer a GUI.
-- Customize the installation by clicking on the "gear" icon in the lower right hand corner of the image.
-- select "Enable SSH"
-- set a username and password (use this username instead of the "pi" user)
-- Optional (but recommended): Set up public-key authentication
-- Select the micro SD Card as "Storage". Be careful to select the right disk.
-- click "WRITE"
-
-![Screen Shot 2022-05-02 at 10 40 51 AM](https://user-images.githubusercontent.com/1626447/166254332-0dd2be8a-0ef6-42a2-8f6d-9610b2664323.png)
-
-- connect to the device using an ssh client (port 22), log in with user user and password you configured above.
-- make sure the Pi can reach out to the Internet using http(s), can resolve DNS, ... (DHCP)
-- make sure Pi's system time is somewhat reasonable, e.g.
-```
-date
-```
-if the time is "off" run (replace date with current date)
-```
-sudo date --set='2017-04-21 21:46:00' +'%Y-%m-%d %H:%M:%S'
-```
-- update your Pi. The install script will do this as well, but it can take **hours**, so you are better off doing it first. 
-```
-sudo apt update
-sudo apt -uy dist-upgrade
-```
-- reboot
-```
-sudo reboot
-```
-- if GIT isn't already installed (will be the case e.g. when using the lite distro): install GIT
-```
-sudo apt -y install git
-```
-- clone the GIT repository (which will create the "dshield" directory)
-```
-git clone https://github.com/DShield-ISC/dshield.git
-```
-- run the installation script, in case you do have an earlier system, copy the files `/etc/dshield.ini` and `/etc/dshield.sslca` from that system to `/etc`; you will be able to reuse the data entered for that system.
-```
-cd dshield/bin
-sudo ./install.sh
-```
-- if curious watch the debug log file in parallel to the installation: connect with an additional ssh session to the system and run (name of the log file will be printed out by the installation script):
-```
-sudo tail -f LOGFILE
-```
-- answer the questions of the installation routine
-- if everything goes fine and the script finishes OK: reboot the device 
-```
-sudo reboot
-```
-- from now on you have to use port 12222 to connect to the device by SSH
-- expose the Pi to inbound traffic. For example, in many firewalls and home routers
-  you will be able to configure it as a "DMZ Hosts", "exposed devices", ... see [hints below](#how-to-place-the-dshield-sensor--honeypot) for - well - hints ...
+Reference the following files for OS-specific installation instructions:
+[Raspbian](docs/install-instructions/Raspbian.md) (Recommended)
+[Ubuntu](docs/install-instructions/Ubuntu.md)
+[openSUSE](docs/install-instructions/openSUSE.md)
+[AWS](docs/install-instructions/AWS.md)
 
 ## Background: `install.sh`
 

diff --git a/README_AWS.md b/README_AWS.md
diff --git a/Architecture.md → docs/dshield-architecture/Architecture.md b/Architecture.md → docs/dshield-architecture/Architecture.md
diff --git a/docs/README.md → ...eld-architecture/ConfigurationDatabase.md b/docs/README.md → ...eld-architecture/ConfigurationDatabase.md
diff --git a/README_cron.md → docs/dshield-architecture/Cron.md b/README_cron.md → docs/dshield-architecture/Cron.md
diff --git a/docs/logging.md → docs/dshield-architecture/Logging.md b/docs/logging.md → docs/dshield-architecture/Logging.md
diff --git a/docs/ServerHeaders.md → docs/dshield-architecture/ServerHeaders.md b/docs/ServerHeaders.md → docs/dshield-architecture/ServerHeaders.md
diff --git a/HARDWARE.md → docs/general-guides/Hardware.md b/HARDWARE.md → docs/general-guides/Hardware.md
diff --git a/LocalAdressLogging.md → docs/general-guides/LocalAdressLogging.md b/LocalAdressLogging.md → docs/general-guides/LocalAdressLogging.md
diff --git a/README_troubleshooting.md → docs/general-guides/Troubleshooting.md b/README_troubleshooting.md → docs/general-guides/Troubleshooting.md
diff --git a/AWS_installation_guide.md → docs/install-instructions/AWS.md b/AWS_installation_guide.md → docs/install-instructions/AWS.md
diff --git a/docs/install-instructions/Raspbian.md b/docs/install-instructions/Raspbian.md
@@ -0,0 +1,62 @@
+# dshield
+
+
+** For more detailed instructions with screen shots, see https://isc.sans.edu/honeypotinstall.pdf . **
+
+In order to use the installation script on the Raspberry Pi, you will need to first prepare it.
+
+- Download and install the [Raspberry Pi Imager] (https://www.raspberrypi.com/software/)
+- Select "Raspberry Pi OS Lite (32-bit)" as your operating system. The default selection will work too if you prefer a GUI.
+- Customize the installation by clicking on the "gear" icon in the lower right hand corner of the image.
+- select "Enable SSH"
+- set a username and password (use this username instead of the "pi" user)
+- Optional (but recommended): Set up public-key authentication
+- Select the micro SD Card as "Storage". Be careful to select the right disk.
+- click "WRITE"
+
+![Screen Shot 2022-05-02 at 10 40 51 AM](https://user-images.githubusercontent.com/1626447/166254332-0dd2be8a-0ef6-42a2-8f6d-9610b2664323.png)
+
+- connect to the device using an ssh client (port 22), log in with user user and password you configured above.
+- make sure the Pi can reach out to the Internet using http(s), can resolve DNS, ... (DHCP)
+- make sure Pi's system time is somewhat reasonable, e.g.
+```
+date
+```
+if the time is "off" run (replace date with current date)
+```
+sudo date --set='2017-04-21 21:46:00' +'%Y-%m-%d %H:%M:%S'
+```
+- update your Pi. The install script will do this as well, but it can take **hours**, so you are better off doing it first. 
+```
+sudo apt update
+sudo apt -uy dist-upgrade
+```
+- reboot
+```
+sudo reboot
+```
+- if GIT isn't already installed (will be the case e.g. when using the lite distro): install GIT
+```
+sudo apt -y install git
+```
+- clone the GIT repository (which will create the "dshield" directory)
+```
+git clone https://github.com/DShield-ISC/dshield.git
+```
+- run the installation script, in case you do have an earlier system, copy the files `/etc/dshield.ini` and `/etc/dshield.sslca` from that system to `/etc`; you will be able to reuse the data entered for that system.
+```
+cd dshield/bin
+sudo ./install.sh
+```
+- if curious watch the debug log file in parallel to the installation: connect with an additional ssh session to the system and run (name of the log file will be printed out by the installation script):
+```
+sudo tail -f LOGFILE
+```
+- answer the questions of the installation routine
+- if everything goes fine and the script finishes OK: reboot the device 
+```
+sudo reboot
+```
+- from now on you have to use port 12222 to connect to the device by SSH
+- expose the Pi to inbound traffic. For example, in many firewalls and home routers
+  you will be able to configure it as a "DMZ Hosts", "exposed devices", ... see [hints below](#how-to-place-the-dshield-sensor--honeypot) for - well - hints ...
diff --git a/README_Ubuntu.md → docs/install-instructions/Ubuntu.md b/README_Ubuntu.md → docs/install-instructions/Ubuntu.md
diff --git a/README_openSUSE.md → docs/install-instructions/openSUSE.md b/README_openSUSE.md → docs/install-instructions/openSUSE.md
diff --git a/docs/myreports.png → docs/resources/myreports.png b/docs/myreports.png → docs/resources/myreports.png
diff --git a/docs/myssh.png → docs/resources/myssh.png b/docs/myssh.png → docs/resources/myssh.png
diff --git a/RouterDocs/OPNSense.txt → docs/router-configuration/OPNSense.md b/RouterDocs/OPNSense.txt → docs/router-configuration/OPNSense.md