Skip to content

Commit 8c01810

Browse files
authored
* #6935 Updated documentation for requirements (#7669)
* Fixed first line of war installation
1 parent a90ee42 commit 8c01810

File tree

1 file changed

+28
-14
lines changed

1 file changed

+28
-14
lines changed
Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,37 @@
11
# Requirements
2+
23
In this section you can have a glance of the minimum and recommended versions of the tools needed to build/debug/install MapStore
34

45
## War Installation
56

6-
You can download a java web container like Apache Tomcat from [here](https://tomcat.apache.org/download-70.cgi) and install it.
7+
You can download a java web container like *Apache Tomcat* from and *Java JRE*
78

8-
You will also need a Java [JRE](https://www.java.com/it/download/)(minimum version: 8)
9+
| Tool | Link | Minimum | Recommended | Maximum |
10+
|--------|----------------------------------------------------|---------|-------------|---------------|
11+
| Java | [link](https://www.java.com/it/download/) | 8 | 9 | 11¹ |
12+
| Tomcat | [link](https://tomcat.apache.org/download-80.cgi) | 8.5 | 9 ||
913

1014
## Debug / Build
1115

12-
These tools needs to be installed:
13-
14-
| Tool | Link | Minimum | Recommended | Deprecated |
15-
|---|---|---|---|---|
16-
| npm | <a href="https://www.npmjs.com/get-npm" target="_blank">link</a> | >= 5 | >= 6 | |
17-
| NodeJS | <a href="https://nodejs.org/en/" target="_blank">link</a> | >= 10 | >= 12 | <10 |
18-
| mvn | <a href="https://maven.apache.org/download.cgi" target="_blank">link</a> | >= 3.1.0 | >= 3.6 | |
19-
| python | <a href="https://www.python.org/downloads/" target="_blank">link</a> | >= 2.7.9 | >= 3.7 | |
20-
21-
Python is only needed for building documentation.
22-
23-
If you are using Node >= 12 you can remove the -max_old_space_size=2048 config for the compile *script*
16+
These tools needs to be installed (other than **Java** in versions above above):
17+
18+
| Tool | Link | Minimum | Recommended | Maximum |
19+
|------------|------------------------------------------------------------|---------|-------------|-------------|
20+
| npm | [link](https://www.npmjs.com/get-npm") | 5 | 6 | 6.14.13² |
21+
| NodeJS | [link](https://nodejs.org/en/") | 10 | 12 | 14.17.0² |
22+
| Java (JDK) | [link](https://www.java.com/en/download/help/develop.html) | 8 | 9 | 11¹ |
23+
| Maven | [link](https://maven.apache.org/download.cgi") | 3.1.0 | 3.6 | |
24+
| python³ | [link](https://www.python.org/downloads/") | 2.7.9 | 3.7 | |
25+
26+
!!! notes
27+
Here some notes about some requirements and reasons for max version indicated, for future improvements and maintenance :
28+
29+
- ¹ About Java and Tomcat
30+
- For execution tested on Java v11.
31+
- Build with success with v11, only smoke tests passing on v13, errors with v16.(Details on issue [#6935](https://github.com/geosolutions-it/MapStore2/issues/6935))
32+
- Running with Tomcat 10 causes this issue [#7524](https://github.com/geosolutions-it/MapStore2/issues/7524).
33+
- ² About NodeJS and NPM:
34+
- NPM 7 not supported yet.
35+
- NPM 6.14.15 causes [this issue](https://github.com/geosolutions-it/mapstore-project/issues/18) on MapStore project system. No other know issues.
36+
- *If you are using Node >= 12 you can remove the -max_old_space_size=2048 config for the `compile` script*
37+
- ³ Python is only needed for building documentation.

0 commit comments

Comments
 (0)