wildduck/config/api.toml

60 lines
2.3 KiB
TOML
Raw Normal View History

2017-08-15 21:41:18 +08:00
enabled=true
port=8080
# by default bind to localhost only
host="127.0.0.1"
# Use `true` (HTTPS) for port 443 and `false` (HTTP) for 80
secure=false
# If set requires all API calls to have accessToken query argument with that value
# http://localhost:8080/users?accessToken=somesecretvalue
2020-05-08 15:55:07 +08:00
#accessToken="somesecretvalue"
2017-08-15 21:41:18 +08:00
2018-08-25 14:38:20 +08:00
[accessControl]
# If true then require a valid access token to perform API calls
2019-04-05 20:08:46 +08:00
# If a client provides a token then it is validated even if using a token is not required
2018-08-25 14:38:20 +08:00
enabled=false
2019-04-05 20:08:46 +08:00
2018-08-29 18:15:38 +08:00
# Secret for HMAC
# Changing this value invalidates all tokens
secret="a secret cat"
2018-08-25 14:38:20 +08:00
2019-04-05 20:08:46 +08:00
# Generated access token TTL in seconds. Token TTL gets extended by this value every time the token is used. Defaults to 14 days
#tokenTTL=1209600
# Generated access token max lifetime in seconds. Defaults to 180 days
#tokenLifetime=15552000
2018-08-28 19:37:06 +08:00
[roles]
# @include "roles.json"
2017-08-15 21:41:18 +08:00
[tls]
# If certificate path is not defined, use global or built-in self-signed certs
#key="/path/to/server/key.pem"
#cert="/path/to/server/cert.pem"
[mobileconfig]
# plist configuration for OSX/iOS profile files that are generated with Application Specific Passwords
# Use {email} in the description strings to replace it with account email address
# A reverse-DNS style identifier (com.example.myprofile, for example) that identifies the profile.
# This string is used to determine whether a new profile should replace an existing one or should be added. Username is prepended to this value.
identifier="com.email.wildduck"
# A human-readable name for the profile. This value is displayed on the Detail screen. It does not have to be unique.
2018-01-02 21:04:01 +08:00
displayName="WildDuck Mail"
2017-08-15 21:41:18 +08:00
# A human-readable string containing the name of the organization that provided the profile.
2018-01-02 21:04:01 +08:00
organization="WildDuck Mail Services"
2017-08-15 21:41:18 +08:00
# A description of the profile, shown on the Detail screen for the profile. This should be descriptive enough to help the user decide whether to install the profile.
displayDescription="Install this profile to setup {email}"
# A user-visible description of the email account, shown in the Mail and Settings applications.
2018-01-02 21:04:01 +08:00
accountDescription="WildDuck ({email})"
2017-08-15 21:41:18 +08:00
[mobileconfig.tls]
# If certificate path is not defined, use global or built-in self-signed certs
#key="/path/to/server/key.pem"
#cert="/path/to/server/cert.pem"