aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMinteck <freeziv.ytb@gmail.com>2021-03-07 18:39:18 +0100
committerMinteck <freeziv.ytb@gmail.com>2021-03-07 18:39:18 +0100
commit95d4b81b3ea6dec0867f07e4692fc0567f4ce06b (patch)
tree943fe941d77e8bdc7803e03e6f5fb80bc8518364
parent0f79e708bf07721b73ea41e5d341be08e8ea4dce (diff)
downloadelectrode-95d4b81b3ea6dec0867f07e4692fc0567f4ce06b.tar.gz
electrode-95d4b81b3ea6dec0867f07e4692fc0567f4ce06b.tar.bz2
electrode-95d4b81b3ea6dec0867f07e4692fc0567f4ce06b.zip
Better README.md
-rw-r--r--README.md25
1 files changed, 21 insertions, 4 deletions
diff --git a/README.md b/README.md
index ee07fd4..37e5f09 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ Electrode is a NodeJS webserver with a PHP subsystem. Electrode can serve static
Electrode is meant to be fast, reliable and unattended (it will automatically update an installed software when needed). Electrode is made to be used with FNS Neutron, but can also (but not recommended to) be used with other software.
+> Electrode and Neutron can only work on Linux servers. To use it on Windows servers, please use WSL 2 and follow instructions in [Windows Setup](#Windows_Setup)
+
## Getting started
The first time you need to run Electrode, you'll need to compile some dependencies:
```plaintext
@@ -20,12 +22,27 @@ npm start
node index.js
```
-Normal startup will start « sharded » processes that will use all your CPU cores. If you have some problems with that or want a less-consuming server, start normally and press a key when the « Press any key to start with sharding disabled » message appears.
+Electrode will start in threaded mode (one thread per CPU core) for optimal performance.
-> **Important :** There's a `cache` folder, **NEVER DELETE ITS CONTENT** or it will break PHP scripts. Files in the `cache` folder are deleted when needed.
+> **Important :** There's a `cache` folder, **NEVER DELETE ITS CONTENT** or it will break PHP scripts. Files in the `cache` folder are automatically deleted by Electrode.
## Requirements
-* PHP 7.0 or newer
+* NodeJS 12 or newer
+* PHP 7.4 or newer
* The `xdebug` extension (used to get the response headers from PHP)
* `make` and all development libraries
-* The NPM package manager \ No newline at end of file
+* The NPM package manager
+
+## Windows Setup
+As said earlier, Electrode and Neutron can't run on Windows servers. If you want to use a Windows server, you can use WSL.
+
+> Before continuing, please note that using a Windows server in a production environement is really discouraged, as Neutron asn't been extensively tested through WSL.
+
+1. First, [install WSL](https://docs.microsoft.com/en-us/windows/wsl/install-win10) by following the Microsoft documentation
+> Don't miss the part about upgrading to WSL 2, it is VERY important
+2. Install `php` (version 7.4 or later), `php-xdebug`, `nodejs` (version 12 or later), `npm` and `make`.
+> On Debian or Ubuntu, you would install with
+>
+> ```sudo apt install php php-xdebug nodejs npm make build-essential```
+3. Download and extract Electrode on your WSL
+4. Follow the instructions in [Getting started](#Getting_started) \ No newline at end of file