Merge pull request #46 from jhalter/implement_access_no_agreement

[rbdr/mobius] / cmd / mobius-hotline-server / mobius / config / config.yaml

diff --git a/cmd/mobius-hotline-server/mobius/config/config.yaml b/cmd/mobius-hotline-server/mobius/config/config.yaml
index a7a3ad97b9a7d06fd6fe84c1fde7d691555928ac..3ca812162578099a1e38251c2480c534428b3249 100644 (file)
--- a/cmd/mobius-hotline-server/mobius/config/config.yaml
+++ b/cmd/mobius-hotline-server/mobius/config/config.yaml
@@ -1,13 +1,49 @@
+# Name of the server as it appears on the Tracker
 Name: My Hotline server
+
+# Description of the server as it appears on the tracker
 Description: A default configured Hotline server running Mobius
-BannerID: 0
-FileRoot: Files/
+
+# Path to server banner image.  Only known to work in the 1.8 clients.
+#  * The banner must be under 256K (262,140 bytes specifically)
+#  * The standard size for a banner is 468 pixels wide and 60 pixels tall.
+#  * The banner must be saved in the same folder this file.
+#  * The banner must be a jpg
+BannerFile: "banner.jpg"
+
+# Path to the Files directory, by default in a subdirectory of the config root named Files
+FileRoot: Files
+
+# Enable tracker registration.  Must be "true" or "false".
 EnableTrackerRegistration: false
+
+# List of trackers to register with
 Trackers:
-- hltracker.com:5499
-- tracker.preterhuman.net:5499
-NewsDelimiter: ""
+  - hltracker.com:5499
+  - tracker.preterhuman.net:5499
+
+# Preserve resource forks and file type/creator codes for files uploaded by Macintosh clients.
+# This comes with trade-offs.  For more details, see:
+# https://github.com/jhalter/mobius/wiki/Resource-fork-support-in-Mobius
+# Must be "true" or "false".
+PreserveResourceForks: false
+
+# Optional custom date format for flat news postings
 NewsDateFormat: ""
+
+# Optional custom delimiter between flat news postings
+NewsDelimiter: ""
+
+# Maximum simultaneous downloads; currently unimplemented
 MaxDownloads: 0
+
+# Maximum simultaneous downloads per client; currently unimplemented
 MaxDownloadsPerClient: 0
+
+# Maximum simultaneous connections/IP; currently unimplemented
 MaxConnectionsPerIP: 0
+
+# List of Regular Expression filters for the Files list
+IgnoreFiles:
+  - '^\.*'     # Ignore all files starting with ".".  Leave this set if you are using the PreserveResourceForks option.
+  - '^@'       # Ignore all files starting with "@"
\ No newline at end of file