From c2f3e42867c74a15eb989eec01e67a17f3cfcbb5 Mon Sep 17 00:00:00 2001 From: Athou Date: Tue, 25 Apr 2023 08:57:55 +0200 Subject: [PATCH] Readme update --- README.md | 74 ++++++++++++++++++------------------------------------- 1 file changed, 24 insertions(+), 50 deletions(-) diff --git a/README.md b/README.md index b2e72a0ca..37c93cee4 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,11 @@ Browser extensions: ## Deployment on your own server -### The very short version (download precompiled package) +### Docker + +Docker images are built automatically and are available at https://hub.docker.com/r/athou/commafeed + +### Download precompiled package mkdir commafeed && cd commafeed wget https://github.com/Athou/commafeed/releases/download/3.0.0/commafeed.jar @@ -24,7 +28,10 @@ Browser extensions: vi config.yml java -Djava.net.preferIPv4Stack=true -jar commafeed.jar server config.yml -### The short version (build from sources) +The server will listen on http://localhost:8082. The default +user is `admin` and the default password is `admin`. + +### Build from sources git clone https://github.com/Athou/commafeed.git cd commafeed @@ -33,67 +40,33 @@ Browser extensions: vi config.yml java -Djava.net.preferIPv4Stack=true -jar commafeed-server/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 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 this commands works and returns a version >= 1.8.0 you're good to go and you can skip JDK installation - javac -version - - # 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 `commafeed-server/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 commafeed-server/target/commafeed.jar server config.yml - -You can use a proxy http server such as nginx or apache. +The server will listen on http://localhost:8082. The default +user is `admin` and the default password is `admin`. -## Translate CommaFeed into your language +## Translation -Files for internationalization are located [here](https://github.com/Athou/commafeed/tree/master/commafeed-client/src/locales). +Files for internationalization are +located [here](https://github.com/Athou/commafeed/tree/master/commafeed-client/src/locales). To add a new language: - edit `commafeed-client/src/i18n.ts` - - add the new locale to the `locales` array. - - import the dayjs locale + - add the new locale to the `locales` array. + - import the dayjs locale - edit `commafeed-client/.linguirc` and add the new locale to the `locales` array. - run `npm run i18n` and add translations to the newly created `commafeed-client/src/locales/[locale]/messages.po` file -The name of the locale should be the two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). +The name of the locale should be the +two-letters [ISO-639-1 language code](http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). ## Local development -- `git clone https://github.com/Athou/CommaFeed` - ### Backend - Open `commafeed-server` in your preferred Java IDE. - - CommaFeed uses Lombok, you need the Lombok plugin for your IDE. - - If using Eclipse, Go to Window → Preferences → Maven → Annotation Processing and check "Automatically configure JDT APT" + - CommaFeed uses Lombok, you need the Lombok plugin for your IDE. + - If using Eclipse, Go to Window → Preferences → Maven → Annotation Processing and check "Automatically configure + JDT APT" - Start `CommaFeedApplication.java` in debug mode with `server config.dev.yml` as arguments ### Frontend @@ -101,11 +74,12 @@ The name of the locale should be the two-letters [ISO-639-1 language code](http: - Open `commafeed-client` in your preferred JavaScript IDE. - run `npm install` - run `npm run dev` -- the frontend server is now running at http://localhost:8082 and is proxying REST requests to the backend running on port 8083 +- the frontend server is now running at http://localhost:8082 and is proxying REST requests to the backend running on + port 8083 ## Copyright and license -Copyright 2013-2022 CommaFeed. +Copyright 2013-2023 CommaFeed. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License.