Configuration Reference: Difference between revisions

From Sympl Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Stub}}
{{Stub}}
The configuration for Sympl is comprised of a number of text files in each domains config directory (i.e. <code>/srv/'''''example.com'''''/config/</code>) and the <code>/etc/sympl</code> directory, which covers system level configurations.
=== Domain config directory ===
{| class="wikitable sortable"
|+
!File or Directory
!Used For
!Example content
|-
|<code>.../config/dns/</code>
|This directory contains the automatically generated DNS files in [[TinyDNS Format|TinyDNS format]].
|n/a
|-
|<code>.../config/ip</code>
|Contains a list of IP addresses which a website will be bound to, and mail will be sent from. If not set, defaults to the primary IPs (IPv4 and IPv6) of your server.
|<code>10.11.12.13 2001:0db8:85a3:0000:0000:8a2e:0370:7334</code>
|-
|.../config/spf
|Existence of this file will add [[SPF Records]] to the automatically generated DNS files. If the file has content, that will be used as the SPF record.
|<code>v=spf1 ip4:192.0.2.0/24 ip4:198.51.100.123 a -all</code>
|-
|.../config/dkim
|Existence of this file will enable [[DKIM]] record generation and along with the <code>dkim.key</code> file will enable signing of outgoing mails.
The DKIM 'selector' defaults to the short hostname of your server, otherwise any content in this file will be used as the selector in outgoing mails and automatically generated DNS.
|<code>signedmail</code>
|-
|.../config/dkim.key
|This key is used to sign outgoing [[DKIM]] mails. Required along with the dkim
|An RSA key beginning:
<code>-----BEGIN RSA PRIVATE KEY-----</code>
|}

Revision as of 13:15, 9 July 2019

This article is a Stub. You can help the Sympl Project by expanding it.

The configuration for Sympl is comprised of a number of text files in each domains config directory (i.e. /srv/example.com/config/) and the /etc/sympl directory, which covers system level configurations.

Domain config directory

File or Directory Used For Example content
.../config/dns/ This directory contains the automatically generated DNS files in TinyDNS format. n/a
.../config/ip Contains a list of IP addresses which a website will be bound to, and mail will be sent from. If not set, defaults to the primary IPs (IPv4 and IPv6) of your server. 10.11.12.13 2001:0db8:85a3:0000:0000:8a2e:0370:7334
.../config/spf Existence of this file will add SPF Records to the automatically generated DNS files. If the file has content, that will be used as the SPF record. v=spf1 ip4:192.0.2.0/24 ip4:198.51.100.123 a -all
.../config/dkim Existence of this file will enable DKIM record generation and along with the dkim.key file will enable signing of outgoing mails.

The DKIM 'selector' defaults to the short hostname of your server, otherwise any content in this file will be used as the selector in outgoing mails and automatically generated DNS.

signedmail
.../config/dkim.key This key is used to sign outgoing DKIM mails. Required along with the dkim An RSA key beginning:

-----BEGIN RSA PRIVATE KEY-----