Sources for CommaFeed.com.
Google Reader inspired self-hosted RSS reader, based on JAX-RS, Wicket and AngularJS.
Deploy on your own server (using TomEE, a lightweight JavaEE6 container based on Tomcat) or even in the cloud for free on OpenShift.
Related open-source projects
Deployment on OpenShift
Hosting an application on OpenShift is free. At the moment those instructions are not working because the application takes too long to build on OpenShift and causes a timeout. See here for an alternative method.
- Create an account on OpenShift.
- Add an application, select
JBoss Enterprise Application Platform 6.0.
- For the
Public URLset the name you want (e.g.
- For the
Source Codeoption, click
Changeand set this repository (
Add cartridgeand select
- Wait a couple of minutes and access your application.
- The default user is
adminand the password is
Deployment on your own server
For storage, you can either use an embedded HSQLDB database or an external MySQL, PostgreSQL or SQLServer database. You also need Maven 3.x (and a Java 1.7+ 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 # Not required but if you don't, use 'mvn3' instead of 'mvn' for the rest of the instructions. sudo ln -s /usr/bin/mvn3 /usr/bin/mvn
On Windows and other operating systems, just download maven 3.x from the official site, extract it somewhere and add the
bin directory to your
PATH environment variable.
Download the sources (it doesn't matter where, you can delete the directory when you're done). If you don't have git you can download the sources as a zip file from here
git clone https://github.com/Athou/commafeed.git cd commafeed
Now build the application
# Embedded HSQL database: mvn clean package tomee:build -Pprod # External MySQL database: mvn clean package tomee:build -Pprod -Pmysql # External PostgreSQL database: mvn clean package tomee:build -Pprod -Ppgsql # External Microsoft SQL Server database: mvn clean package tomee:build -Pprod -Pmssql
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.
- Create a directory called
- Copy the file
- If you don't use the embedded database, create a database in your external database instance, then uncomment the
Resourceelement corresponding to the database engine you use from
conf/tomee.xmland edit the default credentials.
- If you'd like to change the default port (8082), edit
conf/server.xmland 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
/commafeedcontext. If you'd like to change the context, go to
commafeed.war. Use the special name
ROOT.warto deploy to the root context.
- To start and stop the application, use
bin/shutdown.shon Linux (you need to
chmod +x bin/*.sh) or
bin\shutdown.baton Windows. If you use the embedded database, note that the database file will be created in the current directory, so make sure you always start the app in the same directory. You can optionally set an absolute path instead of a relative one in
- To update the application with a newer version, pull the latest changes and use the same command you used to build the complete TomEE package, but without the
-Pprod -P<database>). This will generate the file
target/commafeed.war. Copy this file to your tomee
- The application is online at http://localhost:8082/commafeed. Don't forget to set the public URL in the admin settings.
- The default user is
adminand the password is
You can use nginx or apache as a proxy http server. Note that when using apache, the
ProxyPreserveHost on option should be set in your config file.
Checkout the code and use maven to build and start a local TomEE instance.
mvn clean package tomee:run
The application is online at http://localhost:8082/commafeed. Any change to the source code will be applied immediatly.
The default user is
admin and the password is
Translate CommaFeed into your language
Files for internationalization are located here.
To add a new language, create a new file in that directory.
The name of the file should be the two-letters ISO-639-1 language code.
The language has to be referenced in the
languages.properties file to be picked up.
When adding new translations, add them in en.properties then run
mvn -e groovy:execute -Pi18n. It will parse the english file and add placeholders in the other translation files.
To create a theme, create a new file
src/main/webapp/sass/themes/_<theme>.scss. Your styles should be wrapped in a
#theme-<theme> element and use the SCSS format which is a superset of CSS.
Don't forget to reference your theme in
src/main/webapp/sass/app.scss and in
src/main/webapp/js/controllers.js (look for
See _test.scss for an example.
Copyright and license
Copyright 2013 CommaFeed.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License in the LICENSE file, or at:
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.