image::https://www.aiticon.com/assets/images/appng_logo_760px.jpg[]
:snapshot: 1.26.5-SNAPSHOT
:stable: 1.24.1
:current: {stable}

Welcome to appNG, the **N**ext **G**eneration **app**lication platform!

'''

= Requirements

* JRE >= 1.8.x +
http://www.oracle.com/technetwork/java/javase/downloads/index.html
* Apache Tomcat 8.5.x and 9.x +
http://tomcat.apache.org/
* for persistence, MySql >= 5.6.x is used by default +
https://dev.mysql.com/downloads/mysql/

= Configuration & Installation

* Download and unpack Apache Tomcat. The target folder is referred to as `$CATALINA_HOME` in the following.
* Download the appNG web application: https://appng.org/appng/builds/stable/appng-application-{stable}.war[appng-application-{stable}.war^] +
(The latest SNAPSHOT Version is available here: https://appng.org/appng/builds/snapshot/appng-application-{snapshot}.war[appng-application-{snapshot}.war^]) 
* Delete all folders from `$CATALINA_HOME/webapps`
* Expand `appng-application-{stable}.war` to `$CATALINA_HOME/webapps/ROOT`
* Create a new database with the DB management tool of your choice and set your database connection properties in the file
		`WEB-INF/conf/appNG.properties`
* Download Connector/J from here http://dev.mysql.com/downloads/connector/j/ and save `mysql-connector-java-5.1.47.jar` to `$CATALINA_HOME/lib`
* Verify that `CATALINA_HOME` and `APPNG_HOME` in `WEB-INF/bin/appng` (for unix/linux based systems) or `WEB-INF/bin/appng.bat` (for windows based systems) match your local machine settings (change/uncomment the respective lines if necessary)
* in `WEB-INF/conf/install.list`
	** set the variable `ADMIN_SUBJECT` (#15) to your desired username
	
		def ADMIN_SUBJECT=johndoe
		
	** in the line starting with "create-subject" (#31), set your desired password (-p), full name (-n) and e-mail address (-e)
	
		create-subject -u $ADMIN_SUBJECT -p secret -n "John Doe" -l en -e jd@example.org
		
* On a command prompt, change to `WEB-INF/bin` and run
+
[source]
----
chmod +x appng
./appng batch -f ../conf/install.list
----
(for unix/linux based systems)

+
[source]
----
appng batch -f ..\conf\install.list
----
(for windows based systems)

* Start Tomcat
+
[source]
----
$CATALINA_HOME/bin/catalina.sh run
----
(for unix/linux based systems)
+
[source]
----
%CATALINA_HOME%/bin/catalina.bat run
----
(for windows based systems)
	
* Check `WEB-INF/log/appNG.log` +
	if you see the line
		 `appNG {stable} started in xxx ms.`
	at the end, startup was successful

* Browse to	http://localhost:8080/manager to login with your username/password

* Enjoy!

* Start developing your own applications! Check out the https://appng.org/appng/docs/current/reference/html/developerguide.html[developer guide].