You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/install.md
+29-74Lines changed: 29 additions & 74 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,16 @@
1
1
# Installing JSON-SCADA
2
2
3
-
## Supported Hardware/OS Platforms
4
-
5
-
* Most modern Linux x86-64 bits. Recommend Centos/Redhat 8.2, Oracle Linux 8 or equivalent.
3
+
## Compatible Hardware/OS Platforms
6
4
7
5
* Windows 10 or Server x86-64 bits (installer available).
8
6
9
-
* Linux ARM 32 bits (tested at least for protocol drivers on Raspberry Pi 3/Raspbian OS).
7
+
* Most modern Linux x86-64 bits. Recommend Centos/Redhat 8.2, Oracle Linux 8 or equivalent.
8
+
9
+
* Linux ARM 64 bits.
10
10
11
-
*Mac OSX (x64 Intel or M1 under Rosetta).
11
+
*Linux ARM 32 bits (only protocol drivers). MongoDB does not support any 32 bit OS.
12
12
13
-
It can also possibly work on Linux ARM-64.
13
+
* Mac OSX (x64 Intel or M1).
14
14
15
15
A full system can run on a single commodity x86 computer but for high performance and high availability on big systems (> 10.000 tags) it is strongly recommended the following hardware
16
16
@@ -37,8 +37,8 @@ The Windows Installer has everything needed to run the system (MongoDB, PostgreS
37
37
* Windows 10 or Server 2016/2019 (x86-64 bits), 8GB+ RAM.
38
38
* Admin privileges.
39
39
* Windows PowerShell.
40
-
* DotNet Core 5.0.3 x64 Runtime.
41
-
* Open SSL binaries for 64-bit Windows: https://slproweb.com/products/Win32OpenSSL.html.
40
+
* DotNet Core 5.0.x x64 Runtime.
41
+
* Open SSL 1.1.1m binaries for 64-bit Windows: https://slproweb.com/products/Win32OpenSSL.html.
42
42
43
43
### QUICKSTART
44
44
@@ -69,12 +69,12 @@ To install JSON-SCADA manually, it is required to install all the requirements f
69
69
70
70
### 1. MongoDB Server
71
71
72
-
Version 4.2.x or 4.4.x - Lower versions are not supported.
72
+
Versions 4.2.x, 4.4.x or 5.0.x - Lower versions are not supported.
73
73
74
74
*https://www.mongodb.com/try/download/community
75
75
*https://docs.mongodb.com/manual/installation/
76
76
77
-
The _MongoDB Atlas_ cloud service is also supported (4.2 or 4.4 versions).
77
+
The _MongoDB Atlas_ cloud service is also compatible.
78
78
79
79
The _Replica Set_ feature must be enabled, even when just one server is used because this is necessary for Change Streams to work.
80
80
@@ -88,7 +88,7 @@ For not trusted or open to Internet networks it is important to use TLS for Mong
88
88
89
89
### 2. PostgreSQL / TimescaleDB
90
90
91
-
PostgreSQL version 12. TimescaleDB version 1.7. Previous versions can work but are not recommended. Newer versions can work but were not tested.
91
+
PostgreSQL version 12, 13 or 14. TimescaleDB version 1.7 to 2.2.1 or newer. Previous versions can work but are not recommended. Newer versions can work but were not tested.
@@ -124,11 +124,12 @@ If certificates are configured for PostgreSQL connections to the server, it must
124
124
125
125
### 6. DotNet Core
126
126
127
-
* DotNet Core version 3.x or 5.x. Previous versions are not tested or supported.
127
+
* DotNet Core version 5.0.x. Previous versions are not tested or supported.
128
128
*https://dotnet.microsoft.com/download
129
129
130
130
### 7. Other recommended software tools
131
131
132
+
* Open SSL Light 1.1.1m (for Windows) - https://slproweb.com/download/Win64OpenSSL_Light-1_1_1m.msi.
132
133
* Nginx or some other web server - https://nginx.org/.
133
134
* Inkscape SAGE or SCADAvis.io SVG Editor for synoptic display creation - https://sourceforge.net/projects/oshmiopensubstationhmi/ or https://www.microsoft.com/en-us/p/scadavisio-synoptic-editor/9p9905hmkz7x . Available only for Windows.
Build the code (use inverted slashes, .exe extension and copy instead of cp on Windows, choose also the adequate Dotnet target platform (e.g. win-x64), on Mac use --runtime osx-x64)
Configure the conf/json-scada.json file to define the node name and to point to the MongoDB server. Processes will look for the config file on the ../conf/ folder.
Processes can be distributed on distinct servers, each server must have a different node name.
218
173
219
174
Multiple JSON-SCADA systems can run on the same server, for this each one must have a distinct MongoDB and PostgreSQL database and a separate folder structure. Also a distinct listen HTTP ports must be configured.
@@ -387,7 +342,7 @@ Use the manager tool to start, stop and monitor the system
387
342
tail -f cs_data_processor
388
343
help
389
344
390
-
### NSSM Configuration (Windows)
345
+
### NSSM Configuration on Windows (not necessary if used the Windows installer)
391
346
392
347
Install the NSSM tool. It can be installed in c:\json-scada\bin\ .
0 commit comments