blob: ef3d1cf5b933a563508918ac37c04fef71cf1324 [file] [log] [blame]
ramvermaaf74a622018-07-31 18:25:39 +01001//
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== Installation Layout
15
16A full installation of APEX comes with the following layout.
17
18----
19$APEX_HOME
20 ├───bin <1>
21 ├───etc <2>
22 ├───editor
23 ├───hazelcast
24 ├───infinispan
25 └───META-INF
26 ├───examples <3>
27 ├───config <4>
28 ├───docker <5>
29 ├───events <6>
30 ├───models <7>
31 └───scripts <8>
32 ├───lib <9>
33 └───applications <10>
34 └───war <11>
35----
36<1> binaries, mainly scripts (bash and bat) to start the APEX engine and applications
37<2> configuration files, such as logback (logging) and third party library configurations
38<3> example policy models to get started
39<4> configurations for the examples (with sub directories for individual examples)
40<5> Docker files and additional Docker instructions for the exampples
41<6> example events for the examples (with sub directories for individual examples)
42<7> the policy models, generated for each example (with sub directories for individual examples)
43<8> additional scripts for the examples (with sub directories for individual examples)
44<9> the library folder with all Java JAR files
45<10> applications, also known as jar with dependencies (or fat jars), individually deployable
46<11> WAR files for web applications
47