forked from Archives/Athou_commafeed
add config doc sections
This commit is contained in:
@@ -110,6 +110,10 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|string
|
|string
|
||||||
|
|
|
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-http-client]] [.section-name.section-level0]##HTTP client configuration##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-http-client-user-agent]] [.property-path]##`commafeed.http-client.user-agent`##
|
a| [[commafeed-server_commafeed-http-client-user-agent]] [.property-path]##`commafeed.http-client.user-agent`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
@@ -246,6 +250,11 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]]
|
|MemorySize link:#memory-size-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the MemorySize format]]
|
||||||
|`5M`
|
|`5M`
|
||||||
|
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-feed-refresh]] [.section-name.section-level0]##Feed refresh engine settings##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-feed-refresh-interval]] [.property-path]##`commafeed.feed-refresh.interval`##
|
a| [[commafeed-server_commafeed-feed-refresh-interval]] [.property-path]##`commafeed.feed-refresh.interval`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
@@ -348,11 +357,16 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
||||||
|`500MS`
|
|`500MS`
|
||||||
|
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-database]] [.section-name.section-level0]##Database settings##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-database-query-timeout]] [.property-path]##`commafeed.database.query-timeout`##
|
a| [[commafeed-server_commafeed-database-query-timeout]] [.property-path]##`commafeed.database.query-timeout`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
--
|
--
|
||||||
Database query timeout. 0 to disable.
|
Timeout applied to all database queries. 0 to disable.
|
||||||
|
|
||||||
|
|
||||||
ifdef::add-copy-button-to-env-var[]
|
ifdef::add-copy-button-to-env-var[]
|
||||||
@@ -365,6 +379,10 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
||||||
|`0S`
|
|`0S`
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-database-cleanup]] [.section-name.section-level1]##Database cleanup settings##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-database-cleanup-entries-max-age]] [.property-path]##`commafeed.database.cleanup.entries-max-age`##
|
a| [[commafeed-server_commafeed-database-cleanup-entries-max-age]] [.property-path]##`commafeed.database.cleanup.entries-max-age`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
@@ -450,6 +468,12 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|@jakarta.validation.constraints.Positive int
|
|@jakarta.validation.constraints.Positive int
|
||||||
|`100`
|
|`100`
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-users]] [.section-name.section-level0]##Users settings##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-users-allow-registrations]] [.property-path]##`commafeed.users.allow-registrations`##
|
a| [[commafeed-server_commafeed-users-allow-registrations]] [.property-path]##`commafeed.users.allow-registrations`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
@@ -501,6 +525,11 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|boolean
|
|boolean
|
||||||
|`false`
|
|`false`
|
||||||
|
|
||||||
|
|
||||||
|
h|[[commafeed-server_section_commafeed-websocket]] [.section-name.section-level0]##Websocket settings##
|
||||||
|
h|Type
|
||||||
|
h|Default
|
||||||
|
|
||||||
a| [[commafeed-server_commafeed-websocket-enabled]] [.property-path]##`commafeed.websocket.enabled`##
|
a| [[commafeed-server_commafeed-websocket-enabled]] [.property-path]##`commafeed.websocket.enabled`##
|
||||||
|
|
||||||
[.description]
|
[.description]
|
||||||
@@ -552,6 +581,7 @@ endif::add-copy-button-to-env-var[]
|
|||||||
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
|link:https://docs.oracle.com/en/java/javase/17/docs/api/java/time/Duration.html[Duration] link:#duration-note-anchor-{summaryTableId}[icon:question-circle[title=More information about the Duration format]]
|
||||||
|`30S`
|
|`30S`
|
||||||
|
|
||||||
|
|
||||||
|===
|
|===
|
||||||
|
|
||||||
ifndef::no-duration-note[]
|
ifndef::no-duration-note[]
|
||||||
|
|||||||
@@ -6,6 +6,7 @@ import java.util.Optional;
|
|||||||
|
|
||||||
import com.commafeed.backend.feed.FeedRefreshIntervalCalculator;
|
import com.commafeed.backend.feed.FeedRefreshIntervalCalculator;
|
||||||
|
|
||||||
|
import io.quarkus.runtime.annotations.ConfigDocSection;
|
||||||
import io.quarkus.runtime.annotations.ConfigPhase;
|
import io.quarkus.runtime.annotations.ConfigPhase;
|
||||||
import io.quarkus.runtime.annotations.ConfigRoot;
|
import io.quarkus.runtime.annotations.ConfigRoot;
|
||||||
import io.quarkus.runtime.configuration.MemorySize;
|
import io.quarkus.runtime.configuration.MemorySize;
|
||||||
@@ -62,26 +63,31 @@ public interface CommaFeedConfiguration {
|
|||||||
/**
|
/**
|
||||||
* HTTP client configuration
|
* HTTP client configuration
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
HttpClient httpClient();
|
HttpClient httpClient();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Feed refresh engine settings.
|
* Feed refresh engine settings.
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
FeedRefresh feedRefresh();
|
FeedRefresh feedRefresh();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Database settings.
|
* Database settings.
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
Database database();
|
Database database();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Users settings.
|
* Users settings.
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
Users users();
|
Users users();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Websocket settings.
|
* Websocket settings.
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
Websocket websocket();
|
Websocket websocket();
|
||||||
|
|
||||||
interface HttpClient {
|
interface HttpClient {
|
||||||
@@ -180,7 +186,7 @@ public interface CommaFeedConfiguration {
|
|||||||
|
|
||||||
interface Database {
|
interface Database {
|
||||||
/**
|
/**
|
||||||
* Database query timeout.
|
* Timeout applied to all database queries.
|
||||||
*
|
*
|
||||||
* 0 to disable.
|
* 0 to disable.
|
||||||
*/
|
*/
|
||||||
@@ -190,6 +196,7 @@ public interface CommaFeedConfiguration {
|
|||||||
/**
|
/**
|
||||||
* Database cleanup settings.
|
* Database cleanup settings.
|
||||||
*/
|
*/
|
||||||
|
@ConfigDocSection
|
||||||
Cleanup cleanup();
|
Cleanup cleanup();
|
||||||
|
|
||||||
interface Cleanup {
|
interface Cleanup {
|
||||||
|
|||||||
Reference in New Issue
Block a user