Skip to content

Commit

Permalink
mv_store=false is not required anymore (fixes #1007)
Browse files Browse the repository at this point in the history
  • Loading branch information
Athou committed Jul 25, 2022
1 parent fe87566 commit 6ffdc7b
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 23 deletions.
41 changes: 19 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ CommaFeed is now considered feature-complete and is in maintenance mode.

## Related open-source projects


Android apps: [News+ extension](https://github.com/Athou/commafeed-newsplus)

Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firefox](https://github.com/Athou/commafeed-firefox) - [Opera](https://github.com/Athou/commafeed-opera) - [Safari](https://github.com/Athou/commafeed-safari)
Expand All @@ -20,7 +19,7 @@ Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firef
wget https://github.com/Athou/commafeed/releases/download/2.5.0/commafeed.jar
wget https://raw.githubusercontent.com/Athou/commafeed/2.5.0/config.yml.example -O config.yml
vi config.yml
java -Djava.net.preferIPv4Stack=true -jar commafeed.jar server config.yml
java -Djava.net.preferIPv4Stack=true -jar commafeed.jar server config.yml

### The short version (build from sources)

Expand All @@ -29,41 +28,40 @@ Browser extensions: [Chrome](https://github.com/Athou/commafeed-chrome) - [Firef
./mvnw clean package
cp config.yml.example config.yml
vi config.yml
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml

### The long version (same as the short version, but more detailed)

CommaFeed 2.0 has been rewritten to use Dropwizard and gulp instead of using tomee and wro4j. The latest version of the 1.x branch is available [here](https://github.com/Athou/commafeed/tree/1.x).

For storage, you can either use an embedded H2 database (use it only to test CommaFeed) or an external MySQL, PostgreSQL or SQLServer database.
You also need the Java 1.8+ JDK in order to build the application.
For storage, you can either use an embedded file-based H2 database or an external MySQL, PostgreSQL or SQLServer database.
You also need the Java 1.8+ JDK in order to build the application.

To install the required packages to build CommaFeed on Ubuntu, issue the following commands

# if openjdk-8-jdk is not available on your ubuntu version (14.04 LTS), add the following repo first
sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update
# if openjdk-8-jdk is not available on your ubuntu version (14.04 LTS), add the following repo first
sudo add-apt-repository ppa:openjdk-r/ppa
sudo apt-get update

sudo apt-get install g++ build-essential openjdk-8-jdk

# Make sure java8 is the selected java version
sudo update-alternatives --config java
sudo update-alternatives --config javac



Clone this repository. If you don't have git you can download the sources as a zip file from [here](https://github.com/Athou/commafeed/archive/master.zip)

git clone https://github.com/Athou/commafeed.git
cd commafeed

Now build the application

./mvnw clean package

Copy `config.yml.example` to `config.yml` then edit the file to your liking.
Issue the following command to run the app, the server will listen by default on `http://localhost:8082`. The default user is `admin` and the default password is `admin`.

java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml
java -Djava.net.preferIPv4Stack=true -jar target/commafeed.jar server config.yml

You can use a proxy http server such as nginx or apache.

Expand All @@ -77,12 +75,11 @@ The language has to be referenced in the `src/main/app/js/i18n.js` file to be pi

## Themes

To create a theme, create a new file `src/main/app/sass/themes/_<theme>.scss`. Your styles should be wrapped in a `#theme-<theme>` element and use the [SCSS format](http://sass-lang.com/) which is a superset of CSS.
To create a theme, create a new file `src/main/app/sass/themes/_<theme>.scss`. Your styles should be wrapped in a `#theme-<theme>` element and use the [SCSS format](http://sass-lang.com/) which is a superset of CSS.

Don't forget to reference your theme in `src/main/app/sass/app.scss` and in `src/main/app/js/controllers.js` (look for `$scope.themes`).

See [_test.scss](https://github.com/Athou/commafeed/blob/master/src/main/app/sass/themes/_test.scss) for an example.

See [\_test.scss](https://github.com/Athou/commafeed/blob/master/src/main/app/sass/themes/_test.scss) for an example.

## Local development

Expand All @@ -91,13 +88,13 @@ Steps to configuring a development environment for CommaFeed may include, but ma
1. `git clone https://github.com/Athou/CommaFeed` into some folder to get the project files.
2. Install Eclipse Luna (or latest) from http://www.eclipse.org/downloads/packages/eclipse-ide-java-developers/lunasr1 or your repo if available.
3. In Eclipse, Window → Preferences → Maven → Annotation Processing. Check "Automatically configure JDT APT"
* You may have to install the m2e-apt connector to have "Annotation Processing" as an option. Do so from Window → Preferences → Maven → Discovery → Open Catalog → type "m2e-apt" in the search box
* If you have installed Eclipse EE instead of Luna, you may have trouble installing m2e-apt
- You may have to install the m2e-apt connector to have "Annotation Processing" as an option. Do so from Window → Preferences → Maven → Discovery → Open Catalog → type "m2e-apt" in the search box
- If you have installed Eclipse EE instead of Luna, you may have trouble installing m2e-apt
4. Install Lombok into Eclipse from http://projectlombok.org/download.html
* You may have to run `java -jar lombok.jar` as an administrator if your eclipse installation is not in your home folder
- You may have to run `java -jar lombok.jar` as an administrator if your eclipse installation is not in your home folder
5. In Eclipse, File → Import → Maven → Existing Maven Projects. Navigate to where you cloned the CommaFeed files into, and select that as the root directory. Click Finish.
* You may notice some errors along the lines of "Plugin execution not covered by lifecycle configuration". These are inconsequential.
6. Find the file "CommaFeedApplication.java" under the navigation pane.
- You may notice some errors along the lines of "Plugin execution not covered by lifecycle configuration". These are inconsequential.
6. Find the file "CommaFeedApplication.java" under the navigation pane.
7. Right click it to bring up the context menu → Debug as... → Debug Configurations
8. Type `server config.dev.yml` under "Program arguments" in the "Arguments" tab for the Java Application setting "CommaFeedApplication"
9. Apply and hit "Debug"
Expand All @@ -116,7 +113,7 @@ 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:

http://www.apache.org/licenses/LICENSE-2.0
http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
Expand Down
2 changes: 1 addition & 1 deletion config.yml.example
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ app:

database:
driverClass: org.h2.Driver
url: jdbc:h2:/home/commafeed/db;mv_store=false
url: jdbc:h2:/home/commafeed/db
user: sa
password: sa
properties:
Expand Down

0 comments on commit 6ffdc7b

Please sign in to comment.