summaryrefslogtreecommitdiffstats
path: root/contrib/caldav
diff options
context:
space:
mode:
authorLukas Fleischer <lfleischer@calcurse.org>2021-04-03 18:07:53 -0400
committerLukas Fleischer <lfleischer@calcurse.org>2021-04-03 18:12:31 -0400
commitf41955e491476dfb844f28f46523d0430d27c88a (patch)
treeeae7762d5a8f1ba6ae972b82b1ecd06c33ba9de3 /contrib/caldav
parentbe5cf3578d06388ba8368f0b0793e525193ec28e (diff)
downloadcalcurse-f41955e491476dfb844f28f46523d0430d27c88a.tar.gz
calcurse-f41955e491476dfb844f28f46523d0430d27c88a.zip
calcurse-caldav: document Hostname and Path better
Add some clarification on the expected format for the Hostname and Path options in the sample configuration file. Addresses GitHub issues #95, #138, and #354. Signed-off-by: Lukas Fleischer <lfleischer@calcurse.org>
Diffstat (limited to 'contrib/caldav')
-rw-r--r--contrib/caldav/config.sample6
1 files changed, 4 insertions, 2 deletions
diff --git a/contrib/caldav/config.sample b/contrib/caldav/config.sample
index c89cfb7..e2c6c2d 100644
--- a/contrib/caldav/config.sample
+++ b/contrib/caldav/config.sample
@@ -11,10 +11,12 @@
# Path to the calcurse binary that is used for importing/exporting items.
Binary = calcurse
-# Host name of the server that hosts CalDAV.
+# Host name of the server that hosts CalDAV. Do NOT prepend a protocol prefix,
+# such as http:// or https://. Append :<port> for a port other than 80.
Hostname = some.hostname.com
-# Path to the CalDAV calendar on the host specified above.
+# Path to the CalDAV calendar on the host specified above. This is the base
+# path following your host name in the URL.
Path = /path/to/calendar/on/the/server/
# Type of authentication to use. Must be "basic" or "oauth2"