From bcc9f7f1960bc665240d2c43a8c2fa9cbc35a841 Mon Sep 17 00:00:00 2001 From: Paul Wilde Date: Thu, 12 Aug 2021 11:59:33 +0100 Subject: [PATCH] Added more documentation in services.sample.ini --- examples/dashboard.html | 11 ------ src/sample-config/config.sample.ini | 2 + src/sample-config/services.sample.ini | 55 ++++++++++++++++++++++++++- 3 files changed, 55 insertions(+), 13 deletions(-) delete mode 100644 examples/dashboard.html diff --git a/examples/dashboard.html b/examples/dashboard.html deleted file mode 100644 index 99eb0c8..0000000 --- a/examples/dashboard.html +++ /dev/null @@ -1,11 +0,0 @@ - - - - - DAVDiscover Dashboard Example - - -

This is to show the basic output of DAVDiscover, displaying the first few URLs

- - - diff --git a/src/sample-config/config.sample.ini b/src/sample-config/config.sample.ini index 4d117f0..6651564 100644 --- a/src/sample-config/config.sample.ini +++ b/src/sample-config/config.sample.ini @@ -4,6 +4,8 @@ ; The URL of this application BaseURL = "https://autoconfig.example.com" + + ; Set the base email domain for use with this service Domain = example.com diff --git a/src/sample-config/services.sample.ini b/src/sample-config/services.sample.ini index 0862f20..6d3f804 100644 --- a/src/sample-config/services.sample.ini +++ b/src/sample-config/services.sample.ini @@ -1,25 +1,76 @@ +; The Incoming mail Server Config [InMail] + +; Mail Type, i.e. IMAP, POP3 Type = "IMAP" + +; Your IMAP server Server = "imap.example.com" + +; Your IMAP port Port = 993 + +; The socket type : SSL, STARTTLS, or NONE SocketType = SSL + +; Authentication type, +;"password-cleartext" : Send password in the clear +; (dangerous, if SSL isn't used either). +; AUTH PLAIN, LOGIN or protocol-native login. +;"password-encrypted" : A secure encrypted password mechanism. +; Can be CRAM-MD5 or DIGEST-MD5. Not NTLM. +;"NTLM": Use NTLM (or NTLMv2 or successors), +; the Windows login mechanism. Authentication = password-cleartext +; The Outgoing mail server config [OutMail] + +; Mail type, likely to only be SMTP Type = "SMTP" + +; Your SMTP server Server = "smtp.example.com" + +; Your SMTP port Port = 465 + +; The socket type : SSL, STARTTLS or NONE SocketType = SSL + +; See InMail > Authentication Authentication = password-cleartext -; Currently not implemented + + +; Currently not implemented, see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat ;[Calendar] ;Server = "https://example.com/remote.php/dav/" ;Port = 443 ;Type = CalDAV +;Authentication = http-basic -; Currently not implemented +; Currently not implemented, see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat ;[AddressBook] ;Server = "https://example.com/remote.php/dav/" ;Port = 443 ;Type = CardDAV +;Authentication = http-basic + +; Currently not implemented, see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat +;[WebMail] +;Server = https://mail.example.com +;UsernameDivID = "username" +;UsernameDivName = "username" +;PasswordDivName = "password" +;SubmitButtonID = "submit" +;SubmitButtonName = "submit" + + +; In theory, additional custom services can be configured and will be displayed with +; their options on the /get/all URL of this service. The third-party clients would need to +; check this service as part of their development for this to work +; Will not be shown in autodiscover.xml/json or config-v1.1.xml/autoconfig.xml +; i.e Nextcloud - ideally a nextcloud client could check autoconfig for this URL for ease of set up +;[Nextcloud] +;Server = https://nextcloud.example.com