| ramverma | af74a62 | 2018-07-31 18:25:39 +0100 | [diff] [blame^] | 1 | // |
| 2 | // ============LICENSE_START======================================================= |
| 3 | // Copyright (C) 2016-2018 Ericsson. All rights reserved. |
| 4 | // ================================================================================ |
| 5 | // This file is licensed under the CREATIVE COMMONS ATTRIBUTION 4.0 INTERNATIONAL LICENSE |
| 6 | // Full license text at https://creativecommons.org/licenses/by/4.0/legalcode |
| 7 | // |
| 8 | // SPDX-License-Identifier: CC-BY-4.0 |
| 9 | // ============LICENSE_END========================================================= |
| 10 | // |
| 11 | // @author Sven van der Meer (sven.van.der.meer@ericsson.com) |
| 12 | // |
| 13 | |
| 14 | == Requirements |
| 15 | APEX is 100% written in Java and runs on any platform that supports a JVM, e.g. Windows, Unix, Cygwin. |
| 16 | Some APEX applications (such as the monitoring application) come as web archives, they do require a war-capable web server installed. |
| 17 | |
| 18 | |
| 19 | === Installation Requirements |
| 20 | |
| 21 | - Downloaded distribution: JAVA runtime environment (JRE, Java 8 or later, APEX is tested with the Oracle Java) |
| 22 | - Building from source: JAVA development kit (JDK, Java 8 or later, APEX is tested with the Oracle Java) |
| 23 | - A web archive capable webserver, for instance for the monitoring application |
| 24 | ** for instance link:https://tomcat.apache.org/[Apache Tomcat] |
| 25 | - Sufficient rights to install APEX on the system |
| 26 | - Installation tools depending on the installation method used: |
| 27 | ** ZIP to extract from a ZIP distribution |
| 28 | *** Windows for instance link:http://www.7-zip.org/[7Zip] |
| 29 | ** TAR and GZ to extract from that TAR.GZ distribution |
| 30 | *** Windows for instance link:http://www.7-zip.org/[7Zip] |
| 31 | ** RPM to install from the RPM distribution |
| 32 | *** Install: `sudo apt-get install rpm` |
| 33 | ** DPKG to install from the DEB distribution |
| 34 | *** Install: `sudo apt-get install dpkg` |
| 35 | |
| 36 | |
| 37 | === Feature Requirements |
| 38 | APEX supports a number of features that require extra software being installed. |
| 39 | |
| 40 | - link:https://kafka.apache.org/[Apache Kafka] to connect APEX to a Kafka message bus |
| 41 | - link:https://hazelcast.com/[Hazelcast] to use distributed hash maps for context |
| 42 | - link:http://infinispan.org/[Infinispan] for distributed context and persistence |
| 43 | - link:https://www.docker.com/[Docker] to run APEX inside a Docker container |
| 44 | |
| 45 | |
| 46 | === Build (Install from Source) Requirements |
| 47 | Installation from source requires a few development tools |
| 48 | |
| 49 | - GIT to retrieve the source code |
| 50 | - Java SDK, Java version 8 or later |
| 51 | - Apache Maven 3 (the APEX build environment) |
| 52 | |