Added more documentation in services.sample.ini

This commit is contained in:
Paul Wilde 2021-08-12 11:59:33 +01:00
parent 0464bcd6ba
commit bcc9f7f196
3 changed files with 55 additions and 13 deletions

View file

@ -1,11 +0,0 @@
<!DOCTYPE html>
<html lang="en" dir="ltr">
<head>
<meta charset="utf-8">
<title>DAVDiscover Dashboard Example</title>
</head>
<body>
<p>This is to show the basic output of DAVDiscover, displaying the first few URLs</p>
</body>
</html>

View file

@ -4,6 +4,8 @@
; The URL of this application ; The URL of this application
BaseURL = "https://autoconfig.example.com" BaseURL = "https://autoconfig.example.com"
; Set the base email domain for use with this service ; Set the base email domain for use with this service
Domain = example.com Domain = example.com

View file

@ -1,25 +1,76 @@
; The Incoming mail Server Config
[InMail] [InMail]
; Mail Type, i.e. IMAP, POP3
Type = "IMAP" Type = "IMAP"
; Your IMAP server
Server = "imap.example.com" Server = "imap.example.com"
; Your IMAP port
Port = 993 Port = 993
; The socket type : SSL, STARTTLS, or NONE
SocketType = SSL 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 Authentication = password-cleartext
; The Outgoing mail server config
[OutMail] [OutMail]
; Mail type, likely to only be SMTP
Type = "SMTP" Type = "SMTP"
; Your SMTP server
Server = "smtp.example.com" Server = "smtp.example.com"
; Your SMTP port
Port = 465 Port = 465
; The socket type : SSL, STARTTLS or NONE
SocketType = SSL SocketType = SSL
; See InMail > Authentication
Authentication = password-cleartext Authentication = password-cleartext
; Currently not implemented
; Currently not implemented, see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
;[Calendar] ;[Calendar]
;Server = "https://example.com/remote.php/dav/" ;Server = "https://example.com/remote.php/dav/"
;Port = 443 ;Port = 443
;Type = CalDAV ;Type = CalDAV
;Authentication = http-basic
; Currently not implemented ; Currently not implemented, see https://wiki.mozilla.org/Thunderbird:Autoconfiguration:ConfigFileFormat
;[AddressBook] ;[AddressBook]
;Server = "https://example.com/remote.php/dav/" ;Server = "https://example.com/remote.php/dav/"
;Port = 443 ;Port = 443
;Type = CardDAV ;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