Archives/Athou_commafeed
1
0
Fork 1
mirror of https://github.com/Athou/commafeed.git synced 2026-03-21 21:37:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

self-hosting instructions

Browse Source
This commit is contained in:
Athou
2013-04-29 17:05:20 +02:00
parent f7004bf625
commit 7c061d333a
1 changed files with 31 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@@ -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 `<Connector port="8082" protocol="HTTP/1.1"`. Change the port to the value you'd like to use.
* CommaFeed will run on the `/commafeed` context. If you'd like to change the context, go to `webapps` and rename `commafeed.war`. Use the special name `ROOT.war` to deploy to the root context.
* To start and stop the application, use `bin/startup.sh` and `bin/shutdown.sh` on Linux (you may need to `chmod +x bin/*.sh`) or `bin\startup.bat` and `bin\shutdown.bat` on Windows.
Local development
-----------------