Configuration Reference: Difference between revisions

From Sympl Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
Line 2: Line 2:
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.
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 ===
===Domain config directory===
{| class="wikitable sortable"
{| class="wikitable sortable"
|+
|+
Line 10: Line 10:
|-
|-
|<code>.../config/dns/</code>
|<code>.../config/dns/</code>
|This directory contains the automatically generated DNS files in [[TinyDNS Format|TinyDNS format]].  
|This directory contains the automatically generated DNS files in [[TinyDNS Format|TinyDNS format]].
|n/a
|n/a
|-
|-
Line 17: Line 17:
|<code>10.11.12.13 2001:0db8:85a3:0000:0000:8a2e:0370:7334</code>
|<code>10.11.12.13 2001:0db8:85a3:0000:0000:8a2e:0370:7334</code>
|-
|-
|.../config/spf
|<code>.../config/spf</code>
|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.
|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>
|<code>v=spf1 ip4:192.0.2.0/24 ip4:198.51.100.123 a -all</code>
|-
|-
|.../config/dkim
|<code>.../config/dkim</code>
|Existence of this file will enable [[DKIM]] record generation and along with the <code>dkim.key</code> file will enable signing of outgoing mails.
|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.
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>
|<code>signedmail</code>
|-
|-
|.../config/dkim.key
|<code>.../config/dkim.key</code>
|This key is used to sign outgoing [[DKIM]] mails. Required along with the dkim
|This key is used to sign outgoing [[DKIM]] mails. Required to be able to sign mails, along with the <code>dkim</code> file.
|An RSA key beginning:
|An RSA key beginning:
<code>-----BEGIN RSA PRIVATE KEY-----</code>
<code>-----BEGIN RSA PRIVATE KEY-----</code>
|-
|<code>.../config/disable-php-security</code>
|Existence of this file will disable some of the PHP security functions in the automatically generated [[Apache]] configurations. See [[PHP Security]] for more information.
|n/a
|-
|<code>.../config/disable-filesystem-security</code>
|Existence of this file will disable the automatic filesystem security tasks on this domain. See Filesystem Security for more information.
|n/a
|-
|<code>.../config/stats</code>
|This file enables automatic generation of [[Web Statistics|web stats]] with [[Webalizer]]. A matching <code>stats.htpasswd</code> file will be needed to access them at <code>example.com/stats</code>.
|n/a
|-
|<code>.../config/stats.htpasswd</code>
|A htpasswd format file used to access the [[Web Statistics]]. Use the command <code>htpasswd -c /srv/example.com/config/stats.htpasswd username</code>  to create one.
|<code>stats:$apr1$IHaD0/..$N9ne/Bqnh8.MyOtvKU56j1</code>
|}
|}

Revision as of 13:27, 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 to be able to sign mails, along with the dkim file. An RSA key beginning:

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

.../config/disable-php-security Existence of this file will disable some of the PHP security functions in the automatically generated Apache configurations. See PHP Security for more information. n/a
.../config/disable-filesystem-security Existence of this file will disable the automatic filesystem security tasks on this domain. See Filesystem Security for more information. n/a
.../config/stats This file enables automatic generation of web stats with Webalizer. A matching stats.htpasswd file will be needed to access them at example.com/stats. n/a
.../config/stats.htpasswd A htpasswd format file used to access the Web Statistics. Use the command htpasswd -c /srv/example.com/config/stats.htpasswd username to create one. stats:$apr1$IHaD0/..$N9ne/Bqnh8.MyOtvKU56j1
Retrieved from ‘https://wiki.sympl.io/w/index.php?title=Configuration_Reference&oldid=106’