From a4302dc49c71555ad3475baa12c021fe0135028e Mon Sep 17 00:00:00 2001
From: Lukasz Janyst <lukasz@jany.st>
Date: Mon, 9 May 2022 17:39:24 +0200
Subject: [PATCH] doc: Add example configuration

---
 README.md           |  2 ++
 config.example.yaml | 12 ++++++++++++
 2 files changed, 14 insertions(+)
 create mode 100644 config.example.yaml

diff --git a/README.md b/README.md
index 8948556..7fcddfb 100644
--- a/README.md
+++ b/README.md
@@ -24,5 +24,7 @@ To than end, Perixide:
  * drops all the desktop desktop integration and trackers
  * provides a server program and a separate configuration program
 
+Example configuration file is provided as `config.example.yaml`.
+
 [1]: https://github.com/ProtonMail/proton-bridge
 [2]: https://github.com/emersion/hydroxide
diff --git a/config.example.yaml b/config.example.yaml
new file mode 100644
index 0000000..c71c8f4
--- /dev/null
+++ b/config.example.yaml
@@ -0,0 +1,12 @@
+{
+#  "UserPortImap":     "1143",
+#  "UserPortSmtp":     "1025",
+#  "AllowProxy":       "false",
+#  "CacheEnabled":     "true",
+#  "CacheCompression": "true",
+#  "CacheDir":         "./run/cache",
+#  "X509Key":          "./run/key.pema",
+#  "X509Cert":         "./run/cert.pema",
+#  "CookieJar":        "./run/cookies.json",
+#  "ServerAddress":    "[::0]"
+}
\ No newline at end of file