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

docker README tweaks

Browse Source
This commit is contained in:
Athou
2024-08-19 08:47:23 +02:00
parent 51f15bf487
commit 134c4621a8
1 changed files with 5 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
commafeed-server/src/main/docker/README.md
View File

@@ -4,7 +4,7 @@ Official docker images for https://github.com/Athou/commafeed/
## Quickstart ## Quickstart
Start CommaFeed with an embedded database. Then login as `admin/admin` on http://localhost:8082/ Start CommaFeed with a H2 embedded database. Then login as `admin/admin` on http://localhost:8082/
### docker ### docker
@@ -30,7 +30,7 @@ services:
## Advanced ## Advanced
While using the H2 embedded database is perfectly fine for small instances, you may want to have more control over the While using the H2 embedded database is perfectly fine for small instances, you may want to have more control over the
database. Here's an example that uses postgresql (note the different docker tag): database. Here's an example that uses postgresql (note image tag change from `latest-h2` to `latest-postgresql`):
``` ```
services: services:
@@ -64,9 +64,8 @@ services:
All [CommaFeed settings](https://github.com/Athou/commafeed/blob/master/commafeed-server/doc/commafeed.adoc) are All [CommaFeed settings](https://github.com/Athou/commafeed/blob/master/commafeed-server/doc/commafeed.adoc) are
optional and have sensible default values. optional and have sensible default values.
Settings are overrideable with environment variables. For instance, `config.feedRefresh().intervalEmpirical()` can be Settings are overrideable with environment variables. For instance, `commafeed.feed-refresh.interval-empirical` can be
set set with the `COMMAFEED_FEED_REFRESH_INTERVAL_EMPIRICAL` variable.
with the `COMMAFEED_FEED_REFRESH_INTERVAL_EMPIRICAL=true` variable.
When logging in, credentials are stored in an encrypted cookie. The encryption key is randomly generated at startup, When logging in, credentials are stored in an encrypted cookie. The encryption key is randomly generated at startup,
meaning that you will have to log back in after each restart of the application. To prevent this, you can set the meaning that you will have to log back in after each restart of the application. To prevent this, you can set the
@@ -82,5 +81,4 @@ Tags are of the form `<version>-<database>[-jvm]` where:
- `master` (always points to the latest git commit) - `master` (always points to the latest git commit)
- `<database>` is the database to use (`h2`, `postgresql`, `mysql` or `mariadb`) - `<database>` is the database to use (`h2`, `postgresql`, `mysql` or `mariadb`)
- `-jvm` is optional and indicates that CommaFeed is running on a JVM, and not compiled natively. This image supports - `-jvm` is optional and indicates that CommaFeed is running on a JVM, and not compiled natively. This image supports
the the arm64 platform which is not yet supported by the native image.
arm64 platform which is not yet supported by the native image.