diff --git a/docs/_includes/nav.md b/docs/_includes/nav.md index 168e1cf5..dacb2f00 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 %}) diff --git a/docs/installation/os-hardware.md b/docs/installation/os-hardware.md index 21eac4d9..a49283b4 100644 --- a/docs/installation/os-hardware.md +++ b/docs/installation/os-hardware.md @@ -2,31 +2,10 @@ layout: page title: OS & Hardware Specific Information --- -## 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 | Notes | +|----------------------------------------|---------------------------------------------------------------------------------------------| +| [Raspberry Pi](rpi) | All Raspberry Pi models work great with ENiGMA½! | +| [Windows](windows) | Compatible with all Windows Operating Systems | diff --git a/docs/installation/rpi.md b/docs/installation/rpi.md new file mode 100644 index 00000000..fb8ff235 --- /dev/null +++ b/docs/installation/rpi.md @@ -0,0 +1,27 @@ +--- +layout: page +title: 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! diff --git a/docs/installation/windows.md b/docs/installation/windows.md new file mode 100644 index 00000000..9ee0b0b4 --- /dev/null +++ b/docs/installation/windows.md @@ -0,0 +1,69 @@ +--- +layout: page +title: Windows Full Install +--- + +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 + +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` + + `*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.: + + 2. Install [windows-build-tools for npm](https://www.npmjs.com/package/windows-build-tools) + `*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). + + *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/). + +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 selecting `Git Clone`. + + +5. Install ENiGMA½. + 1. In the enigma directory run + ```Powershell + npm install + ``` + 2. Generate your initial configuration: `Follow the prompts!` + ```Powershell + node .\oputil.js config new + ``` + 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 + ``` + + +6. Profit!