diff --git a/README.md b/README.md index 91e3bbae..75e60034 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Google Reader inspired self-hosted RSS reader, based on JAX-RS, Wicket and Angul Deploy on any JavaEE6 container or better yet on OpenShift. Deployment on OpenShift ----------------------------------------------- +----------------------- Hosting an application on OpenShift is free. @@ -20,6 +20,36 @@ Hosting an application on OpenShift is free. * Wait a couple of minutes and access your application. * The defaut user is `admin` and the password is `admin`. +Deployment on your own server +----------------------------- + +For storage, you can either use an embedded HSQLDB database or an external MySQL database. +Support for other databases is coming soon. +You also need maven (and a Java JDK) installed in order to build the application. + +To install maven and openjdk on Ubuntu, issue the following commands + + sudo add-apt-repository ppa:natecarlson/maven3 + sudo apt-get update + sudo apt-get install openjdk-7-jdk maven3 + sudo ln -s /usr/bin/mvn3 /usr/bin/mvn + +Now build the application + + Embedded HSQL database: + mvn clean package tomee:build -Pprod + + External MySQL database: + mvn clean package tomee:build -Pprod -Pmysql + +It will generate a zip file at `target/commafeed.zip` with everything you need to run the application. + +* Create a directory somewhere (e.g. `/opt/commafeed/`) and extract the generated zip inside this directory. +* If you used the MySQL option, create a database in your MySQL instance, then uncomment the `Resource` element from `conf/tomee.xml` and edit the default credentials. +* If you'd like to change the default port (8082), edit `conf/server.xml` and look for `