From 501a50cb5566df1cc38c5f0c62f8e8d453e7a9ee Mon Sep 17 00:00:00 2001
From: Felisp <rspointer@post.cz>
Date: Mon, 1 Jan 2024 01:10:19 +0100
Subject: [PATCH] Added example slightly documented config

---
 res/ExampleConfig.edn | 33 +++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 res/ExampleConfig.edn

diff --git a/res/ExampleConfig.edn b/res/ExampleConfig.edn
new file mode 100644
index 0000000..f379940
--- /dev/null
+++ b/res/ExampleConfig.edn
@@ -0,0 +1,33 @@
+;; :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]"
+ ;; /$board/catalog.json will be appended to this link
+ :target "https://api.4chan.org"
+ :boards-defaults {:refresh-rate 300
+                   :starting-page 7
+                   :default-chod 94
+                   ;; 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
+                   ;; :lazy-load false
+                   ;; 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
+                   ;; If you want to do some preprocessing beforehand, you can override
+                   ;; Target URL for the board, but the response must be samechan API would return
+                   ;; :target-override
+                   }
+ ;; 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
+ }