From b1423fdb10454d2dd2dce27101c39bb795d22287 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 00:54:14 -0400 Subject: [PATCH 01/34] Set theme jekyll-theme-hacker From 0e15c2f9a6fa97a18e8c0c5f76d6b92a9157c298 Mon Sep 17 00:00:00 2001 From: Jason Windisch Date: Sat, 24 Mar 2018 00:57:32 -0400 Subject: [PATCH 02/34] Added Windows info --- docs/installation/os-hardware.md | 35 +++++----------------- docs/installation/rpi.md | 32 ++++++++++++++++++++ docs/installation/windows.md | 50 ++++++++++++++++++++++++++++++++ 3 files changed, 89 insertions(+), 28 deletions(-) create mode 100644 docs/installation/rpi.md create mode 100644 docs/installation/windows.md diff --git a/docs/installation/os-hardware.md b/docs/installation/os-hardware.md index 21eac4d9..f50107ca 100644 --- a/docs/installation/os-hardware.md +++ b/docs/installation/os-hardware.md @@ -1,32 +1,11 @@ --- layout: page -title: OS & Hardware Specific Information +title: OS/Hardware Specific --- -## Raspberry Pi +There are multiple ways of installing ENiGMA BBS, depending on your level of experience and desire to do +things manually versus have it automated for you. -All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with -`npm install` will take some time and *may* appear to hang. It's still working - just be patient and let it -complete. - -### Basic Instructions - -1. Download [Raspbian Stretch Lite](https://www.raspberrypi.org/downloads/raspbian/). Follow the instructions -on the [Raspbian site](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) regarding how -to get it written to an SD card. - -2. Run `sudo raspi-config`, then: - 1. Set your timezone (option 4, option I2) - 2. Enable SSH (option 5, option P2) - 3. Expand the filesystem to use the entire SD card (option 7, option A1) - -3. Update & upgrade all packages: `apt-get update && apt-get upgrade` - -4. Install required packages: `sudo apt install lrzsz p7zip-full` - -5. Follow the [installation instructions](/installation) to install ENiGMA½. - -6. Profit! - -## Windows - -Needs more info, please submit a PR! \ No newline at end of file +| Method | Operating System Compatibility | Notes | +|----------------------------------------|------------------------------------------------|---------------------------------------------------------------------------------------------| +| [Raspberry Pi](rpi) | Linux, BSD, OSX | All Raspberry Pi models work great with ENiGMA½! | +| [Windows](windows) | Windows | Easy upgrades, compatible with all operating systems, no dependencies to install | diff --git a/docs/installation/rpi.md b/docs/installation/rpi.md new file mode 100644 index 00000000..21eac4d9 --- /dev/null +++ b/docs/installation/rpi.md @@ -0,0 +1,32 @@ +--- +layout: page +title: OS & Hardware Specific Information +--- +## Raspberry Pi + +All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with +`npm install` will take some time and *may* appear to hang. It's still working - just be patient and let it +complete. + +### Basic Instructions + +1. Download [Raspbian Stretch Lite](https://www.raspberrypi.org/downloads/raspbian/). Follow the instructions +on the [Raspbian site](https://www.raspberrypi.org/documentation/installation/installing-images/README.md) regarding how +to get it written to an SD card. + +2. Run `sudo raspi-config`, then: + 1. Set your timezone (option 4, option I2) + 2. Enable SSH (option 5, option P2) + 3. Expand the filesystem to use the entire SD card (option 7, option A1) + +3. Update & upgrade all packages: `apt-get update && apt-get upgrade` + +4. Install required packages: `sudo apt install lrzsz p7zip-full` + +5. Follow the [installation instructions](/installation) to install ENiGMA½. + +6. Profit! + +## Windows + +Needs more info, please submit a PR! \ No newline at end of file diff --git a/docs/installation/windows.md b/docs/installation/windows.md new file mode 100644 index 00000000..9cb80108 --- /dev/null +++ b/docs/installation/windows.md @@ -0,0 +1,50 @@ +--- +layout: page +title: Windows Full Install +--- +## Windows + +ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors naively then you should use a 32 bit Windows. + + +### Basic Instructions + +1. Download and Install [Node.JS](https://nodejs.org/en/download/). + + 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. + + `Run PowerShell as Administrator + + Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force + npm install -g npm-windows-upgrade + + npm-windows-upgrade` + + Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. + Also if you run the NodeJS installer, it will replace the node version.: + + + 2. Install [windows-build-tools for npm] (https://www.npmjs.com/package/windows-build-tools) + 'npm install --global --production windows-build-tools' + *This will also install python 2.7 + +2. Install [7zip] (https://www.7-zip.org/download.html). + *Add 7zip to your path so 7z can be called from the console + +3. Install [Git] (https://git-scm.com/downloads) and optionally [TortoiseGit] (https://tortoisegit.org/download/). + +4. Clone Enigma - browse to the directory you want and run "git clone https://github.com/NuSkooler/enigma-bbs.git" + Optionally use the tortoisegit gui by right clicking the directory and run git clone in the menu + + +5. Install ENiGMA½. + 1. In the enigma directory run 'npm install' + 2. Generate your initial configuration: + 'node .\oputil.js config new' + Follow the prompts! + 3. Edit any configuration files + 4. Run ENiGMA½ + 'node .\main.js' + + +6. Profit! From 37d27bb735de22581a03d88886847ff59dbce15f Mon Sep 17 00:00:00 2001 From: Jason Windisch Date: Sat, 24 Mar 2018 01:01:31 -0400 Subject: [PATCH 03/34] Added links in nav bar --- docs/_includes/nav.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index 168e1cf5..30dc21f5 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -4,8 +4,8 @@ - [Docker]({{ site.baseurl }}{% link installation/docker.md %}) - [Manual installation]({{ site.baseurl }}{% link installation/manual.md %}) - [OS / Hardware Specific]({{ site.baseurl }}{% link installation/os-hardware.md %}) - - Raspberry Pi - - Windows + - [Raspberry Pi] ({{ site.baseurl }}{% link installation/rpi.md %}) + - [Windows]({{ site.baseurl }}{% link installation/windows.md %}) - [Your Network Setup]({{ site.baseurl }}{% link installation/network.md %}) - [Testing Your Installation]({{ site.baseurl }}{% link installation/testing.md %}) - [Production Installation]({{ site.baseurl }}{% link installation/production.md %}) From 77a1f2b38b2e1b6304670d7c61bbce171e1f14c4 Mon Sep 17 00:00:00 2001 From: Jason Windisch Date: Sat, 24 Mar 2018 01:03:58 -0400 Subject: [PATCH 04/34] Remove Space --- docs/_includes/nav.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index 30dc21f5..dacb2f00 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -4,7 +4,7 @@ - [Docker]({{ site.baseurl }}{% link installation/docker.md %}) - [Manual installation]({{ site.baseurl }}{% link installation/manual.md %}) - [OS / Hardware Specific]({{ site.baseurl }}{% link installation/os-hardware.md %}) - - [Raspberry Pi] ({{ site.baseurl }}{% link installation/rpi.md %}) + - [Raspberry Pi]({{ site.baseurl }}{% link installation/rpi.md %}) - [Windows]({{ site.baseurl }}{% link installation/windows.md %}) - [Your Network Setup]({{ site.baseurl }}{% link installation/network.md %}) - [Testing Your Installation]({{ site.baseurl }}{% link installation/testing.md %}) From b3fee74a90dbab39ac10cce25024ccd57bcfa541 Mon Sep 17 00:00:00 2001 From: Jason Windisch Date: Sat, 24 Mar 2018 01:07:22 -0400 Subject: [PATCH 05/34] test --- docs/_includes/nav.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index dacb2f00..128cb66d 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -4,7 +4,7 @@ - [Docker]({{ site.baseurl }}{% link installation/docker.md %}) - [Manual installation]({{ site.baseurl }}{% link installation/manual.md %}) - [OS / Hardware Specific]({{ site.baseurl }}{% link installation/os-hardware.md %}) - - [Raspberry Pi]({{ site.baseurl }}{% link installation/rpi.md %}) + - [Raspberry Pi]({{ site.baseurl }}{% link installation/windows.md %}) - [Windows]({{ site.baseurl }}{% link installation/windows.md %}) - [Your Network Setup]({{ site.baseurl }}{% link installation/network.md %}) - [Testing Your Installation]({{ site.baseurl }}{% link installation/testing.md %}) From 7e3d8cbaf1b84e6319cec89cc2a09f92dba19b7d Mon Sep 17 00:00:00 2001 From: Jason Windisch Date: Sat, 24 Mar 2018 01:08:40 -0400 Subject: [PATCH 06/34] try 2 --- docs/_includes/nav.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index 128cb66d..dacb2f00 100644 --- a/docs/_includes/nav.md +++ b/docs/_includes/nav.md @@ -4,7 +4,7 @@ - [Docker]({{ site.baseurl }}{% link installation/docker.md %}) - [Manual installation]({{ site.baseurl }}{% link installation/manual.md %}) - [OS / Hardware Specific]({{ site.baseurl }}{% link installation/os-hardware.md %}) - - [Raspberry Pi]({{ site.baseurl }}{% link installation/windows.md %}) + - [Raspberry Pi]({{ site.baseurl }}{% link installation/rpi.md %}) - [Windows]({{ site.baseurl }}{% link installation/windows.md %}) - [Your Network Setup]({{ site.baseurl }}{% link installation/network.md %}) - [Testing Your Installation]({{ site.baseurl }}{% link installation/testing.md %}) From 26bdd8b7c78a1e9f8aad61a08161ce87601d64e2 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:12:25 -0400 Subject: [PATCH 07/34] Update rpi.md --- docs/installation/rpi.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/installation/rpi.md b/docs/installation/rpi.md index 21eac4d9..570d0f6a 100644 --- a/docs/installation/rpi.md +++ b/docs/installation/rpi.md @@ -26,7 +26,3 @@ to get it written to an SD card. 5. Follow the [installation instructions](/installation) to install ENiGMA½. 6. Profit! - -## Windows - -Needs more info, please submit a PR! \ No newline at end of file From 6cd88178d639c52aef6612f08339c6bf2ef41322 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:14:10 -0400 Subject: [PATCH 08/34] fixed links --- docs/installation/windows.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 9cb80108..a7885573 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -24,14 +24,14 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo Also if you run the NodeJS installer, it will replace the node version.: - 2. Install [windows-build-tools for npm] (https://www.npmjs.com/package/windows-build-tools) + 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) 'npm install --global --production windows-build-tools' *This will also install python 2.7 -2. Install [7zip] (https://www.7-zip.org/download.html). +2. Install [7zip](https://www.7-zip.org/download.html). *Add 7zip to your path so 7z can be called from the console -3. Install [Git] (https://git-scm.com/downloads) and optionally [TortoiseGit] (https://tortoisegit.org/download/). +3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). 4. Clone Enigma - browse to the directory you want and run "git clone https://github.com/NuSkooler/enigma-bbs.git" Optionally use the tortoisegit gui by right clicking the directory and run git clone in the menu From bd519430cef846ece9dd93f301b5736557bb0cb5 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:19:50 -0400 Subject: [PATCH 09/34] Update windows.md --- docs/installation/windows.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index a7885573..3eb0ccc4 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -29,6 +29,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo *This will also install python 2.7 2. Install [7zip](https://www.7-zip.org/download.html). + *Add 7zip to your path so 7z can be called from the console 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). From 341a0a6be89e954b7aba6ace52f3c28634a75a1f Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:22:19 -0400 Subject: [PATCH 10/34] Update windows.md --- docs/installation/windows.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 3eb0ccc4..56a610c6 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -13,15 +13,14 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. - `Run PowerShell as Administrator + `Run PowerShell as Administrator + + Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force + npm install -g npm-windows-upgrade + npm-windows-upgrade` - Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force - npm install -g npm-windows-upgrade - - npm-windows-upgrade` - - Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. - Also if you run the NodeJS installer, it will replace the node version.: + Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. + Also if you run the NodeJS installer, it will replace the node version.: 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) From 731c2124131061587174200341007f4cde4ee92f Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:25:12 -0400 Subject: [PATCH 11/34] Update windows.md --- docs/installation/windows.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 56a610c6..f06c4034 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -13,11 +13,13 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. - `Run PowerShell as Administrator + ```Powershell + *Run PowerShell as Administrator Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force npm install -g npm-windows-upgrade - npm-windows-upgrade` + npm-windows-upgrade + ``` Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. Also if you run the NodeJS installer, it will replace the node version.: From e45cba10a02a0a925f7359c82b86793c60cd92ff Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:26:48 -0400 Subject: [PATCH 12/34] Update windows.md --- docs/installation/windows.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index f06c4034..57b5ee0b 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -26,8 +26,11 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) - 'npm install --global --production windows-build-tools' - *This will also install python 2.7 + *This will also install python 2.7 + ```Powershell + npm install --global --production windows-build-tools + ``` + 2. Install [7zip](https://www.7-zip.org/download.html). From 1568a718c9ac34026a46d1a832f7e75c9cd5ea5e Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:29:19 -0400 Subject: [PATCH 13/34] Update windows.md --- docs/installation/windows.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 57b5ee0b..40c4b6db 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -38,14 +38,19 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). -4. Clone Enigma - browse to the directory you want and run "git clone https://github.com/NuSkooler/enigma-bbs.git" - Optionally use the tortoisegit gui by right clicking the directory and run git clone in the menu +4. Clone Enigma - browse to the directory you want and run + ```Powershell + git clone "https://github.com/NuSkooler/enigma-bbs.git" + ``` + Optionally use the TortoiseGit by right clicking the directory and slecting "Git Clone...". 5. Install ENiGMA½. 1. In the enigma directory run 'npm install' 2. Generate your initial configuration: - 'node .\oputil.js config new' + ```Powershell + node .\oputil.js config new + ``` Follow the prompts! 3. Edit any configuration files 4. Run ENiGMA½ From 53f40187bee7ab221bb9183bf6a0c2b31665c1d3 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:30:38 -0400 Subject: [PATCH 14/34] Update windows.md --- docs/installation/windows.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 40c4b6db..ba3c6feb 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -54,7 +54,9 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo Follow the prompts! 3. Edit any configuration files 4. Run ENiGMA½ - 'node .\main.js' + ```Powershell + node .\main.js + ``` 6. Profit! From 2756c1730ea6e47b334d7380e482f37441244fdc Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:35:07 -0400 Subject: [PATCH 15/34] Update windows.md --- docs/installation/windows.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index ba3c6feb..1fcc4823 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -35,6 +35,11 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 2. Install [7zip](https://www.7-zip.org/download.html). *Add 7zip to your path so 7z can be called from the console + 1. Right click "This PC" and Select "Properties" + 2. Go to the Advanced Tab and click on "Enviromental Varibles" + 3. Select Path under System Varibles and click Edit + 4. Click New and paste the path to 7zip + 5. Close your console window and reopen. You can type 7z to make sure it's working. 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). From 2cd1e5f102feef911a5db6cfbb34b18cd4dd7f82 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:39:45 -0400 Subject: [PATCH 16/34] Update rpi.md --- docs/installation/rpi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/rpi.md b/docs/installation/rpi.md index 570d0f6a..998b741b 100644 --- a/docs/installation/rpi.md +++ b/docs/installation/rpi.md @@ -1,6 +1,6 @@ --- layout: page -title: OS & Hardware Specific Information +title: Raspberry Pi --- ## Raspberry Pi From 7495cfb3851e448e7136e4218a23893a72f3a31d Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:39:52 -0400 Subject: [PATCH 17/34] Update os-hardware.md --- docs/installation/os-hardware.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installation/os-hardware.md b/docs/installation/os-hardware.md index f50107ca..15237ff9 100644 --- a/docs/installation/os-hardware.md +++ b/docs/installation/os-hardware.md @@ -1,11 +1,11 @@ --- layout: page -title: OS/Hardware Specific +title: OS & Hardware Specific Information --- There are multiple ways of installing ENiGMA BBS, depending on your level of experience and desire to do things manually versus have it automated for you. -| Method | Operating System Compatibility | Notes | -|----------------------------------------|------------------------------------------------|---------------------------------------------------------------------------------------------| -| [Raspberry Pi](rpi) | Linux, BSD, OSX | All Raspberry Pi models work great with ENiGMA½! | -| [Windows](windows) | Windows | Easy upgrades, compatible with all operating systems, no dependencies to install | +| Method | Notes | +|----------------------------------------|---------------------------------------------------------------------------------------------| +| [Raspberry Pi](rpi) | All Raspberry Pi models work great with ENiGMA½! | +| [Windows](windows) | Compatible with all windows operating systems | From c85568b2922d799512ffbf63924b36035b8da39d Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:40:22 -0400 Subject: [PATCH 18/34] Update rpi.md --- docs/installation/rpi.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/installation/rpi.md b/docs/installation/rpi.md index 998b741b..fb8ff235 100644 --- a/docs/installation/rpi.md +++ b/docs/installation/rpi.md @@ -2,7 +2,6 @@ layout: page title: Raspberry Pi --- -## Raspberry Pi All Raspberry Pi models work great with ENiGMA½! Keep in mind compiling the dependencies with `npm install` will take some time and *may* appear to hang. It's still working - just be patient and let it From 862f31539bba37b7422244de46a28f1074af5fad Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:41:40 -0400 Subject: [PATCH 19/34] Update os-hardware.md --- docs/installation/os-hardware.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/os-hardware.md b/docs/installation/os-hardware.md index 15237ff9..a49283b4 100644 --- a/docs/installation/os-hardware.md +++ b/docs/installation/os-hardware.md @@ -8,4 +8,4 @@ things manually versus have it automated for you. | Method | Notes | |----------------------------------------|---------------------------------------------------------------------------------------------| | [Raspberry Pi](rpi) | All Raspberry Pi models work great with ENiGMA½! | -| [Windows](windows) | Compatible with all windows operating systems | +| [Windows](windows) | Compatible with all Windows Operating Systems | From ce0ee8639ac28db4dfdc587a13911cee124e953a Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:42:23 -0400 Subject: [PATCH 20/34] Update windows.md --- docs/installation/windows.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 1fcc4823..fbf8cc17 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -2,7 +2,6 @@ layout: page title: Windows Full Install --- -## Windows ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors naively then you should use a 32 bit Windows. From 3f2821440c9df1aabe969548fd8fd1572e9fb7f7 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:46:56 -0400 Subject: [PATCH 21/34] Update windows.md --- docs/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index fbf8cc17..354f6252 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -3,7 +3,7 @@ layout: page title: Windows Full Install --- -ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors naively then you should use a 32 bit Windows. +ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors natively then you should use a 32 bit Windows. ### Basic Instructions From 940cb016b3f76f2bc57b09b107b32d568da83356 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:54:34 -0400 Subject: [PATCH 22/34] Update windows.md --- docs/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 354f6252..3d802ce4 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -50,7 +50,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 5. Install ENiGMA½. - 1. In the enigma directory run 'npm install' + 1. In the enigma directory run `npm install` 2. Generate your initial configuration: ```Powershell node .\oputil.js config new From 79b82efbdeb3fc88a5540e6a2dd3af2fedd61c7c Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:56:40 -0400 Subject: [PATCH 23/34] Update windows.md --- docs/installation/windows.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 3d802ce4..db26b0a6 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -12,18 +12,18 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. + `*Run PowerShell as Administrator` + ```Powershell - *Run PowerShell as Administrator Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force npm install -g npm-windows-upgrade npm-windows-upgrade ``` - Note: Do not run npm i -g npm. Instead use npm-windows-upgrade to update npm going forward. + Note: Do not run `npm i -g npm`. Instead use `npm-windows-upgrade` to update npm going forward. Also if you run the NodeJS installer, it will replace the node version.: - 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) *This will also install python 2.7 ```Powershell From f00bf71b5b131feaba0f304d3e7421e8d4de10f5 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:58:56 -0400 Subject: [PATCH 24/34] Update windows.md --- docs/installation/windows.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index db26b0a6..20378591 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -34,10 +34,10 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 2. Install [7zip](https://www.7-zip.org/download.html). *Add 7zip to your path so 7z can be called from the console - 1. Right click "This PC" and Select "Properties" - 2. Go to the Advanced Tab and click on "Enviromental Varibles" - 3. Select Path under System Varibles and click Edit - 4. Click New and paste the path to 7zip + 1. Right click `This PC` and Select `Properties` + 2. Go to the `Advanced` Tab and click on `Enviromental Varibles` + 3. Select `Path` under `System Varibles` and click `Edit` + 4. Click `New` and paste the path to 7zip 5. Close your console window and reopen. You can type 7z to make sure it's working. 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). @@ -46,7 +46,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo ```Powershell git clone "https://github.com/NuSkooler/enigma-bbs.git" ``` - Optionally use the TortoiseGit by right clicking the directory and slecting "Git Clone...". + Optionally use the TortoiseGit by right clicking the directory and slecting `Git Clone...`. 5. Install ENiGMA½. From 04fcd3e6a76d392c29a9c4c153b78d90ffedfd41 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 01:59:47 -0400 Subject: [PATCH 25/34] Update windows.md --- docs/installation/windows.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 20378591..1531dc7b 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -15,7 +15,6 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo `*Run PowerShell as Administrator` ```Powershell - Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force npm install -g npm-windows-upgrade npm-windows-upgrade @@ -25,7 +24,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo Also if you run the NodeJS installer, it will replace the node version.: 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) - *This will also install python 2.7 + `*This will also install python 2.7` ```Powershell npm install --global --production windows-build-tools ``` From 51434774a984bfc9cd8aca7cff6c7cb4f4f61786 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:00:41 -0400 Subject: [PATCH 26/34] Update windows.md --- docs/installation/windows.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 1531dc7b..4c33a528 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -49,7 +49,8 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 5. Install ENiGMA½. - 1. In the enigma directory run `npm install` + 1. In the enigma directory run + ```npm install``` 2. Generate your initial configuration: ```Powershell node .\oputil.js config new From c2ccaf90d7ca4f90a45f9cd1dc7c508b264b10c0 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:03:27 -0400 Subject: [PATCH 27/34] Update windows.md --- docs/installation/windows.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 4c33a528..0b991923 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -3,7 +3,7 @@ layout: page title: Windows Full Install --- -ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doors natively then you should use a 32 bit Windows. +ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit doors natively then you should use a 32bit Windows. ### Basic Instructions @@ -32,7 +32,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 2. Install [7zip](https://www.7-zip.org/download.html). - *Add 7zip to your path so 7z can be called from the console + *Add 7zip to your path so `7z` can be called from the console 1. Right click `This PC` and Select `Properties` 2. Go to the `Advanced` Tab and click on `Enviromental Varibles` 3. Select `Path` under `System Varibles` and click `Edit` @@ -41,7 +41,7 @@ ENiGMA½ will run on both 32bit and 64 bit Windows. If you want to run 16bit doo 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/). -4. Clone Enigma - browse to the directory you want and run +4. Clone ENiGMA½ - browse to the directory you want and run ```Powershell git clone "https://github.com/NuSkooler/enigma-bbs.git" ``` From f1b8de85fd07f3e4d7a1c44a011e83fba5923bbe Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:06:00 -0400 Subject: [PATCH 28/34] Update windows.md --- docs/installation/windows.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 0b991923..e4ac0328 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -50,7 +50,9 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door 5. Install ENiGMA½. 1. In the enigma directory run - ```npm install``` + ```Powershell + npm install + ``` 2. Generate your initial configuration: ```Powershell node .\oputil.js config new From de055961f99a1d85765742f9a83edefdfdaa72a5 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:06:29 -0400 Subject: [PATCH 29/34] Update windows.md --- docs/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index e4ac0328..02bb5181 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -45,7 +45,7 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door ```Powershell git clone "https://github.com/NuSkooler/enigma-bbs.git" ``` - Optionally use the TortoiseGit by right clicking the directory and slecting `Git Clone...`. + Optionally use the TortoiseGit by right clicking the directory and selecting `Git Clone`. 5. Install ENiGMA½. From baaa3d93bbf1206ddff39e90d80d1acebeed7fda Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:08:22 -0400 Subject: [PATCH 30/34] Update windows.md --- docs/installation/windows.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 02bb5181..32aba68e 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -53,11 +53,10 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door ```Powershell npm install ``` - 2. Generate your initial configuration: + 2. Generate your initial configuration: `Follow the prompts!` ```Powershell node .\oputil.js config new ``` - Follow the prompts! 3. Edit any configuration files 4. Run ENiGMA½ ```Powershell From 95564167b262bc7237abc00a1fd4f43784abb35a Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:11:37 -0400 Subject: [PATCH 31/34] Update windows.md --- docs/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 32aba68e..32df3466 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -57,7 +57,7 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door ```Powershell node .\oputil.js config new ``` - 3. Edit any configuration files + 3. Edit your configuration files in `enigma-bbs\config` with [Notepad++](https://notepad-plus-plus.org/download/) or [Visual Studio Code](https://code.visualstudio.com/Download) 4. Run ENiGMA½ ```Powershell node .\main.js From 1fc4a8828b1a1749430f5dfbe3d6ca0f990251a6 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:16:26 -0400 Subject: [PATCH 32/34] Update windows.md --- docs/installation/windows.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index 32df3466..a87c88be 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -10,13 +10,15 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door 1. Download and Install [Node.JS](https://nodejs.org/en/download/). - 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. - - `*Run PowerShell as Administrator` + 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. `*Run PowerShell as Administrator` + `*Inital Install` ```Powershell Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force npm install -g npm-windows-upgrade + ``` + `*Upgrade` + ```Powershell npm-windows-upgrade ``` From 2d67cddfd07ac5d6e10def31c6d1cd720260b03c Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:18:13 -0400 Subject: [PATCH 33/34] Update windows.md --- docs/installation/windows.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index a87c88be..f977a246 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -12,21 +12,21 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door 1. Upgrade NPM : At this time node comes with NPM 5.6 preinstalled. To upgrade to a newer version now or in the future on windows follow this method. `*Run PowerShell as Administrator` - `*Inital Install` - ```Powershell - Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force - npm install -g npm-windows-upgrade - ``` - `*Upgrade` - ```Powershell - npm-windows-upgrade - ``` + `*Inital Install` + ```Powershell + Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force + npm install -g npm-windows-upgrade + ``` + `*Upgrade` + ```Powershell + npm-windows-upgrade + ``` - Note: Do not run `npm i -g npm`. Instead use `npm-windows-upgrade` to update npm going forward. - Also if you run the NodeJS installer, it will replace the node version.: + Note: Do not run `npm i -g npm`. Instead use `npm-windows-upgrade` to update npm going forward. + Also if you run the NodeJS installer, it will replace the node version.: 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) - `*This will also install python 2.7` + `*This will also install python 2.7` ```Powershell npm install --global --production windows-build-tools ``` From 9ecb587ed31dd22de6781f4a8400234115851f1e Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Sat, 24 Mar 2018 02:22:14 -0400 Subject: [PATCH 34/34] Update windows.md --- docs/installation/windows.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/installation/windows.md b/docs/installation/windows.md index f977a246..9ee0b0b4 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -39,7 +39,7 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door 2. Go to the `Advanced` Tab and click on `Enviromental Varibles` 3. Select `Path` under `System Varibles` and click `Edit` 4. Click `New` and paste the path to 7zip - 5. Close your console window and reopen. You can type 7z to make sure it's working. + 5. Close your console window and reopen. You can type `7z` to make sure it's working. 3. Install [Git](https://git-scm.com/downloads) and optionally [TortoiseGit](https://tortoisegit.org/download/).