Treebrary.org/rss-thread-watcher
1
0
Fork 0
Code Issues 19 Pull requests Projects 2 Releases 2 Packages Wiki Activity

Added documented default config

Browse source
This commit is contained in:
Felisp 2024-08-13 03:12:43 +02:00
parent 2ca45803e5
commit 7f5d560bae
2 changed files with 47 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

47
res/ExampleConfig-documented.edn Normal file
View file

@ -0,0 +1,47 @@
{:port 6969 ;Port to listen on
:default-board "/mlp/" ;Board to be used when no board=x param given
;; Message displayed when requested board is not enabled
:board-disabled-message "This board is not enabled for feed generation.\n\nYou can contact me here: [contact]"
;; :enable-board-listing true ;Whether to show list of enabled boards in /boards UNIMPLEMENTED
;; This map defines default values for all enabled boards, if you wish for some board
;; to use different values, specify them bellow in :borads-enabled
:boards-defaults {
;; After how many seconds get fresh catalog.json from :target
:refresh-rate 300
;; Page from which to start indexing threads, threads on pages with lower
;; numbers will not be detectable by the feed watcher
:starting-page 7
;; Default ChOD to use if none is specified by the user
:default-chod 94
;; If you want to do some preprocessing beforehand, you can override
;; Target URL for the board, but the response must be same the 4chan API would return
;; /$board/catalog.json will be appended to this link
:target "https://api.4chan.org"
;; Commented parts bellow are still unimplemented
;; ------
;; Only download catalog when someone requests feed and cache is old
;; Saves requests to 4chan, usefull for boards that are checked rarely
;; Generally the better option, first request in taken in :refresh-rate may take longer
;; Currently the only option
:lazy-load true
;; Whether to allow regex search thru the threads (&qr= param) UNIMPLEMENTED
;; :regex-enable true
;; Wheter to create cache by downloading whole catalog or every required
;; page one by one UNIMPLEMENTED
;; :request-type [:catalog] :pages
}
;; List of all boards that are enabled for feed generation
;; Yes they must be all listed manualy for now
;; Each such board must have map of altered config options if aplicable
;; otherwise empty one must be provided
:boards-enabled {"/mlp/" {} ;; Empty override map means that defaults are used
;; This means that board "/g/" will have :starting-page set to 7 but all
;; the other config options are copied from :board-defaults
"/g/" {:starting-page 7}
"/po/" {:starting-page 8
:refresh-rate 86400} ;1 day
"/p/" {:starting-page 8
:refresh-rate 1800} ;30 min
}
}

34
res/ExampleConfig.edn
View file

@ -1,34 +0,0 @@
;; :board-defaults is default config for every board and can be
;; overriden for every board
{:port 6969
:default-board "/mlp/" ;Board to be used when no board=x param given
:board-disabled-message "This board is not enabled for feed generation.\n\nYou can contact me here: [contact]"
:enable-board-listing true ;Whether to show list of enabled boards in /boards
:boards-defaults {:refresh-rate 300 ;how often new data should be downloaded in seconds
:starting-page 7
:default-chod 94
;; If you want to do some preprocessing beforehand, you can override
;; Target URL for the board, but the response must be same 4chan API would return
;; /$board/catalog.json will be appended to this link
:target "https://api.4chan.org"
;; Commented parts bellow are still unimplemented
;; Only download catalog when someone requests feed and cache is old
;; Saves request to 4chan, usefull for borads that are checked rarely
;; Generally the better option, first request in :refresh-rate may take longer
:lazy-load true
;; Whether to allow regex search thru the threads (&qr= param)
;; :regex-enable true
;; Wheter to create cache by downloading whole catalog or every required
;; one by one
;; :request-type [:catalog] :pages
}
;; List of all boards that are enabled for feed generation
;; Yes they must be all listed manualy for now
:boards-enabled {"/mlp/" {} ;; Empty override map means that defaults are used
"/g/" {}
"/po/" {}
"/p/" {:starting-page 8
:refresh-rate 1800} ;30 min
}
;; When user requests board that is not enabled, this message is returned
}