Add some docs to example config

This commit is contained in:
Felisp 2024-07-28 14:56:55 +02:00
parent 693c47d465
commit 22f6c54bf4

View file

@ -4,7 +4,7 @@
:default-board "/mlp/" ;Board to be used when no board=x param given :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]" :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 :enable-board-listing true ;Whether to show list of enabled boards in /boards
:boards-defaults {:refresh-rate 300 :boards-defaults {:refresh-rate 300 ;how often new data should be downloaded in seconds
:starting-page 7 :starting-page 7
:default-chod 94 :default-chod 94
;; If you want to do some preprocessing beforehand, you can override ;; If you want to do some preprocessing beforehand, you can override
@ -14,7 +14,8 @@
;; Commented parts bellow are still unimplemented ;; Commented parts bellow are still unimplemented
;; Only download catalog when someone requests feed and cache is old ;; Only download catalog when someone requests feed and cache is old
;; Saves request to 4chan, usefull for borads that are checked rarely ;; Saves request to 4chan, usefull for borads that are checked rarely
;; :lazy-load false ;; 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) ;; Whether to allow regex search thru the threads (&qr= param)
;; :regex-enable true ;; :regex-enable true
;; Wheter to create cache by downloading whole catalog or every required ;; Wheter to create cache by downloading whole catalog or every required