Merge pull request #170 from Jasin2069/master

Documentation updates
This commit is contained in:
Bryan Ashby 2018-03-29 19:53:56 -06:00 committed by GitHub
commit 5a2974ca2c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 10 deletions

View File

@ -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` 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 ```Powershell
Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force Set-ExecutionPolicy Unrestricted -Scope CurrentUser -Force
npm install -g npm-windows-upgrade 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. 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) 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`
@ -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.

View File

@ -16,10 +16,11 @@ You then need to enable the SSH server in your `config.hjson`:
{ {
loginServers: { loginServers: {
ssh: { ssh: {
enabled: true enabled: true
port: 8889 port: 8889
privateKeyPass: YOUR_PK_PASS privateKeyPem: /path/to/ssh_private_key.pem
} privateKeyPass: YOUR_PK_PASS
}
} }
} }
``` ```

View File

@ -1,4 +1,25 @@
--- ---
layout: page layout: page
title: Telnet Server title: Telnet Server
--- ---
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 telnet server
| `port` | Configure a custom port for the telnet server

View File

@ -21,14 +21,14 @@ There are a few things out of scope of this document:
## Setup ## 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). don't already have it defined).
````hjson ````hjson
loginServers: { loginServers: {
webSocket : { webSocket : {
port: 8810
enabled: true enabled: true
port: 8810
securePort: 8811 securePort: 8811
certPem: /path/to/https_cert.pem certPem: /path/to/https_cert.pem
keyPem: /path/to/https_cert_key.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: 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") ![VTXClient](../assets/images/vtxclient.png "VTXClient")