From 3bdaf6e79e5ba0f893055c4744d0c107fbfbef77 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Timo=20K=C3=B6sters?= <timo@koesters.xyz>
Date: Fri, 1 Jan 2021 11:24:09 +0100
Subject: [PATCH] improvement: better default config

---
 .gitignore           |  1 +
 Rocket-example.toml  | 31 -------------------------------
 conduit-example.toml | 37 +++++++++++++++++++++++++++++++++++++
 3 files changed, 38 insertions(+), 31 deletions(-)
 delete mode 100644 Rocket-example.toml
 create mode 100644 conduit-example.toml

diff --git a/.gitignore b/.gitignore
index ee48b114..efbc1d9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -2,3 +2,4 @@
 **/*.rs.bk
 
 Rocket.toml
+conduit.toml
diff --git a/Rocket-example.toml b/Rocket-example.toml
deleted file mode 100644
index 8eb48e95..00000000
--- a/Rocket-example.toml
+++ /dev/null
@@ -1,31 +0,0 @@
-[global]
-# The name of this server
-# Note: If server name != hostname, you need a .well-known file for federation
-# to work
-server_name = "your.server.name"
-
-port = 14004
-
-# Max size for uploads
-#max_request_size = 20_000_000 # in bytes, ~20 MB
-
-# Disable registration. No new users will be able to register on this server
-#registration_disabled = true
-
-# Disable encryption, so no new encrypted rooms can be created
-# Note: existing rooms will continue to work
-#encryption_disabled = true
-
-#federation_enabled = true
-
-# Default path is in this user's data
-#database_path = "/home/timo/MyConduitServer"
-
-# You should probably leave this at 0.0.0.0
-address = "0.0.0.0"
-
-# TLS support
-# Note: Not necessary when using a reverse proxy:
-#[global.tls]
-#certs = "/etc/letsencrypt/live/your.server.name/fullchain.pem"
-#key = "/etc/letsencrypt/live/your.server.name/privkey.pem"
diff --git a/conduit-example.toml b/conduit-example.toml
new file mode 100644
index 00000000..70d3ce47
--- /dev/null
+++ b/conduit-example.toml
@@ -0,0 +1,37 @@
+[global]
+# The server_name is the name of this server. It is used as a suffix for user
+# and room ids. Examples: matrix.org, conduit.rs
+# The Conduit server needs to be reachable at https://your.server.name/ on port
+# 443 (client-server) and 8448 (federation) OR you can create /.well-known
+# files to redirect requests. See
+# https://matrix.org/docs/spec/client_server/latest#get-well-known-matrix-client
+# and https://matrix.org/docs/spec/server_server/r0.1.4#get-well-known-matrix-server
+# for more information
+
+# YOU NEED TO EDIT THIS
+#server_name = "your.server.name"
+
+# This is the only directly where Conduit will save its data
+database_path = "/var/lib/conduit/conduit.db"
+
+# The port Conduit will be running on. You need to set up a reverse proxy in
+# your web server (e.g. apache or nginx), so all requests to /_matrix on port
+# 443 and 8448 will be forwarded to the Conduit instance running on this port
+port = 6167
+
+# Max size for uploads
+max_request_size = 20_000_000 # in bytes
+
+# Disable registration. No new users will be able to register on this server
+#registration_disabled = false
+
+# Disable encryption, so no new encrypted rooms can be created
+# Note: existing rooms will continue to work
+#encryption_disabled = false
+#federation_disabled = false
+
+#cache_capacity = 1073741824 # in bytes, 1024 * 1024 * 1024
+#max_concurrent_requests = 4 # How many requests Conduit sends to other servers at the same time
+#workers = 4 # default: cpu core count * 2
+
+address = "127.0.0.1" # This makes sure Conduit can only be reached using the reverse proxy