garrettmills/commafeed
1
0
Fork 0
forked from Archives/Athou_commafeed
Code Pull Requests Activity

README tweaks

Browse Source
This commit is contained in:
Athou
2024-08-13 17:26:51 +02:00
parent a92df774bd
commit 857736adad
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -47,8 +47,8 @@ system and database of choice.
There are two types of packages: There are two types of packages:
- The `linux` and `windows` packages are compiled natively and contain an executable that can be run directly. - The `linux` and `windows` packages are compiled natively and contain an executable that can be run directly.
- The `jvm` package contains a Java `.jar` file that works on all platforms and is started with - The `jvm` package is a zip file containing all `.jar` files required to run the application. This package works on all
`java -jar quarkus-run.jar`. platforms and is started with `java -jar quarkus-run.jar`.
If available for your operating system, the native package is recommended because it has a faster startup time and lower If available for your operating system, the native package is recommended because it has a faster startup time and lower
memory usage. memory usage.
@@ -63,6 +63,14 @@ memory usage.
variable variable
pointing to a GraalVM installation). pointing to a GraalVM installation).
When the build is complete:
- if you used the native profile, the executable is located at
`commafeed-server/target/commafeed-<version>-<database>-<platform>-<arch>-runner[.exe]`
- if you did not use the native profile, a zip containing all jars required to run the application is located at
`commafeed-server/target/commafeed-<version>-<database>.zip`. Extract it and run the application with
`java -jar quarkus-run.jar`
### Memory management (`jvm` package only) ### Memory management (`jvm` package only)
The Java Virtual Machine (JVM) is rather greedy by default and will not release unused memory to the The Java Virtual Machine (JVM) is rather greedy by default and will not release unused memory to the
@@ -118,8 +126,7 @@ CommaFeed only requires 3 properties to be configured:
- e.g. for MariaDB: - e.g. for MariaDB:
`jdbc:mariadb://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC` `jdbc:mariadb://localhost/commafeed?autoReconnect=true&failOverReadOnly=false&maxReconnects=20&rewriteBatchedStatements=true&timezone=UTC`
All All other [CommaFeed settings](commafeed-server/src/main/java/com/commafeed/CommaFeedConfiguration.java)
other [CommaFeed settings](commafeed-server/src/main/java/com/commafeed/CommaFeedConfiguration.java)
are optional and have sensible default values. are optional and have sensible default values.
When started, the server will listen on http://localhost:8082. When started, the server will listen on http://localhost:8082.