The Config File: settings.json
Spider's config file is /opt/spider/settings.json
, a JSON file. It looks
like below:
WARNING: Although it's very easy to update
settings.json
with a text editor, but we strongly recommend to update settings through the web console, to make sure it has correct syntax and valid values.
{
"admin_emails": ["admin-1@domain.com", "admin-2@domain.com"],
"archiving_username": "archive",
"archiving_domain": "",
"archiving_with_host_ip": true,
"license_key": "",
"log_level": "info",
"log_target": "file",
"log_rotate_interval": "1w",
"log_syslog_server": "/dev/log",
"retention_years": 0,
"smtpd_bind_address": ":25",
"smtpd_force_secure_conn": false,
"smtpd_allowed_only": false,
"smtpd_auth": false,
"smtpd_user": "",
"smtpd_password": "",
"web_bind_address": ":8080",
"web_home_path": "",
"web_default_language": "en_US"
}
admin_emails
: A list of admininistrator's email addresses. These addresses will receive daily archiving report and other notifications.archiving_username
: The username part of the archiving email address.archiving_domain
: The domain part of the archiving email address. This is optional since you can also use IP address in domain part (seearchiving_with_host_ip
).archiving_with_host_ip
: Use IP address(es) on host machine as the domain part of archiving email address. Must be a boolean type value (true
orfalse
), defaults totrue
.license_key
: The license key you get after purchased a license.log_level
: The application log level. Available levels are:info
,error
,debug
. Defaults toinfo
for production use.log_target
: The log target. Available targets are:file
: logs to file/opt/spider/log/spiderd.log
syslog
: logs to local or remote syslog server. Parameterlog_syslog_server
is required.
log_rotate_interval
: For how long to rotate the log file. This parameter is used whenlog_target
set tofile
.log_syslog_server
: Address of local or remote syslog server. For example:/dev/log
: local syslog server via socket path. This is default setting.udp:localhost:514
: local syslog server via network address.udp:192.168.1.1:514
: remote syslog server viaudp
protocol.tcp:192.168.1.1:514
: remote syslog server viatcp
protocol.
retention_years
: Keep archived email data for how many years. Older data will be removed permanently and automatically. Defaults to0
which means keep forever.smtpd_bind_address
: The bind address and port number for SMTP service. Defaults to listen on port25
on all IP addresses configured on server. Valid formats of listen address:ip:port
: Listen on given IP address and port. Multiple values must be separated by comma. For example:- Listen on port
2424
of192.168.0.100
, and port2525
of172.16.10.100
:192.168.0.100:2424,172.16.10.100:2525
. Note: In this example, both192.168.0.100
and172.16.10.100
are IP addresses configured on your server.
- Listen on port
:port
: Listen on all IP addresses (available on your server ) and given port. Multiple values must be separated by comma. For example:- Listen on port
25
::25
- Listen on ports
25
and26
::25,:26
- Listen on port
smtpd_force_secure_conn
: Force secure SMTP connections between mail server and Spider. A valid ssl cert is required to offer secure connection.smtpd_allowed_only
: Accept SMTP connections from allowed mail servers. You can configure the IP addresses of allowed mail servers on web console.smtpd_auth
: Enable SMTP authentication. If smtp auth is enabled, mail server must configure SMTP authentication to send / forward email to Spider.smtpd_user
: The smtp username used for smtp authentication.smtpd_password
: The smtp password used for smtp authentication.web_bind_address
: The bind address for http service used by web console. Valid formats of listen address please check the explaination of parametersmtpd_bind_address
.web_home_path
: If the web console is running behind a http proxy server, a different http endpoint may be used and specified here.web_default_language
: Default language of web console. User can change the language inPreferences
page after logged in.