From 09983a657d03429cecbe40b09822cfed9d26f605 Mon Sep 17 00:00:00 2001
From: ThatOneCalculator <kainoa@t1c.dev>
Date: Fri, 2 Jun 2023 16:10:57 -0700
Subject: [PATCH] chore: update example config

---
 .config/example.yml | 65 +++++++++++++++++++++++----------------------
 1 file changed, 33 insertions(+), 32 deletions(-)

diff --git a/.config/example.yml b/.config/example.yml
index ba53bde43a..16fa67142e 100644
--- a/.config/example.yml
+++ b/.config/example.yml
@@ -2,32 +2,31 @@
 # Calckey configuration
 #━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
+# After starting your server, please don't change the URL! Doing so will break federation.
+
 #   ┌─────┐
 #───┘ URL └─────────────────────────────────────────────────────
 
 # Final accessible URL seen by a user.
-url: https://example.tld/
-
-# ONCE YOU HAVE STARTED THE INSTANCE, DO NOT CHANGE THE
-# URL SETTINGS AFTER THAT!
+url: https://example.com/
 
 #   ┌───────────────────────┐
 #───┘ Port and TLS settings └───────────────────────────────────
 
 #
-# Misskey requires a reverse proxy to support HTTPS connections.
+# Calckey requires a reverse proxy to support HTTPS connections.
 #
-#                 +----- https://example.tld/ ------------+
+#                 +----- https://example.com/ ------------+
 #   +------+      |+-------------+      +----------------+|
-#   | User | ---> || Proxy (443) | ---> | Misskey (3000) ||
+#   | User | ---> || Proxy (443) | ---> | Calckey (3000) ||
 #   +------+      |+-------------+      +----------------+|
 #                 +---------------------------------------+
 #
-#   You need to set up a reverse proxy. (e.g. nginx)
+#   You need to set up a reverse proxy. (e.g. nginx, caddy)
 #   An encrypted connection with HTTPS is highly recommended
 #   because tokens may be transferred in GET requests.
 
-# The port that your Misskey server should listen on.
+# The port that your Calckey server should listen on.
 port: 3000
 
 #   ┌──────────────────────────┐
@@ -62,6 +61,17 @@ redis:
   #prefix: example-prefix
   #db: 1
 
+# Please configure either MeiliSearch *or* Sonic.
+# If both MeiliSearch and Sonic configurations are present, MeiliSearch will take precedence.
+
+#   ┌───────────────────────────┐
+#───┘ MeiliSearch configuration └─────────────────────────────────────
+#meilisearch:
+#  host: meilisearch
+#  port: 7700
+#  ssl: false
+#  apiKey:
+
 #   ┌─────────────────────┐
 #───┘ Sonic configuration └─────────────────────────────────────
 
@@ -72,23 +82,6 @@ redis:
 #  collection: notes
 #  bucket: default
 
-#   ┌─────────────────────────────┐
-#───┘ Elasticsearch configuration └─────────────────────────────
-
-#elasticsearch:
-#  host: localhost
-#  port: 9200
-#  ssl: false
-#  user:
-#  pass:
-
-#   ┌───────────────────────────┐
-#───┘ Meilisearch configuration └─────────────────────────────────────
-#meilisearch:
-#  host: meilisearch
-#  port: 7700
-#  ssl: false
-#  apiKey:
 
 #   ┌───────────────┐
 #───┘ ID generation └───────────────────────────────────────────
@@ -108,10 +101,10 @@ redis:
 #   ┌─────────────────────┐
 #───┘ Other configuration └─────────────────────────────────────
 
-# Max note length, should be < 8000.
+# Maximum length of a post (default 3000, max 8192)
 #maxNoteLength: 3000
 
-# Maximum lenght of an image caption or file comment (default 1500, max 8192)
+# Maximum length of an image caption (default 1500, max 8192)
 #maxCaptionLength: 1500
 
 # Reserved usernames that only the administrator can register with
@@ -185,13 +178,21 @@ reservedUsernames: [
 # Upload or download file size limits (bytes)
 #maxFileSize: 262144000
 
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+# Congrats, you've reached the end of the config file needed for most deployments!
+# Enjoy your Calckey server!
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+
+
+
+
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 # Managed hosting settings
-# !!!!!!!!!!
-# >>>>>> NORMAL SELF-HOSTERS, STAY AWAY! <<<<<<
-# >>>>>> YOU DON'T NEED THIS! <<<<<<
-# !!!!!!!!!!
+# >>> NORMAL SELF-HOSTERS, STAY AWAY! <<<
+# >>> YOU DON'T NEED THIS! <<<
 # Each category is optional, but if each item in each category is mandatory!
 # If you mess this up, that's on you, you've been warned...
+#━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 #maxUserSignups: 100
 #isManagedHosting: true