From 2ad02d9ece4547a15c90cf262641968227f33a2b Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Thu, 29 Mar 2018 18:20:55 -0400 Subject: [PATCH 1/5] Added Telnet content --- docs/servers/telnet.md | 23 ++++++++++++++++++++++- 1 file changed, 22 insertions(+), 1 deletion(-) diff --git a/docs/servers/telnet.md b/docs/servers/telnet.md index 155e6726..951c09eb 100644 --- a/docs/servers/telnet.md +++ b/docs/servers/telnet.md @@ -1,4 +1,25 @@ --- layout: page title: Telnet Server ---- \ No newline at end of file +--- + +Telnet is enabled by default on port `8888` in `config.hjson`: + +```hjson +{ + loginServers: { + telnet: { + enabled: true + port: 8888 + } + } +} +``` + +### Telnet Server Options + +| Option | Description +|---------------------|--------------------------------------------------------------------------------------| +| `firstMenu` | First menu a telnet connected user is presented with +| `enabled` | Enable/disable SSH server +| `port` | Configure a custom port for the SSH server From cbb3970605a23a00d8f3a6780709e37ae10121ec Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Thu, 29 Mar 2018 18:29:03 -0400 Subject: [PATCH 2/5] Update ssh.md --- docs/servers/ssh.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/servers/ssh.md b/docs/servers/ssh.md index ca0b62ec..676afb51 100644 --- a/docs/servers/ssh.md +++ b/docs/servers/ssh.md @@ -16,10 +16,11 @@ You then need to enable the SSH server in your `config.hjson`: { loginServers: { ssh: { - enabled: true + enabled: true port: 8889 - privateKeyPass: YOUR_PK_PASS - } + privateKeyPem: /path/to/ssh_private_key.pem + privateKeyPass: YOUR_PK_PASS + } } } ``` From 7378361d0954f5df35d50dac8e7f8c027d9b7e41 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Thu, 29 Mar 2018 18:33:23 -0400 Subject: [PATCH 3/5] Update websocket.md Added file location, put enable field at top --- docs/servers/websocket.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/servers/websocket.md b/docs/servers/websocket.md index 62df02d7..40d4b679 100644 --- a/docs/servers/websocket.md +++ b/docs/servers/websocket.md @@ -21,14 +21,14 @@ There are a few things out of scope of this document: ## Setup -1. Enable the websocket in ENiGMA, by adding `webSocket` configuration to the `loginServers` block (create it if you +1. Enable the websocket in ENiGMA, by adding `webSocket` configuration to the `loginServers` block in `config.hjson` (create it if you don't already have it defined). ````hjson loginServers: { webSocket : { - port: 8810 enabled: true + port: 8810 securePort: 8811 certPem: /path/to/https_cert.pem keyPem: /path/to/https_cert_key.pem @@ -88,4 +88,4 @@ otherwise. 9. If you navigate to http://your-hostname.here/vtx.html, you should see a splash screen like the following: ![VTXClient](../assets/images/vtxclient.png "VTXClient") - \ No newline at end of file + From d6633fb37857872f5161589b27984cea0b4ac690 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Thu, 29 Mar 2018 18:46:14 -0400 Subject: [PATCH 4/5] 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 9ee0b0b4..4eaed906 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -12,7 +12,7 @@ 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` + `*Initial Install` ```Powershell Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force npm install -g npm-windows-upgrade @@ -23,7 +23,7 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door ``` 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.: + 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` @@ -66,4 +66,4 @@ ENiGMA½ will run on both 32bit and 64bit Windows. If you want to run 16bit door ``` -6. Profit! +6. Look at [Production Installation](/installation/production) for maintaining ENiGMA½ when you are ready to go live. From 2926bb55cc887c357afc65c2cbf673fe328a9be8 Mon Sep 17 00:00:00 2001 From: Jasin2069 Date: Thu, 29 Mar 2018 21:47:51 -0400 Subject: [PATCH 5/5] Update telnet.md --- docs/servers/telnet.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/servers/telnet.md b/docs/servers/telnet.md index 951c09eb..47aba591 100644 --- a/docs/servers/telnet.md +++ b/docs/servers/telnet.md @@ -21,5 +21,5 @@ Telnet is enabled by default on port `8888` in `config.hjson`: | Option | Description |---------------------|--------------------------------------------------------------------------------------| | `firstMenu` | First menu a telnet connected user is presented with -| `enabled` | Enable/disable SSH server -| `port` | Configure a custom port for the SSH server +| `enabled` | Enable/disable telnet server +| `port` | Configure a custom port for the telnet server