From 2938efd5e200471c3b3123f7e4cd43caa7ed1fca Mon Sep 17 00:00:00 2001
From: iyear <ljyngup@gmail.com>
Date: Tue, 12 Jul 2022 14:06:36 +0800
Subject: [PATCH] feat(config): add config.example.yaml

Signed-off-by: iyear <ljyngup@gmail.com>
---
 config/config.example.yaml | 34 ++++++++++++++++++++++++++++++++++
 1 file changed, 34 insertions(+)
 create mode 100644 config/config.example.yaml

diff --git a/config/config.example.yaml b/config/config.example.yaml
new file mode 100644
index 0000000..349028d
--- /dev/null
+++ b/config/config.example.yaml
@@ -0,0 +1,34 @@
+bot:
+  token: YOUR_BOT_TOKEN
+  admin:
+    - YOUR_ADMIN_ID
+    - YOUR_ADMIN_ID
+    - YOUR_ADMIN_ID
+  socks5:
+    enable: false
+    host: localhost
+    port: 1080
+    user:
+    password:
+ctrl:
+  # support markdown style: https://core.telegram.org/bots/api#markdown-style
+  notice: |
+    YOUR_NOTICE_MESSAGE
+    YOUR_NOTICE_MESSAGE
+    YOUR_NOTICE_MESSAGE
+  i18n: ./config/i18n
+  default_language: zh-cn
+  search:
+    page_size: 10
+storage:
+  cache:
+    driver: gocache # gocache
+  kv:
+    driver: bolt # bolt
+    options:
+      path: ./data/data.kv
+  search:
+    driver: bleve # bleve
+    options:
+      path: ./data/msg.index
+      dict: ./config/dict.txt