From 97f411130fa205d501f201a4d10f49731b88ec76 Mon Sep 17 00:00:00 2001
From: syuilo <Syuilotan@yahoo.co.jp>
Date: Sun, 15 Jul 2018 02:09:55 +0900
Subject: [PATCH] Update example.yml

---
 .config/example.yml | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/.config/example.yml b/.config/example.yml
index 01bf435c5..8435ab8f2 100644
--- a/.config/example.yml
+++ b/.config/example.yml
@@ -7,6 +7,18 @@ maintainer:
   repository_url: https://github.com/syuilo/misskey # Repository URL
   feedback_url: https://github.com/syuilo/misskey/issues # Feedback URL (e.g. github issue)
 
+# URL and Port settings overview
+# e.g., If you want following structure:
+#
+#                  +--- https://example.com:123 ---------------+
+# +---------+      |+-------------+      +----------------+|
+# | Browser | ---> || Proxy (123) | ---> | Misskey (456) ||
+# +---------+      |+-------------+      +----------------+|
+#                  +---------------------------------------+
+#
+# You need to set 'https://example.com:123' to 'url' prop and
+# You need to set 456 to 'port' prop.
+
 url: http://localhost/
 
 # A port that your Misskey server should listen.