package: sympa

title: sympa_database(5)

summary: Structure of Sympa core database

text:
# sympa_database(5)

## NAME
sympa_database - Structure of Sympa core database

## DECRIPTION
Core database of Sympa is based on SQL. In following list of tables and indexes, data types are based on MySQL/MariaDB. Corresponding types are used by other platforms (PostgreSQL, SQLite, ...).

### Tables
subscriber_table

This table stores subscription, subscription options, etc...

Fields:

user_subscriber varchar(100)

(Primary key) email of subscriber

list_subscriber varchar(50)

(Primary key) list name of a subscription

robot_subscriber varchar(80)

(Primary key) robot (domain) of the list

reception_subscriber varchar(20)

reception format option of subscriber (digest, summary, etc.)

suspend_subscriber int(1)

boolean set to 1 if subscription is suspended

suspend_start_date_subscriber int(11)

the Unix time when message reception was suspended

suspend_end_date_subscriber int(11)

the Unix time when message reception should be restored

bounce_subscriber varchar(35)

unix time of first bounce / unix time of last bounce / nb of bounces / error code

bounce_score_subscriber smallint(6)

bounce score for this subscriber

bounce_address_subscriber varchar(100)

VERP bounce address

date_epoch_subscriber int(11) not null

date of subscription

update_epoch_subscriber int(11)

last time subscription was confirmed by subscriber

inclusion_subscriber int(11)

last time subscribers' list was synchronized with data source

inclusion_ext_subscriber int(11)

last time subscribers' list was synchronized with external data source

inclusion_label_subscriber varchar(50)

name of data source

comment_subscriber varchar(150)

display name of subscriber

number_messages_subscriber int(5) not null

the number of messages the subscriber sent

visibility_subscriber varchar(20)

visibility of subscriber in list review page

topics_subscriber varchar(200)

topic subscription specification

subscribed_subscriber int(1)

boolean set to 1 if subscriber comes from ADD or SUB

custom_attribute_subscriber text

custom attribute(s) of subscriber

Indexes:

subscriber_user_index

user_subscriber

user_table

The user_table is mainly used to manage login from web interface. A subscriber may not appear in the user_table if they never log through the web interface.

Fields:

email_user varchar(100)

(Primary key) email of user

password_user varchar(64)

password are stored as finger print

gecos_user varchar(150)

display name of user

last_login_date_user int(11)

Unix time of last login, printed in login result for security purpose

last_login_host_user varchar(60)

host of last login, printed in login result for security purpose

wrong_login_count_user int(11)

login attempt count, used to prevent brute force attack

last_active_date_user int(11)

the last Unix time when this user was confirmed their activity by purge_user_table task

cookie_delay_user int(11)

user cookie max age in minutes (0 is session)

lang_user varchar(10)

user language preference

attributes_user text

user custom attributes

data_user text

user misc WUI preferences

inclusion_table

Inclusion table is used in order to manage lists included from / including subscribers of other lists.

Fields:

target_inclusion varchar(131)

(Primary key) list ID of including list

role_inclusion enum('member','owner','editor')

(Primary key) role of included user

source_inclusion varchar(131)

(Primary key) list ID of included list

update_epoch_inclusion int(11)

the date this entry was created or updated

exclusion_table

Exclusion table is used in order to manage unsubscription for subscriber included from an external data source.

Fields:

list_exclusion varchar(57)

(Primary key) name of the list

robot_exclusion varchar(80)

(Primary key) robot (domain) of the list

user_exclusion varchar(100)

(Primary key) excluded subscriber email address

family_exclusion varchar(50)

(Primary key) family of the list

date_exclusion int(11)

the date this entry was created or updated

session_table

Management of HTTP session.

Fields:

id_session varchar(30)

(Primary key) the identifier of the database record

prev_id_session varchar(30)

previous identifier of the database record

start_date_session int(11) not null

the date when the session was created

date_session int(11) not null

Unix time of the last use of this session. It is used in order to expire old sessions

refresh_date_session int(11)

Unix time of the last refresh of this session. It is used in order to refresh available sessions

remote_addr_session varchar(60)

the IP address of the computer from which the session was created

robot_session varchar(80)

the virtual host in which the session was created

email_session varchar(100)

the email associated to this session

hit_session int(11)

the number of hit performed during this session. Used to detect crawlers

data_session text

parameters attached to this session that don't have a dedicated column in the database

Indexes:

session_prev_id_index

prev_id_session

one_time_ticket_table

One time ticket are random value used for authentication challenge. A ticket is associated with a context which look like a session.

Fields:

ticket_one_time_ticket varchar(30)

(Primary key) random value of the one time ticket

email_one_time_ticket varchar(100)

email associated with one time ticket

robot_one_time_ticket varchar(80)

robot (domain) of the one time ticket

date_one_time_ticket int(11)

the date this entry was created or updated

data_one_time_ticket varchar(200)

data associated with one time ticket

remote_addr_one_time_ticket varchar(60)

Remote address associated with one time ticket

status_one_time_ticket varchar(60)

status of one time ticket

notification_table

Used for message tracking feature. If the list is configured for tracking, outgoing messages include a delivery status notification request and optionally a message disposition notification request. When DSN and MDN are received by Sympa, they are stored in this table in relation with the related list and message ID.

Fields:

pk_notification bigint(20) auto_increment

(Primary key) autoincrement key

message_id_notification varchar(100)

initial message-id. This field is used to search DSN and MDN related to a particular message

recipient_notification varchar(100)

email address of recipient for which a DSN or MDN was received

reception_option_notification varchar(20)

the subscription option of the subscriber when the related message was sent to the list. Useful because some recipient may have option such as //digest// or //nomail//

status_notification varchar(100)

value of notification

arrival_date_notification varchar(80)

reception date of latest DSN or MDN

arrival_epoch_notification int(11)

reception date of latest DSN or MDN

type_notification enum('DSN', 'MDN')

type of the notification (DSN or MDN)

list_notification varchar(50)

the listname the message was issued for

robot_notification varchar(80)

the robot the message is related to

date_notification int(11) not null

the date this entry was created or updated

logs_table

Each important event is stored in this table. List owners and listmaster can search entries in this table using web interface.

Fields:

user_email_logs varchar(100)

e-mail address of the message sender or email of identified web interface user (or soap user)

date_logs int(11) not null

date when the action was executed

usec_logs int(6)

subsecond in microsecond when the action was executed

robot_logs varchar(80)

name of the robot in which context the action was executed

list_logs varchar(50)

name of the mailing-list in which context the action was executed

action_logs varchar(50) not null

name of the Sympa subroutine which initiated the log

parameters_logs varchar(100)

comma-separated list of parameters. The amount and type of parameters can differ from an action to another

target_email_logs varchar(100)

e-mail address (if any) targeted by the message

msg_id_logs varchar(255)

identifier of the message which triggered the action

status_logs varchar(10) not null

exit status of the action. If it was an error, it is likely that the error_type_logs field will contain a description of this error

error_type_logs varchar(150)

name of the error string - if any - issued by the subroutine

client_logs varchar(100)

IP address of the client machine from which the message was sent

daemon_logs varchar(10) not null

name of the Sympa daemon which ran the action

stat_table

Statistics item are stored in this table, Sum average and so on are stored in stat_counter_table.

Fields:

date_stat int(11) not null

unix epoch this entry was created or updated

email_stat varchar(100)

user email who ran the task

operation_stat varchar(50) not null

operation thas was run

list_stat varchar(50)

list name against which the task was run

daemon_stat varchar(20)

daemon which ran the task

user_ip_stat varchar(100)

remote ip of user

robot_stat varchar(80) not null

domain (robot) of the list

parameter_stat varchar(50)

unused except to store message size on send_mail

read_stat tinyint(1) not null

data was aggregated in stat_counter_table

Indexes:

stats_user_index

email_stat

stat_counter_table

Used in conjunction with stat_table for users statistics.

Fields:

end_date_counter int(11)

unix time for the end of the stats

beginning_date_counter int(11) not null

unix time for the beginning of the stats

data_counter varchar(50) not null

type of operation

robot_counter varchar(80) not null

domain (robot)

list_counter varchar(50)

list

count_counter int

number of occurences

admin_table

This table is an internal cash where list admin roles are stored. It is just a cash and it does not need to be saved. You may remove its content if needed. It will just make next Sympa startup slower.

Fields:

user_admin varchar(100)

(Primary key) email of admin

list_admin varchar(50)

(Primary key) list name

robot_admin varchar(80)

(Primary key) list domain

role_admin enum('listmaster','owner','editor')

(Primary key) a role of this user for this list (editor, owner or listmaster which a kind of list owner too)

profile_admin enum('privileged','normal')

privilege level for this owner, value //normal// or //privileged//. The related privilege are listed in edit_list.conf.

date_epoch_admin int(11) not null

date this user become a list admin

update_epoch_admin int(11)

last update time

inclusion_admin int(11)

the last time when list user is synchronized with data source

inclusion_ext_admin int(11)

the last time when list user is synchronized with external data source

inclusion_label_admin varchar(50)

name of data source

reception_admin varchar(20)

email reception option for list management messages

visibility_admin varchar(20)

admin user email can be hidden in the list web page description

comment_admin varchar(150)

display name of admin

subscribed_admin int(1)

set to 1 if user is list admin by definition in list config file

info_admin varchar(150)

private information usually dedicated to listmasters who needs some additional information about list owners

Indexes:

admin_user_index

user_admin

netidmap_table

This table stores information for users login with SSO

Fields:

netid_netidmap varchar(100)

(Primary key) user netid

serviceid_netidmap varchar(100)

(Primary key) SSO service

robot_netidmap varchar(80)

(Primary key) robot (domain)

email_netidmap varchar(100)

user email

conf_table

The conf table stores the parameters values for robots

Fields:

robot_conf varchar(80)

(Primary key) robot (domain) of the conf

label_conf varchar(80)

(Primary key) parameter name of the conf

value_conf varchar(300)

the value of parameter //label_conf// of robot //robot_conf//.

list_table

The list_table holds cached list config and some items to help searching lists.

Fields:

name_list varchar(50)

(Primary key) name of the list

robot_list varchar(80)

(Primary key) name of the robot (domain) the list belongs to

family_list varchar(50)

name of the family the list belongs to

status_list enum('open','closed','pending','error_config','family_closed')

status of the list

creation_email_list varchar(100)

email of user who created the list

creation_epoch_list int(11)

UNIX time when the list was created

update_email_list varchar(100)

email of user who updated the list

update_epoch_list int(11)

UNIX time when the list was updated

searchkey_list varchar(255)

case-folded list subject to help searching

web_archive_list tinyint(1)

if the list has archives

topics_list varchar(255)

topics of the list, separated and enclosed by commas

total_list int(7)

estimated number of subscribers

## SEE ALSO
Sympa Administration Manual. <https://www.sympa.community/manual/>.


title: sympa_scenario(5)

summary: Authorization scenario

text:
# sympa_scenario(5)

## NAME
sympa_scenario - Authorization scenario

## SYNOPSIS
An example del.auth file:

```
  title    deletion performed only by list owners, need authentication
  title.es eliminacin reservada slo para el propietario, necesita autentificacin

  is_owner([listname],[sender])  smtp       -> request_auth
  is_listmaster([sender])        smtp       -> request_auth
  true()                         md5,smime  -> do_it
```

## DESCRIPTION

### File format
Basically, a scenario file is composed of titles on the first lines and a set of rules on the following lines.

Rules consist of one or more line in the form:

```
  condition authentication_methods -> action
```

Some terms of conditions may take one or more arguments. The arguments are variables or literals (see "Terms of conditions", "Variables").

Authentication methods is a comma-separated list of one or more methods (see "Authentication methods").

Some actions may have optional modifiers (see "Actions").

Terms of conditions

"true" "(" ")"

Always returns true.

"equal" "(" var1"," var2 ")"

Tests if two arguments are equal.

"is_subscriber" "(" listname"," var ")"

"is_owner" "(" listname"," var ")"

"is_editor" "(" listname"," var ")"

Tests if var is the subscriber, owner or editor of the list listname. listname is the variable "[listname]" or list address, "name" or "name"@"domain".

"is_listmaster" "(" var ")"

Tests if var is the listmaster.

"less_than" "(" var1"," var2 ")"

Tests if var1 is less than var2.

"match" "(" var"," "/"perl_regexp"/" ")"

Tests if var matches with perl_regexp. perl_regexp is a perl regular expression. Don't forget to escape special characters ("^", "$", "{", "(", ...): Check perlre(1) for regular expression syntax. It can contain the string "[domain]" (interpreted at run time as the list or robot domain).

Note: Sympa prior to 6.2.32 recognized "[host]" instead of "[domain]".

"newer" "(" date"," date ")"

Returns true if first date is posterior to the second

"older" "(" date"," date ")"

Returns true if first date is anterior to the second date date is Unix time or the string "n"y"n"m"n"d"n"h"n"min"n"sec"", where each n is a number.

"search" "(" named_filter_file"," var")"

Tests if var is found by named filter. named_filter_file is a file name ending with ".ldap", ".sql" or ".txt".

"verify_netmask" "(" network_block ")"

Tests if "REMOTE_ADDR" CGI environment variable matches with network_block. This allows the user to configure their local network to only be accessible to those that are members of it.

"CustomCondition::"package_name "(" arguments, ... ")"

Evaluates custom condition. package_name is the name of a Perl package in $SYSCONFDIR/custom_conditions/ (lowercase).

Variables

"[custom_vars->"custom_var_name"]"

Allows you to introduce custom parameters in your scenario. custom_var_name is the name of the custom parameter you want to use.

"[date]"

Date of reception of the message.

"[domain]"

Mail domain of current list. Note: This variable was introduced by Sympa 6.2.32. Previous versions used a variable "[conf->host]" (obsoleted) instead.

"[env->"env_var"]"

env_var is the name of CGI environment variable (note that it is case-sensitive).

"[is_bcc]"

Set to 1 if the list is neither in To: nor Cc: field.

"[listname]"

Name of current list.

"[msg_encrypted]"

Set to ""smime"" if the message was S/MIME encrypted.

"[msg_header->"field_name"]"

"[msg_header->"field_name"]["index"]"

Value of message header field, available only when evaluating the authorization scenario for sending messages. It can be used, for example, to require editor validation for multipart messages. Optional index may be integer (may be less than 0) to choose particular entry from multiple fields.

"[msg_part->type]"

"[msg_part->body]"

The MIME content types and bodies; the body is available for MIME parts in text/xxx format only.

"[previous_email]"

Old email when changing subscription email in preference page.

"[sender]"

The email address of the current user (used on web or mail interface). Default value is "nobody".

"[topic]"

Topic of the message. This variable has a value if any of the following "[topic_*]" variables has a value.

"[topic_auto]"

Topic of the message if it has been automatically tagged.

"[topic_editor]"

Topic of the message if it has been tagged by editor.

"[topic_needed]"

The message has not got any topic and message topic are required for the list.

"[topic_sender]"

Topic of the message if it has been tagged by sender.

"[user_attributes->"user_attributes_key_word"]"

user_attributes_key_word is one of the names of user attributes provided by the SSO system via environment variables. Available only if user authenticated with a "generic_sso".

Authentication methods

The e-mail of authenticated user is given by "[sender]" variable. If it is not given, '"nobody"' will be set.

"smtp"

Default method. No actual authentication, and if any, sender of the message is used.

"md5"

Authenticated by web authentication (password), or by authentication key in e-mail message.

"smime"

Authenticated by S/MIME signature, or TLS client certificate.

Note: The "dkim" authentication method for scenarios was obsoleted on Sympa 6.2.71b.1. Now it is a synonym of "smtp" method.

Actions

An action consists of an action name and optional modifiers.

Action names:

"do_it"

Allows operation.

"editor"

The message will be forwarded to list editor.

"editorkey"

The message will be held for moderation by list editor.

"listmaster"

Same as "do_it" but makes newly created list be pending.

"owner"

The operation is held and waits for approval by list owner.

"reject"

Denies operation.

"request_auth"

The operation is held and waits for confirmation by the user.

Modifiers:

"([email])"

Only for "request_auth" action. Sends authentication request to the target user of operation (given as the value of ""[email]"" variable) instead of original sender. Note that "[email]" is a literal and no other variable names can't be used.

"," "notify"

Only for "do_it" and "listmaster" actions. Sends a notification to list owner.

"," "quiet"

Sends no notification to the message sender.

"(reason='"reason_key"')"

Only for "reject" action. Matches a key in mail_tt2/authorization_reject.tt2 template corresponding to an information message about the reason of the reject of the user. reason_key have to be a static string enclosed by '...'.

"(tt2='"tpl_name"')"

Only for "reject" action. Corresponding template (tpl_name".tt2") is sent to the sender. tpl_name have to be a static string enclosed by '...'.

### Formal syntax
\# Below is the formal syntax definition by modified BNF.

rule : condition spaces auth_list "->" action

\# Condition

condition : "!" condition

| "true" "(" ")"

| "equal" "(" var "," var ")"

| "is_editor" "(" listname "," var ")"

| "is_listmaster" "(" var ")"

| "is_owner" "(" listname "," var ")"

| "is_subscriber" "(" listname "," var ")"

| "less_than" "(" var "," var ")"

| "match" "(" var "," "/" perl_regexp "/" ")"

| "newer" "(" date "," date ")"

| "older" "(" date "," date ")"

| "search" "(" named_filter_file ")"

| "verify_netmask" "(" network_block ")"

| "CustomCondition::" package_name "(" var* ")"

var : "[email]"

| "[conf->" conf_key_word "]"

| "[current_date]"

| "[custom_vars->" custom_var_name "]"

| "[env->" env_var "]"

| "[is_bcc]"

| "[list->" list_key_word "]"

| "[msg_body]"

| "[msg_encrypted]"

| "[msg_header->" field_name "]" "[" index "]"

| "[msg_header->" field_name "]"

| "[msg_part->type]"

| "[msg_part->body]"

| "[previous_email]"

| "[sender]"

| "[subscriber->" subscriber_key_word "]"

| "[topic]"

| "[topic_auto]"

| "[topic_editor]"

| "[topic_needed]"

| "[topic_sender]"

| "[user->" user_key_word "]"

| "[user_attributes->" user_attributes_keyword "]"

| string

listname : "[listname]"

| listname_string

| listname_string "@" domain_string

date : "[date]"

| date_expr

| integer

user_key_word : "email"

| "gecos"

| "lang"

| "password"

| "cookie_delay_user"

| additional_user_fields

subscriber_key_word : "email"

| "date"

| "bounce"

| "gecos"

| "reception"

| "update_date"

| "visibility"

| additional_subscriber_fields

list_key_word : "name"

| "address"

| "domain"

| "lang"

| "max_size"

| "priority"

| "reply_to"

| "status"

| "subject"

| "total"

| "account"

conf_key_word : "domain"

| "default_list_priority"

| "email"

| "lang"

| "listmaster"

| "max_size"

| "request_priority"

| "sympa_priority"

\# Authentication methods

auth_list : auth "," auth_list

| auth

| ""

auth : "smtp"

| "dkim"

| "md5"

| "smime"

\# Actions

action : "do_it" ( "," "quiet" | "," "notify" )*

| "editor" [ "," "quiet" ]

| "editorkey" [ "," "quiet" ]

| "listmaster" [ "," "notify" ]

| "owner" [ "," "quiet" ]

| "reject" (

"(" "reason=" reason_key ")"

| "(" "tt2=" tpl_name ")"

| "," "quiet"

)*

| "reject(tt2=" tpl_name ")" [ "," "quiet" ]

| "request_auth" [ "([email])" ]

## FILES
$EXPLDIR"/"list path"/scenari"

$SYSCONFDIR"/"virtual host"/scenari"

$SYSCONFDIR"/scenari"

$DEFAULTDIR"/scenari"

Path of scenario files: List, robot and site levels, and distribution defaults.

## SEE ALSO
Sympa::Scenario.

## HISTORY
Original contents of this document were partially taken from a chapter "Authorization scenarios" in Sympa, Mailing List Management Software - Reference manual.


topics.conf

title: topics.conf(5)

summary: Configuration of list topics

text:
# topics.conf(5)

## NAME
topics.conf - Configuration of list topics

## DESCRIPTION
topics.conf defines topics (categories) of the mailing lists.

TBD

## FILES
$DEFAULTDIR/topics.conf

Distribution default. This file should not be edited.

$SYSCONFDIR/topics.conf

$SYSCONFDIR/<robot name>/topics.conf

Configuration files for site-wide default and each robot.

## SEE ALSO
wwsympa(8).

## HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.


title: trusted_applications.conf(5)

text:
# trusted_applications.conf(5)

## NAME
trusted_applications.conf - Defining applications of SOAP HTTP interface for Sympa

## DESCRIPTION
trusted_applications.conf defines applications of SOAP HTTP interface for Sympa.

TBD.

## FILES
$SYSCONFDIR/<robot name>/trusted_applications.conf

Configuration files for each robot.

## SEE ALSO
wwsympa(8), sympa_soap_server(8).

## HISTORY
This document was initially written by IKEDA Soji <ikeda@conversion.co.jp>.


syncthing-config

package: syncthing

title: syncthing-config(5)

summary: Syncthing Configuration

text:
# syncthing-config(5)

## NAME
syncthing-config - Syncthing Configuration

## OVERVIEW
This page covers how to configure Syncthing for file synchronization, including device setup, folder configuration, connection settings, and various configuration methods through the web GUI, command-line, or direct file editing.

## CONFIGURATION FILE LOCATIONS
The default configuration and database directory locations are:

```
$XDG_STATE_HOME/syncthing
$HOME/.local/state/syncthing
$HOME/Library/Application Support/Syncthing
%LOCALAPPDATA%\Syncthing
```

## DESCRIPTION
Changed in version 1.27.0: The default location of the configuration and database directory on Unix-like systems was changed to $XDG_STATE_HOME/syncthing or $HOME/.local/state/syncthing. Previously the default config location was $XDG_CONFIG_HOME/syncthing or $HOME/.config/syncthing. The database directory was previously $HOME/.config/syncthing or, if the environment variable was set, $XDG_DATA_HOME/syncthing. Existing installations may still use these directories instead of the newer defaults.

Added in version 1.5.0: Database and config can now be set separately. Previously the database was always located in the same directory as the config.

Syncthing uses a single directory to store configuration and crypto keys. Syncthing also keeps an index database with file metadata which is by default stored in the same directory, though this can be overridden.

The location defaults to $XDG_STATE_HOME/syncthing or $HOME/.local/state/syncthing (Unix-like), $HOME/Library/Application Support/Syncthing (Mac), or %LOCALAPPDATA%\Syncthing (Windows). It can be changed at runtime using the --config or --home flags or the corresponding environment variables ($STCONFDIR or STHOMEDIR). The following files are located in this directory:

config.xml

The configuration file, in XML format.

cert.pem, key.pem

The device’s ECDSA public and private key. These form the basis for the device ID. The key must be kept private.

https-cert.pem, https-key.pem

The certificate and key for HTTPS GUI connections. These may be replaced with a custom certificate for HTTPS as desired.

The database is by default stored in the same directory as the config, but the location may be overridden by the --data or --home flags or the corresponding environment variables ($STDATADIR or STHOMEDIR).

The database directory contains the following files, among others:

index-*

The database with metadata and hashes of the files currently on disk and available from peers.

syncthing.log

Log output, on some systems.

audit-*.log

Audit log data, when enabled.

panic-*.log

Crash log data, when required.

## CONFIG FILE FORMAT
The following shows an example of a default configuration file (IDs will differ):

NOTE:

The config examples are present for illustration. Do not copy them entirely to use as your config. They are likely out-of-date and the values may no longer correspond to the defaults.

```
<configuration version="37">

    <folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">

        <filesystemType>basic</filesystemType>

        <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">

            <encryptionPassword></encryptionPassword>

        </device>

        <minDiskFree unit="%">1</minDiskFree>

        <versioning>

            <cleanupIntervalS>3600</cleanupIntervalS>

            <fsPath></fsPath>

            <fsType>basic</fsType>

        </versioning>

        <copiers>0</copiers>

        <pullerMaxPendingKiB>0</pullerMaxPendingKiB>

        <hashers>0</hashers>

        <order>random</order>

        <ignoreDelete>false</ignoreDelete>

        <scanProgressIntervalS>0</scanProgressIntervalS>

        <pullerPauseS>0</pullerPauseS>

        <maxConflicts>-1</maxConflicts>

        <disableSparseFiles>false</disableSparseFiles>

        <paused>false</paused>

        <markerName>.stfolder</markerName>

        <copyOwnershipFromParent>false</copyOwnershipFromParent>

        <modTimeWindowS>0</modTimeWindowS>

        <maxConcurrentWrites>16</maxConcurrentWrites>

        <disableFsync>false</disableFsync>

        <blockPullOrder>standard</blockPullOrder>

        <copyRangeMethod>standard</copyRangeMethod>

        <caseSensitiveFS>false</caseSensitiveFS>

        <junctionsAsDirs>false</junctionsAsDirs>

        <syncOwnership>false</syncOwnership>

        <sendOwnership>false</sendOwnership>

        <syncXattrs>false</syncXattrs>

        <sendXattrs>false</sendXattrs>

    </folder>

    <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">

        <address>dynamic</address>

        <paused>false</paused>

        <autoAcceptFolders>false</autoAcceptFolders>

        <maxSendKbps>0</maxSendKbps>

        <maxRecvKbps>0</maxRecvKbps>

        <ignoredFolder time="2022-01-09T19:09:52Z" id="br63e-wyhb7" label="Foo"></ignoredFolder>

        <maxRequestKiB>0</maxRequestKiB>

        <untrusted>false</untrusted>

        <remoteGUIPort>0</remoteGUIPort>

    </device>

    <gui enabled="true" tls="false">

        <address>127.0.0.1:8384</address>

        <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>

        <theme>default</theme>

    </gui>

    <ldap></ldap>

    <options>

        <listenAddress>default</listenAddress>

        <globalAnnounceServer>default</globalAnnounceServer>

        <globalAnnounceEnabled>true</globalAnnounceEnabled>

        <localAnnounceEnabled>true</localAnnounceEnabled>

        <localAnnouncePort>21027</localAnnouncePort>

        <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>

        <maxSendKbps>0</maxSendKbps>

        <maxRecvKbps>0</maxRecvKbps>

        <reconnectionIntervalS>60</reconnectionIntervalS>

        <relaysEnabled>true</relaysEnabled>

        <relayReconnectIntervalM>10</relayReconnectIntervalM>

        <startBrowser>true</startBrowser>

        <natEnabled>true</natEnabled>

        <natLeaseMinutes>60</natLeaseMinutes>

        <natRenewalMinutes>30</natRenewalMinutes>

        <natTimeoutSeconds>10</natTimeoutSeconds>

        <urAccepted>0</urAccepted>

        <urSeen>0</urSeen>

        <urUniqueID></urUniqueID>

        <urURL>https://data.syncthing.net/newdata</urURL>

        <urPostInsecurely>false</urPostInsecurely>

        <urInitialDelayS>1800</urInitialDelayS>

        <autoUpgradeIntervalH>12</autoUpgradeIntervalH>

        <upgradeToPreReleases>false</upgradeToPreReleases>

        <keepTemporariesH>24</keepTemporariesH>

        <cacheIgnoredFiles>false</cacheIgnoredFiles>

        <progressUpdateIntervalS>5</progressUpdateIntervalS>

        <limitBandwidthInLan>false</limitBandwidthInLan>

        <minHomeDiskFree unit="%">1</minHomeDiskFree>

        <releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>

        <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>

        <tempIndexMinBlocks>10</tempIndexMinBlocks>

        <unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>

        <trafficClass>0</trafficClass>

        <setLowPriority>true</setLowPriority>

        <maxFolderConcurrency>0</maxFolderConcurrency>

        <crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>

        <crashReportingEnabled>true</crashReportingEnabled>

        <stunKeepaliveStartS>180</stunKeepaliveStartS>

        <stunKeepaliveMinS>20</stunKeepaliveMinS>

        <stunServer>default</stunServer>

        <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>

        <announceLANAddresses>true</announceLANAddresses>

        <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>

        <connectionLimitEnough>0</connectionLimitEnough>

        <connectionLimitMax>0</connectionLimitMax>

    </options>

    <remoteIgnoredDevice time="2022-01-09T20:02:01Z" id="5SYI2FS-LW6YAXI-JJDYETS-NDBBPIO-256MWBO-XDPXWVG-24QPUM4-PDW4UQU" name="bugger" address="192.168.0.20:22000"></remoteIgnoredDevice>

    <defaults>

        <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">

            <filesystemType>basic</filesystemType>

            <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">

                <encryptionPassword></encryptionPassword>

            </device>

            <minDiskFree unit="%">1</minDiskFree>

            <versioning>

                <cleanupIntervalS>3600</cleanupIntervalS>

                <fsPath></fsPath>

                <fsType>basic</fsType>

            </versioning>

            <copiers>0</copiers>

            <pullerMaxPendingKiB>0</pullerMaxPendingKiB>

            <hashers>0</hashers>

            <order>random</order>

            <ignoreDelete>false</ignoreDelete>

            <scanProgressIntervalS>0</scanProgressIntervalS>

            <pullerPauseS>0</pullerPauseS>

            <maxConflicts>10</maxConflicts>

            <disableSparseFiles>false</disableSparseFiles>

            <paused>false</paused>

            <markerName>.stfolder</markerName>

            <copyOwnershipFromParent>false</copyOwnershipFromParent>

            <modTimeWindowS>0</modTimeWindowS>

            <maxConcurrentWrites>16</maxConcurrentWrites>

            <disableFsync>false</disableFsync>

            <blockPullOrder>standard</blockPullOrder>

            <copyRangeMethod>standard</copyRangeMethod>

            <caseSensitiveFS>false</caseSensitiveFS>

            <junctionsAsDirs>false</junctionsAsDirs>

            <syncOwnership>false</syncOwnership>

            <sendOwnership>false</sendOwnership>

            <syncXattrs>false</syncXattrs>

            <sendXattrs>false</sendXattrs>

        </folder>

        <device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">

            <address>dynamic</address>

            <paused>false</paused>

            <autoAcceptFolders>false</autoAcceptFolders>

            <maxSendKbps>0</maxSendKbps>

            <maxRecvKbps>0</maxRecvKbps>

            <maxRequestKiB>0</maxRequestKiB>

            <untrusted>false</untrusted>

            <remoteGUIPort>0</remoteGUIPort>

        </device>

    </defaults>
</configuration>
```

## CONFIGURATION ELEMENT

```
<configuration version="37">

    <folder></folder>

    <device></device>

    <gui></gui>

    <ldap></ldap>

    <options></options>

    <remoteIgnoredDevice></remoteIgnoredDevice>

    <defaults></defaults>
</configuration>
```

This is the root element. It has one attribute:

version

The config version. Increments whenever a change is made that requires migration from previous formats.

It contains the elements described in the following sections and any number of this additional child element:

remoteIgnoredDevice

Contains the ID of the device that should be ignored. Connection attempts from this device are logged to the console but never displayed in the web GUI.

## FOLDER ELEMENT

```
<folder id="default" label="Default Folder" path="/Users/jb/Sync/" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">

    <filesystemType>basic</filesystemType>

    <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">

        <encryptionPassword></encryptionPassword>

    </device>

    <minDiskFree unit="%">1</minDiskFree>

    <versioning>

        <cleanupIntervalS>3600</cleanupIntervalS>

        <fsPath></fsPath>

        <fsType>basic</fsType>

    </versioning>

    <copiers>0</copiers>

    <pullerMaxPendingKiB>0</pullerMaxPendingKiB>

    <hashers>0</hashers>

    <order>random</order>

    <ignoreDelete>false</ignoreDelete>

    <scanProgressIntervalS>0</scanProgressIntervalS>

    <pullerPauseS>0</pullerPauseS>

    <maxConflicts>-1</maxConflicts>

    <disableSparseFiles>false</disableSparseFiles>

    <paused>false</paused>

    <markerName>.stfolder</markerName>

    <copyOwnershipFromParent>false</copyOwnershipFromParent>

    <modTimeWindowS>0</modTimeWindowS>

    <maxConcurrentWrites>16</maxConcurrentWrites>

    <disableFsync>false</disableFsync>

    <blockPullOrder>standard</blockPullOrder>

    <copyRangeMethod>standard</copyRangeMethod>

    <caseSensitiveFS>false</caseSensitiveFS>

    <junctionsAsDirs>false</junctionsAsDirs>

    <syncOwnership>false</syncOwnership>

    <sendOwnership>false</sendOwnership>

    <syncXattrs>false</syncXattrs>

    <sendXattrs>false</sendXattrs>
</folder>
```

One or more folder elements must be present in the file. Each element describes one folder. The following attributes may be set on the folder element:

id (mandatory)

The folder ID, which must be unique.

label

The label of a folder is a human readable and descriptive local name. May be different on each device, empty, and/or identical to other folder labels. (optional)

filesystemType

The internal file system implementation used to access this folder, detailed in a separate chapter.

path (mandatory)

The path to the directory where the folder is stored on this device; not sent to other devices.

type

Controls how the folder is handled by Syncthing. Possible values are:

sendreceive

The folder is in default mode. Sending local and accepting remote changes. Note that this type was previously called “readwrite” which is deprecated but still accepted in incoming configs.

sendonly

The folder is in “send only” mode – it will not be modified by Syncthing on this device. Note that this type was previously called “readonly” which is deprecated but still accepted in incoming configs.

receiveonly

The folder is in “receive only” mode – it will not propagate changes to other devices.

receiveencrypted

Must be used on untrusted devices, where the data cannot be decrypted because no folder password was entered. See Untrusted (Encrypted) Devices.

rescanIntervalS

The rescan interval, in seconds. Can be set to 0 to disable when external plugins are used to trigger rescans.

fsWatcherEnabled

If set to true, this detects changes to files in the folder and scans them.

fsWatcherDelayS

The duration during which changes detected are accumulated, before a scan is scheduled (only takes effect if fsWatcherEnabled is set to true).

fsWatcherTimeoutS

The maximum delay before a scan is triggered when a file is continuously changing. If unset or zero a default value is calculated based on fsWatcherDelayS.

ignorePerms

If true, files originating from this folder will be announced to remote devices with the “no permission bits” flag. The remote devices will use whatever their default permission setting is when creating the files. The primary use case is for file systems that do not support permissions, such as FAT, or environments where changing permissions is impossible.

autoNormalize

Automatically correct UTF-8 normalization errors found in file names. The mechanism and how to set it up is described in a separate chapter.

The following child elements may exist:

device

These must have the id attribute and can have an introducedBy attribute, identifying the device that introduced us to share this folder with the given device. If the original introducer unshares this folder with this device, our device will follow and unshare the folder (subject to skipIntroductionRemovals being false on the introducer device). All mentioned devices are those that will be sharing the folder in question. Each mentioned device must have a separate device element later in the file. It is customary that the local device ID is included in all folders. Syncthing will currently add this automatically if it is not present in the configuration file.

The encryptionPassword sub-element contains the secret needed to decrypt this folder’s data on the remote device. If left empty, the data is plainly accessible (but still protected by the transport encryption). The mechanism and how to set it up is described in a separate chapter.

minDiskFree

The minimum required free space that should be available on the disk this folder resides. The folder will be stopped when the value drops below the threshold. The element content is interpreted according to the given unit attribute. Accepted unit values are % (percent of the disk / volume size), kB, MB, GB and TB. Set to zero to disable.

versioning

Specifies a versioning configuration. SEE ALSO:

File Versioning

copiers

hashers

The number of copier and hasher routines to use, or 0 for the system determined optimums. These are low-level performance options for advanced users only; do not change unless requested to or you’ve actually read and understood the code yourself. :)

pullerMaxPendingKiB

Controls when we stop sending requests to other devices once we’ve got this much unserved requests. The number of pullers is automatically adjusted based on this desired amount of outstanding request data.

order

The order in which needed files should be pulled from the cluster. It has no effect when the folder type is “send only”. The possibles values are:

random (default)

Pull files in random order. This optimizes for balancing resources among the devices in a cluster.

alphabetic

Pull files ordered by file name alphabetically.

smallestFirst, largestFirst

Pull files ordered by file size; smallest and largest first respectively.

oldestFirst, newestFirst

Pull files ordered by modification time; oldest and newest first respectively.

Note that the scanned files are sent in batches and the sorting is applied only to the already discovered files. This means the sync might start with a 1 GB file even if there is 1 KB file available on the source device until the 1 KB becomes known to the pulling device.

ignoreDelete

WARNING:

Enabling this is highly discouraged - use at your own risk. You have been warned.

When set to true, this device will pretend not to see instructions to delete files from other devices. The mechanism is described in a separate chapter.

scanProgressIntervalS

The interval in seconds with which scan progress information is sent to the GUI. Setting to 0 will cause Syncthing to use the default value of two. If you don’t need to see scan progress, set this to -1 to disable it.

pullerPauseS

Tweak for rate limiting the puller when it retries pulling files. Don’t change this unless you know what you’re doing.

maxConflicts

The maximum number of conflict copies to keep around for any given file. The default is 10. -1, means an unlimited number. Setting this to 0 disables conflict copies altogether.

disableSparseFiles

By default, blocks containing all zeros are not written, causing files to be sparse on filesystems that support this feature. When set to true, sparse files will not be created.

paused

True if this folder is (temporarily) suspended.

markerName

Name of a directory or file in the folder root to be used as a marker - see marker FAQ for its purpose. A marker directory is only created by Syncthing for the default .stfolder, not otherwise.

copyOwnershipFromParent

On Unix systems, tries to copy file/folder ownership from the parent directory (the directory it’s located in). Requires running Syncthing as a privileged user, or granting it additional capabilities (e.g. CAP_CHOWN on Linux).

modTimeWindowS

Allowed modification timestamp difference when comparing files for equivalence. To be used on file systems which have unstable modification timestamps that might change after being recorded during the last write operation. Default is 2 on Android when the folder is located on a FAT partition, and 0 otherwise.

maxConcurrentWrites

Maximum number of concurrent write operations while syncing. Increasing this might increase or decrease disk performance, depending on the underlying storage. Default is 16.

disableFsync

WARNING:

This is a known insecure option - use at your own risk.

Disables committing file operations to disk before recording them in the database. Disabling fsync can lead to data corruption. The mechanism is described in a separate chapter.

blockPullOrder

Order in which the blocks of a file are downloaded. This option controls how quickly different parts of the file spread between the connected devices, at the cost of causing strain on the storage. Available options:

standard (default)

The blocks of a file are split into N equal continuous sequences, where N is the number of connected devices. Each device starts downloading its own sequence, after which it picks other devices sequences at random. Provides acceptable data distribution and minimal spinning disk strain.

random

The blocks of a file are downloaded in a random order. Provides great data distribution, but very taxing on spinning disk drives.

inOrder

The blocks of a file are downloaded sequentially, from start to finish. Spinning disk drive friendly, but provides no improvements to data distribution.

copyRangeMethod

Provides a choice of method for copying data between files. This can be used to optimise copies on network filesystems, improve speed of large copies or clone the data using copy-on-write functionality if the underlying filesystem supports it. The mechanism is described in a separate chapter.

caseSensitiveFS

Affects performance by disabling the extra safety checks for case insensitive filesystems. The mechanism and how to set it up is described in a separate chapter.

junctionsAsDirs

NTFS directory junctions are treated as ordinary directories, if this is set to true.

syncOwnership

File and directory ownership is synced when this is set to true. See syncOwnership for more information.

sendOwnership

File and directory ownership information is scanned when this is set to true. See sendOwnership for more information.

syncXattrs

File and directory extended attributes are synced when this is set to true. See syncXattrs for more information.

sendXattrs

File and directory extended attributes are scanned and sent to other devices when this is set to true. See sendXattrs for more information.

## DEVICE ELEMENT

```
<device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" name="syno" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR">

    <address>dynamic</address>

    <paused>false</paused>

    <autoAcceptFolders>false</autoAcceptFolders>

    <maxSendKbps>0</maxSendKbps>

    <maxRecvKbps>0</maxRecvKbps>

    <ignoredFolder time="2022-01-09T19:09:52Z" id="br63e-wyhb7" label="Foo"></ignoredFolder>

    <maxRequestKiB>0</maxRequestKiB>

    <untrusted>false</untrusted>

    <remoteGUIPort>0</remoteGUIPort>

    <numConnections>0</numConnections>
</device>
<device id="2CYF2WQ-AKZO2QZ-JAKWLYD-AGHMQUM-BGXUOIS-GYILW34-HJG3DUK-LRRYQAR" name="syno local" compression="metadata" introducer="true" skipIntroductionRemovals="false" introducedBy="">

    <address>tcp://192.0.2.1:22001</address>

    <paused>true</paused>

    <allowedNetwork>192.168.0.0/16</allowedNetwork>

    <autoAcceptFolders>false</autoAcceptFolders>

    <maxSendKbps>100</maxSendKbps>

    <maxRecvKbps>100</maxRecvKbps>

    <maxRequestKiB>65536</maxRequestKiB>

    <untrusted>false</untrusted>

    <remoteGUIPort>8384</remoteGUIPort>

    <numConnections>0</numConnections>
</device>
```

One or more device elements must be present in the file. Each element describes a device participating in the cluster. It is customary to include a device element for the local device; Syncthing will currently add one if it is not present. The following attributes may be set on the device element:

id (mandatory)

The device ID.

name

A friendly name for the device. (optional)

compression

Whether to use protocol compression when sending messages to this device. The possible values are:

metadata

Compress metadata packets, such as index information. Metadata is usually very compression friendly so this is a good default.

always

Compress all packets, including file data. This is recommended if the folders contents are mainly compressible data such as documents or text files.

never

Disable all compression.

introducer

Set to true if this device should be trusted as an introducer, i.e. we should copy their list of devices per folder when connecting. SEE ALSO:

Introducer Configuration

skipIntroductionRemovals

Set to true if you wish to follow only introductions and not de-introductions. For example, if this is set, we would not remove a device that we were introduced to even if the original introducer is no longer listing the remote device as known.

introducedBy

Defines which device has introduced us to this device. Used only for following de-introductions.

certName

The device certificate’s common name, if it is not the default “syncthing”.

From the following child elements at least one address child must exist.

address (mandatory: At least one must be present.)

Contains an address or host name to use when attempting to connect to this device. Entries other than dynamic need a protocol specific prefix. For the TCP protocol the prefixes tcp:// (dual-stack), tcp4:// (IPv4 only) or tcp6:// (IPv6 only) can be used. The prefixes for the QUIC protocol are analogous: quic://, quic4:// and quic6:// Note that IP addresses need not use IPv4 or IPv6 prefixes; these are optional. Accepted formats are:

IPv4 address (tcp://192.0.2.42)

The default port (22000) is used.

IPv4 address and port (tcp://192.0.2.42:12345)

The address and port is used as given.

IPv6 address (tcp://[2001:db8::23:42])

The default port (22000) is used. The address must be enclosed in square brackets.

IPv6 address and port (tcp://[2001:db8::23:42]:12345)

The address and port is used as given. The address must be enclosed in square brackets.

Host name (tcp6://fileserver)

The host name will be used on the default port (22000) and connections will be attempted only via IPv6.

Host name and port (tcp://fileserver:12345)

The host name will be used on the given port and connections will be attempted via both IPv4 and IPv6, depending on name resolution.

dynamic

The word dynamic (without any prefix) means to use local and global discovery to find the device.

You can set multiple addresses and combine it with the dynamic keyword for example:

```
<device id="...">

    <address>tcp://192.0.2.1:22001</address>

    <address>quic://192.0.1.254:22000</address>

    <address>dynamic</address>
</device>
```

In the GUI, multiple values are separated by commas.

paused

True if synchronization with this devices is (temporarily) suspended.

allowedNetwork

If given, this restricts connections to this device to only this network. The mechanism is described in detail in a separate chapter). To configure multiple networks, you can either: repeat <allowedNetwork> tags in the configuration file or enter several networks separated by commas in the GUI.

autoAcceptFolders

If true, folders shared from this remote device are automatically added and synced locally under the default path. For the folder name, Syncthing tries to use the label from the remote device, and if the same label already exists, it then tries to use the folder’s ID. If that exists as well, the folder is just offered to accept manually. A local folder already added with the same ID will just be shared rather than created separately.

maxSendKbps

Maximum send rate to use for this device. Unit is kibibytes/second, despite the config name looking like kilobits/second.

maxRecvKbps

Maximum receive rate to use for this device. Unit is kibibytes/second, despite the config name looking like kilobits/second.

ignoredFolder

Contains the ID of the folder that should be ignored. This folder will always be skipped when advertised from the containing remote device, i.e. this will be logged, but there will be no dialog shown in the web GUI. Multiple ignored folders are represented by repeated <ignoredFolder> tags in the configuration file.

maxRequestKiB

Maximum amount of data to have outstanding in requests towards this device. Unit is kibibytes.

remoteGUIPort

If set to a positive integer, the GUI will display an HTTP link to the IP address which is currently used for synchronization. Only the TCP port is exchanged for the value specified here. Note that any port forwarding or firewall settings need to be done manually and the link will probably not work for link-local IPv6 addresses because of modern browser limitations.

untrusted

This boolean value marks a particular device as untrusted, which disallows ever sharing any unencrypted data with it. Every folder shared with that device then needs an encryption password set, or must already be of the “receive encrypted” type locally. Refer to the detailed explanation under Untrusted (Encrypted) Devices.

numConnections

The number of connections to this device. See numConnections for more information.

## GUI ELEMENT

```
<gui enabled="true" tls="false">

    <address>127.0.0.1:8384</address>

    <apikey>k1dnz1Dd0rzTBjjFFh7CXPnrF12C49B1</apikey>

    <theme>default</theme>
</gui>
```

There must be exactly one gui element. The GUI configuration is also used by the REST API and the Event API. The following attributes may be set on the gui element:

enabled

If not true, the GUI and API will not be started.

tls

If set to true, TLS (HTTPS) will be enforced. Non-HTTPS requests will be redirected to HTTPS. When set to false, TLS connections are still possible but not required.

The following child elements may be present:

address (mandatory: Exactly one element must be present.)

Set the listen address. Allowed address formats are:

IPv4 address and port (127.0.0.1:8384)

The address and port are used as given.

IPv6 address and port ([::1]:8384)

The address and port are used as given. The address must be enclosed in square brackets.

Wildcard and port (0.0.0.0:12345, [::]:12345, :12345)

These are equivalent and will result in Syncthing listening on all interfaces via both IPv4 and IPv6.

UNIX socket location (/var/run/st.sock)

If the address is an absolute path it is interpreted as the path to a UNIX socket.

unixSocketPermissions

When address is set to a UNIX socket location, set this to an octal value to override the default permissions of the socket.

user

Set to require authentication.

password

Contains the bcrypt hash of the real password.

apikey

If set, this is the API key that enables usage of the REST interface.

insecureAdminAccess

If true, this allows access to the web GUI from outside (i.e. not localhost) without authorization. A warning will displayed about this setting on startup.

insecureSkipHostcheck

When the GUI / API is bound to localhost, we enforce that the Host header looks like localhost. This option bypasses that check.

insecureAllowFrameLoading

Allow rendering the GUI within an <iframe>, <frame> or <object> by not setting the X-Frame-Options: SAMEORIGIN HTTP header. This may be needed for serving the Syncthing GUI as part of a website through a proxy.

theme

The name of the theme to use.

authMode

Authentication mode to use. If not present, the authentication mode (static) is controlled by the presence of user/password fields for backward compatibility.

static

Authentication using user and password.

ldap

LDAP authentication. Requires ldap top level config section to be present.

sendBasicAuthPrompt

Added in version 1.26.0.

Prior to version 1.26.0 the GUI used HTTP Basic Authorization for login, but starting in version 1.26.0 it uses an HTML form by default. Basic Authorization is still supported when the Authorization request header is present in a request, but some browsers don’t send the header unless prompted by a 401 response.

When this setting is enabled, the GUI will respond to unauthenticated requests with a 401 response prompting for Basic Authorization, so that https://user:pass@localhost style URLs continue to work in standard browsers. Other clients that always send the Authorization request header do not need this setting.

When this setting is disabled, the GUI will not send 401 responses so users won’t see browser popups prompting for username and password.

metricsWithoutAuth

If true, this allows access to the ‘/metrics’ without authentication.

## LDAP ELEMENT

```
<ldap>

    <address>localhost:389</address>

    <bindDN>cn=%s,ou=users,dc=syncthing,dc=net</bindDN>

    <transport>nontls</transport>

    <insecureSkipVerify>false</insecureSkipVerify>
</ldap>
```

The ldap element contains LDAP configuration options. The mechanism is described in detail under LDAP Authentication.

address (mandatory)

LDAP server address (server:port).

bindDN (mandatory)

BindDN for user authentication. Special %s variable should be used to pass username to LDAP.

transport

nontls

Non secure connection.

tls

TLS secured connection.

starttls

StartTLS connection mode.

insecureSkipVerify

Skip verification (true or false).

searchBaseDN

Base DN for user searches.

searchFilter

Search filter for user searches.

## OPTIONS ELEMENT

```
<options>

    <listenAddress>default</listenAddress>

    <globalAnnounceServer>default</globalAnnounceServer>

    <globalAnnounceEnabled>true</globalAnnounceEnabled>

    <localAnnounceEnabled>true</localAnnounceEnabled>

    <localAnnouncePort>21027</localAnnouncePort>

    <localAnnounceMCAddr>[ff12::8384]:21027</localAnnounceMCAddr>

    <maxSendKbps>0</maxSendKbps>

    <maxRecvKbps>0</maxRecvKbps>

    <reconnectionIntervalS>60</reconnectionIntervalS>

    <relaysEnabled>true</relaysEnabled>

    <relayReconnectIntervalM>10</relayReconnectIntervalM>

    <startBrowser>true</startBrowser>

    <natEnabled>true</natEnabled>

    <natLeaseMinutes>60</natLeaseMinutes>

    <natRenewalMinutes>30</natRenewalMinutes>

    <natTimeoutSeconds>10</natTimeoutSeconds>

    <urAccepted>0</urAccepted>

    <urSeen>0</urSeen>

    <urUniqueID></urUniqueID>

    <urURL>https://data.syncthing.net/newdata</urURL>

    <urPostInsecurely>false</urPostInsecurely>

    <urInitialDelayS>1800</urInitialDelayS>

    <autoUpgradeIntervalH>12</autoUpgradeIntervalH>

    <upgradeToPreReleases>false</upgradeToPreReleases>

    <keepTemporariesH>24</keepTemporariesH>

    <cacheIgnoredFiles>false</cacheIgnoredFiles>

    <progressUpdateIntervalS>5</progressUpdateIntervalS>

    <limitBandwidthInLan>false</limitBandwidthInLan>

    <minHomeDiskFree unit="%">1</minHomeDiskFree>

    <releasesURL>https://upgrades.syncthing.net/meta.json</releasesURL>

    <overwriteRemoteDeviceNamesOnConnect>false</overwriteRemoteDeviceNamesOnConnect>

    <tempIndexMinBlocks>10</tempIndexMinBlocks>

    <unackedNotificationID>authenticationUserAndPassword</unackedNotificationID>

    <trafficClass>0</trafficClass>

    <setLowPriority>true</setLowPriority>

    <maxFolderConcurrency>0</maxFolderConcurrency>

    <crashReportingURL>https://crash.syncthing.net/newcrash</crashReportingURL>

    <crashReportingEnabled>true</crashReportingEnabled>

    <stunKeepaliveStartS>180</stunKeepaliveStartS>

    <stunKeepaliveMinS>20</stunKeepaliveMinS>

    <stunServer>default</stunServer>

    <maxConcurrentIncomingRequestKiB>0</maxConcurrentIncomingRequestKiB>

    <announceLANAddresses>true</announceLANAddresses>

    <sendFullIndexOnUpgrade>false</sendFullIndexOnUpgrade>

    <connectionLimitEnough>0</connectionLimitEnough>

    <connectionLimitMax>0</connectionLimitMax>
</options>
```

The options element contains all other global configuration options.

listenAddress

The listen address for incoming sync connections. See Listen Addresses for the allowed syntax. To configure multiple addresses, you can either: repeat <listenAddress> tags in the configuration file or enter several addresses separated by commas in the GUI.

globalAnnounceServer

A URI to a global announce (discovery) server, or the word default to include the default servers. Any number of globalAnnounceServer elements may be present. The syntax for non-default entries is that of an HTTP or HTTPS URL. A number of options may be added as query options to the URL: insecure to prevent certificate validation (required for HTTP URLs) and id=<device ID> to perform certificate pinning. The device ID to use is printed by the discovery server on startup. To configure multiple servers, you can either: repeat <globalAnnounceServer> tags in the configuration file or enter several servers separated by commas in the GUI.

globalAnnounceEnabled

Whether to announce this device to the global announce (discovery) server, and also use it to look up other devices.

localAnnounceEnabled

Whether to send announcements to the local LAN, also use such announcements to find other devices.

localAnnouncePort

The port on which to listen and send IPv4 broadcast announcements to.

localAnnounceMCAddr

The group address and port to join and send IPv6 multicast announcements on.

maxSendKbps

Outgoing data rate limit, in kibibytes per second.

maxRecvKbps

Incoming data rate limits, in kibibytes per second.

reconnectionIntervalS

The number of seconds to wait between each attempt to connect to currently unconnected devices.

relaysEnabled

When true, relays will be connected to and potentially used for device to device connections.

relayReconnectIntervalM

Sets the interval, in minutes, between relay reconnect attempts.

startBrowser

Whether to attempt to start a browser to show the GUI when Syncthing starts.

natEnabled

Whether to attempt to perform a UPnP and NAT-PMP port mapping for incoming sync connections.

natLeaseMinutes

Request a lease for this many minutes; zero to request a permanent lease.

natRenewalMinutes

Attempt to renew the lease after this many minutes.

natTimeoutSeconds

When scanning for UPnP devices, wait this long for responses.

urAccepted

Whether the user has accepted to submit anonymous usage data. The default, 0, mean the user has not made a choice, and Syncthing will ask at some point in the future. -1 means no, a number above zero means that that version of usage reporting has been accepted.

urSeen

The highest usage reporting version that has already been shown in the web GUI.

urUniqueID

The unique ID sent together with the usage report. Generated when usage reporting is enabled.

urURL

The URL to post usage report data to, when enabled.

urPostInsecurely

When true, the UR URL can be http instead of https, or have a self-signed certificate. The default is false.

urInitialDelayS

The time to wait from startup for the first usage report to be sent. Allows the system to stabilize before reporting statistics.

autoUpgradeIntervalH

Check for a newer version after this many hours. Set to 0 to disable automatic upgrades.

upgradeToPreReleases

If true, automatic upgrades include release candidates (see Versions & Releases).

keepTemporariesH

Keep temporary failed transfers for this many hours. While the temporaries are kept, the data they contain need not be transferred again.

cacheIgnoredFiles

Whether to cache the results of ignore pattern evaluation. Performance at the price of memory. Defaults to false as the cost for evaluating ignores is usually not significant.

progressUpdateIntervalS

How often in seconds the progress of ongoing downloads is made available to the GUI. Set to -1 to disable. Note that when disabled, the detailed sync progress for Out of Sync Items which shows how much of each file has been reused, copied, and downloaded will not work.

limitBandwidthInLan

Whether to apply bandwidth limits to devices in the same broadcast domain as the local device.

minHomeDiskFree

The minimum required free space that should be available on the partition holding the configuration and index. The element content is interpreted according to the given unit attribute. Accepted unit values are % (percent of the disk / volume size), kB, MB, GB and TB. Set to zero to disable.

releasesURL

The URL from which release information is loaded, for automatic upgrades.

alwaysLocalNet

Network that should be considered as local given in CIDR notation. To configure multiple networks, you can either: repeat <alwaysLocalNet> tags in the configuration file or enter several networks separated by commas in the GUI.

overwriteRemoteDeviceNamesOnConnect

If set, device names will always be overwritten with the name given by remote on each connection. By default, the name that the remote device announces will only be adopted when a name has not already been set.

tempIndexMinBlocks

When exchanging index information for incomplete transfers, only take into account files that have at least this many blocks.

unackedNotificationID

ID of a notification to be displayed in the web GUI. Will be removed once the user acknowledged it (e.g. a transition notice on an upgrade). Multiple IDs are represented by repeated <unackedNotificationID> tags in the configuration file.

trafficClass

Specify an IPv4 type of service (TOS)/IPv6 traffic class for outgoing packets. To specify a differentiated services code point (DSCP) the value must be bit shifted to the left by two to take the two least significant ECN bits into account.

stunServer

Server to use for STUN, given as ip:port. The keyword default gets expanded to a set of public STUN servers, with preference given to those hosted by the Syncthing project. To configure multiple servers, you can either: repeat <stunServer> tags in the configuration file or enter several servers separated by commas in the GUI.

stunKeepaliveStartS

Interval in seconds between contacting a STUN server to maintain NAT mapping. Default is 180 and you can set it to 0 to disable contacting STUN servers. The interval is automatically reduced if needed, down to a minimum of stunKeepaliveMinS.

stunKeepaliveMinS

Minimum for the stunKeepaliveStartS interval, in seconds.

setLowPriority

Syncthing will attempt to lower its process priority at startup. Specifically: on Linux, set itself to a separate process group, set the niceness level of that process group to nine and the I/O priority to best effort level five; on other Unixes, set the process niceness level to nine; on Windows, set the process priority class to below normal. To disable this behavior, for example to control process priority yourself as part of launching Syncthing, set this option to false.

maxFolderConcurrency

This option controls how many folders may concurrently be in I/O-intensive operations such as syncing or scanning. The mechanism is described in detail in a separate chapter.

crashReportingURL

Server URL where automatic crash reports will be sent if enabled.

crashReportingEnabled

Switch to opt out from the automatic crash reporting feature. Set false to keep Syncthing from sending panic logs on serious troubles. Defaults to true, to help the developers troubleshoot.

maxConcurrentIncomingRequestKiB

This limits how many bytes we have “in the air” in the form of response data being read and processed.

announceLANAddresses

Enable (the default) or disable announcing private (RFC1918) LAN IP addresses to global discovery.

sendFullIndexOnUpgrade

Controls whether all index data is resent when an upgrade has happened, equivalent to starting Syncthing with --reset-deltas. This used to be the default behavior in older versions, but is mainly useful as a troubleshooting step and causes high database churn. The default is now false.

featureFlag

Feature flags are simple strings that, when added to the configuration, may unleash unfinished or still-in-development features to allow early user testing. Any supported value will be separately announced with the feature, so that regular users do not enable it by accident. To configure multiple flags, you can either: repeat <featureFlag> tags in the configuration file or enter several flags separated by commas in the GUI.

connectionLimitEnough

The number of connections at which we stop trying to connect to more devices, zero meaning no limit. Does not affect incoming connections. The mechanism is described in detail in a separate chapter.

connectionLimitMax

The maximum number of connections which we will allow in total, zero meaning no limit. Affects incoming connections and prevents attempting outgoing connections. The mechanism is described in detail in a separate chapter.

auditEnabled

When true, analogous to --audit being set. Defaults to false. When either this option, or --audit (or both) are enabled, auditing is enabled.

auditFile

Analogous to --auditfile. Defaults to being unset. For compatibility reasons, if both this option and --auditfile are set, --auditfile takes priority.

## DEFAULTS ELEMENT

```
<defaults>

    <folder id="" label="" path="~" type="sendreceive" rescanIntervalS="3600" fsWatcherEnabled="true" fsWatcherDelayS="10" fsWatcherTimeoutS="0" ignorePerms="false" autoNormalize="true">

        <filesystemType>basic</filesystemType>

        <device id="S7UKX27-GI7ZTXS-GC6RKUA-7AJGZ44-C6NAYEB-HSKTJQK-KJHU2NO-CWV7EQW" introducedBy="">

            <encryptionPassword></encryptionPassword>

        </device>

        <minDiskFree unit="%">1</minDiskFree>

        <versioning>

            <cleanupIntervalS>3600</cleanupIntervalS>

            <fsPath></fsPath>

            <fsType>basic</fsType>

        </versioning>

        <copiers>0</copiers>

        <pullerMaxPendingKiB>0</pullerMaxPendingKiB>

        <hashers>0</hashers>

        <order>random</order>

        <ignoreDelete>false</ignoreDelete>

        <scanProgressIntervalS>0</scanProgressIntervalS>

        <pullerPauseS>0</pullerPauseS>

        <maxConflicts>10</maxConflicts>

        <disableSparseFiles>false</disableSparseFiles>

        <paused>false</paused>

        <markerName>.stfolder</markerName>

        <copyOwnershipFromParent>false</copyOwnershipFromParent>

        <modTimeWindowS>0</modTimeWindowS>

        <maxConcurrentWrites>16</maxConcurrentWrites>

        <disableFsync>false</disableFsync>

        <blockPullOrder>standard</blockPullOrder>

        <copyRangeMethod>standard</copyRangeMethod>

        <caseSensitiveFS>false</caseSensitiveFS>

        <junctionsAsDirs>false</junctionsAsDirs>

    </folder>

    <device id="" compression="metadata" introducer="false" skipIntroductionRemovals="false" introducedBy="">

        <address>dynamic</address>

        <paused>false</paused>

        <autoAcceptFolders>false</autoAcceptFolders>

        <maxSendKbps>0</maxSendKbps>

        <maxRecvKbps>0</maxRecvKbps>

        <maxRequestKiB>0</maxRequestKiB>

        <untrusted>false</untrusted>

        <remoteGUIPort>0</remoteGUIPort>

        <numConnections>0</numConnections>

    </device>

    <ignores>

        <line>!foo2</line>

        <line>// comment</line>

        <line>(?d).DS_Store</line>

        <line>*2</line>

        <line>qu*</line>

    </ignores>
</defaults>
```

The defaults element describes a template for newly added device and folder options. These will be used when adding a new remote device or folder, either through the GUI or the command line interface. The following child elements can be present in the defaults element:

device

Template for a device element, with the same internal structure. Any fields here will be used for a newly added remote device. The id attribute is meaningless in this context.

folder

Template for a folder element, with the same internal structure. Any fields here will be used for a newly added shared folder. The id attribute is meaningless in this context. The UI will propose to create new folders at the path given in the path attribute (used to be defaultFolderPath under options). It also applies to folders automatically accepted from a remote device.

Even sharing with other remote devices can be done in the template by including the appropriate folder.device element underneath.

ignores

Added in version 1.19.0.

Template for the ignore patterns applied to new folders. These are copied to the .stignore file when a folder is automatically accepted from a remote device. The GUI uses them to pre-fill the respective field when adding a new folder as well. In XML, each pattern line is represented as by a <line> element.

### Listen Addresses
The following address types are accepted in sync protocol listen addresses. If you want Syncthing to listen on multiple addresses, you can either: repeat <listenAddress> tags in the configuration file or enter several addresses separated by commas in the GUI.

Default listen addresses (default)

This is equivalent to tcp://0.0.0.0:22000, quic://0.0.0.0:22000 and dynamic+https://relays.syncthing.net/endpoint.

TCP wildcard and port (tcp://0.0.0.0:22000, tcp://:22000)

These are equivalent and will result in Syncthing listening on all interfaces, IPv4 and IPv6, on the specified port.

TCP IPv4 wildcard and port (tcp4://0.0.0.0:22000, tcp4://:22000)

These are equivalent and will result in Syncthing listening on all interfaces via IPv4 only.

TCP IPv4 address and port (tcp4://192.0.2.1:22000)

This results in Syncthing listening on the specified address and port, IPv4 only.

TCP IPv6 wildcard and port (tcp6://[::]:22000, tcp6://:22000)

These are equivalent and will result in Syncthing listening on all interfaces via IPv6 only.

TCP IPv6 address and port (tcp6://[2001:db8::42]:22000)

This results in Syncthing listening on the specified address and port, IPv6 only.

QUIC address and port (e.g. quic://0.0.0.0:22000)

Syntax is the same as for TCP, also quic4 and quic6 can be used.

Static relay address (relay://192.0.2.42:22067?id=abcd123...)

Syncthing will connect to and listen for incoming connections via the specified relay address.

### Todo
Document available URL parameters.

Dynamic relay pool (dynamic+https://192.0.2.42/relays)

Syncthing will fetch the specified HTTPS URL, parse it for a JSON payload describing relays, select a relay from the available ones and listen via that as if specified as a static relay above.

### Todo
Document available URL parameters.

## SYNCING CONFIGURATION FILES
Syncing configuration files between devices (such that multiple devices are using the same configuration files) can cause issues. This is easy to do accidentally if you sync your home folder between devices. A common symptom of syncing configuration files is two devices ending up with the same Device ID.

If you want to use Syncthing to backup your configuration files, it is recommended that the files you are backing up are in a Send Only Folder to prevent other devices from overwriting the per device configuration. The folder on the remote device(s) should not be used as configuration for the remote devices.

If you’d like to sync your home folder in non-send only mode, you may add the folder that stores the configuration files to the ignore list. If you’d also like to backup your configuration files, add another folder in send only mode for just the configuration folder.

## AUTHOR
The Syncthing Authors

## COPYRIGHT
2014-2026, The Syncthing Authors


syncthing-stignore

title: syncthing-stignore(5)

text:
# syncthing-stignore(5)

## NAME
syncthing-stignore - Prevent files from being synchronized to other nodes

## SYNOPSIS

```
.stignore
```

## DESCRIPTION
If some files should not be synchronized to (or from) other devices, a file called .stignore can be created containing file patterns to ignore. The .stignore file must be placed in the root of the synced folder (files in other locations are not applied). The .stignore file itself will never be synced to other devices, although it can #include files that are synchronized between devices. All patterns are relative to the synced folder root. The contents of the .stignore file must be UTF-8 encoded.

NOTE:

Note that ignored files can block removal of an otherwise empty directory. See below for the (?d) prefix to allow deletion of ignored files.

## PATTERNS
The .stignore file contains a list of file or path patterns. The first pattern that matches will decide the fate of a given file.

- Regular file names match themselves, i.e. the pattern foo matches the files foo, subdir/foo as well as any directory named foo. Spaces are treated as regular characters, except for leading and trailing spaces, which are automatically trimmed.

- Asterisk (*) matches zero or more characters in a filename, but does not match the directory separator. te*ne matches telephone, subdir/telephone but not tele/phone.

- Double asterisk (**) matches as above, but also directory separators. te**ne matches telephone, subdir/telephone and tele/sub/dir/phone.

- Question mark (?) matches a single character that is not the directory separator. te??st matches tebest but not teb/st or test.

- Square brackets ([]) denote a character range: [a-z] matches any lower case character.

- Curly brackets ({}) denote a set of comma separated alternatives: {banana,pineapple} matches either banana or pineapple.

- Backslash (\) “escapes” a special character so that it loses its special meaning. For example, \{banana\} matches {banana} exactly and does not denote a set of alternatives as above. NOTE:

On Windows, \ is the path separator, so use | to escape special characters. For example, |{banana|} matches {banana}. To use \ to escape special characters (and use / as the path separator), insert a #escape=\ at the top of the file. Here’s a short example:

```
#escape=\
/foo
/path/bar/\{banana\}
/path/baz\[2\]/ex\[3\].txt
```

\#escape=\ must be placed at the top of the file, before any patterns, but leading comments, and blank lines are OK.

Any files included using #include (see below) will each need their own #escape=\.

Using #escape=\ allows the same file to be synced and used on any operating system.

- A pattern beginning with / matches in the root of the synced folder only. /foo matches foo but not subdir/foo.

- A pattern beginning with #include results in loading patterns from the named file. It is an error for a file to not exist or be included more than once. Note that while this can be used to include patterns from a file in a subdirectory, the patterns themselves are still relative to the synced folder root. Example: #include more-patterns.txt. Any #include directives inside a file loaded by #include require paths specified relative to the directory containing the loaded file, rather than the synchronised root directory.

- A pattern beginning with a ! prefix negates the pattern: matching files are included (that is, not ignored). This can be used to override more general patterns that follow. NOTE:

Negated patterns that can match items below the folder root will cause Syncthing to traverse otherwise ignored directories. If the watcher is enabled, those directories will also be watched. Directories ignored before the first negated pattern can however be safely skipped, since the first matching pattern wins. For example:

```
/foo
/bar
!baz
*
```

The directories foo and bar will be entirely ignored. However any other directories present must be scanned entirely to find any items named baz, despite the fact that they will be ignored due to the *. As a special case, top-level rooted patterns (e.g. !/foo) do not cause this behaviour:

```
!/baz
*
```

In this case, only the directory baz will be scanned, since everything else is ignored by the * pattern.

- A pattern beginning with a (?i) prefix enables case-insensitive pattern matching. (?i)test matches test, TEST and tEsT. The (?i) prefix can be combined with other patterns, for example the pattern (?i)!picture*.png indicates that Picture1.PNG should be synchronized. On Mac OS and Windows, patterns are always case-insensitive.

- A pattern beginning with a (?d) prefix enables removal of these files if they are preventing directory deletion. This prefix should be used by any OS generated files which you are happy to be removed. NOTE:

Prefixes can be specified in any order (e.g. (?d)(?i)), but cannot be combined in a single pair of parentheses like (?di).

•

A line beginning with // is a comment and has no effect. The same double slashes in any other place are interpreted literally, e.g. trying to do file // comment will make Syncthing look for a file called file // comment.

## EXAMPLE
Given a directory layout starting at the synced folder’s root:

```
.DS_Store
.stignore
foo
foofoo
bar/

    baz

    quux

    quuz
bar2/

    baz

    frobble
My Pictures/

    Img15.PNG
```

and an .stignore file with the contents:

```
(?d).DS_Store
!frobble
!quuz
foo
*2
qu*
(?i)my pictures
```

all files and directories called “foo”, ending in a “2” or starting with “qu” will be ignored. The end result becomes:

```
.DS_Store     # ignored, will be deleted if gets in the way of parent directory removal
foo           # ignored, matches "foo"
foofoo        # synced, does not match "foo" but would match "foo*" or "*foo"
bar/          # synced

    baz       # synced

    quux      # ignored, matches "qu*"

    quuz      # synced, matches "qu*" but is excluded by the preceding "!quuz"
bar2/         # synced, despite matching "*2" due to child frobble

    baz       # ignored, due to parent being ignored

    frobble   # synced, due to "!frobble"
My Pictures/  # ignored, matched case insensitive "(?i)my pictures" pattern

    Img15.PNG # ignored, due to parent being ignored
```

NOTE:

Please note that directory patterns ending with a slash some/directory/ matches the content of the directory, but not the directory itself. If you want the pattern to match the directory and its content, make sure it does not have a / at the end of the pattern.

Added in version 1.19.0: Default patterns can be configured which will take effect when automatically accepting a folder from a remote device. The GUI suggests the same patterns when adding a folder manually. In either case, the .stignore file is created with these defaults if none is present yet.

Added in version 2.0.0: Windows users can now use the pipe character (|) to escape metacharacters in the .stignore file. Additionally, adding #escape=X to the top of the file, allows users to define X as the escape character for that particular file.

## AUTHOR
The Syncthing Authors

## COPYRIGHT
2014-2026, The Syncthing Authors


syslog-ng.conf

package: syslog-ng

title: syslog-ng.conf(5)

summary: syslog\-ng configuration file

text:
# syslog-ng.conf(5)

## NAME
syslog-ng.conf - syslog-ng configuration file

## SYNOPSIS
syslog-ng.conf

## DESCRIPTION
This manual page is only an abstract, for the complete documentation of syslog-ng, see The Administrator Guide[1] or the official syslog-ng website[2].

The application is a flexible and highly scalable system logging application. Typically, syslog-ng is used to manage log messages and implement centralized logging, where the aim is to collect the log messages of several devices on a single, central log server. The different devices - called syslog-ng clients - all run syslog-ng, and collect the log messages from the various applications, files, and other sources. The clients send all important log messages to the remote syslog-ng server, where the server sorts and stores them.

## BASIC CONCEPTS OF
The syslog-ng application reads incoming messages and forwards them to the selected destinations. The syslog-ng application can receive messages from files, remote hosts, and other sources.

Log messages enter syslog-ng in one of the defined sources, and are sent to one or more destinations.

Sources and destinations are independent objects, log paths define what syslog-ng does with a message, connecting the sources to the destinations. A log path consists of one or more sources and one or more destinations: messages arriving from a source are sent to every destination listed in the log path. A log path defined in syslog-ng is called a log statement.

Optionally, log paths can include filters. Filters are rules that select only certain messages, for example, selecting only messages sent by a specific application. If a log path includes filters, syslog-ng sends only the messages satisfying the filter rules to the destinations set in the log path.

Other optional elements that can appear in log statements are parsers and rewriting rules. Parsers segment messages into different fields to help processing the messages, while rewrite rules modify the messages by adding, replacing, or removing parts of the messages.

## CONFIGURING SYSLOG-NG
•The main body of the configuration file consists of object definitions: sources, destinations, logpaths define which log message are received and where they are sent. All identifiers, option names and attributes, and any other strings used in the syslog-ng configuration file are case sensitive. Object definitions (also called statements) have the following syntax:

```
type-of-the-object identifier-of-the-object {<parameters>};
```

•Type of the object: One of source, destination, log, filter, parser, rewrite rule, or template.

•Identifier of the object: A unique name identifying the object. When using a reserved word as an identifier, enclose the identifier in quotation marks. All identifiers, attributes, and any other strings used in the syslog-ng configuration file are case sensitive.

Tip

Use identifiers that refer to the type of the object they identify. For example, prefix source objects with s_, destinations with d_, and so on.

Note

Repeating a definition of an object (that is, defining the same object with the same id more than once) is not allowed, unless you use the @define allow-config-dups 1 definition in the configuration file.

•Parameters: The parameters of the object, enclosed in braces {parameters}.

•Semicolon: Object definitions end with a semicolon (;).

For example, the following line defines a source and calls it s_internal.

```
source s_internal { internal(); };
```

The object can be later referenced in other statements using its ID, for example, the previous source is used as a parameter of the following log statement:

```
log { source(s_internal); destination(d_file); };
```

•The parameters and options within a statement are similar to function calls of the C programming language: the name of the option followed by a list of its parameters enclosed within brackets and terminated with a semicolon.

```
option(parameter1, parameter2); option2(parameter1, parameter2);
```

For example, the file() driver in the following source statement has three options: the filename (/var/log/apache/access.log), follow-freq(), and flags(). The follow-freq() option also has a parameter, while the flags() option has two parameters.

```
source s_tail { file("/var/log/apache/access.log"

    follow-freq(1) flags(no-parse, validate-utf8)); };
```

Objects may have required and optional parameters. Required parameters are positional, meaning that they must be specified in a defined order. Optional parameters can be specified in any order using the option(value) format. If a parameter (optional or required) is not specified, its default value is used. The parameters and their default values are listed in the reference section of the particular object.

Example 1. Using required and optional parameters The unix-stream() source driver has a single required argument: the name of the socket to listen on. Optional parameters follow the socket name in any order, so the following source definitions have the same effect:

```
source s_demo_stream1 {

        unix-stream("<path-to-socket>" max-connections(10) group(log)); };
source s_demo_stream2 {

        unix-stream("<path-to-socket>" group(log) max-connections(10)); };
```

•Some options are global options, or can be set globally, for example, whether should use DNS resolution to resolve IP addresses. Global options are detailed in ???.

```
options { use-dns(no); };
```

•Objects can be used before definition.

•Objects can be defined inline as well. This is useful if you use the object only once (for example, a filter). For details, see ???.

•To add comments to the configuration file, start a line with # and write your comments. These lines are ignored by syslog-ng.

```
# Comment: This is a stream source
source s_demo_stream {

        unix-stream("<path-to-socket>" max-connections(10) group(log)); };
```

The syntax of log statements is as follows:

```
log {

    source(s1); source(s2); ...

    optional_element(filter1|parser1|rewrite1);

    optional_element(filter2|parser2|rewrite2);

    ...

    destination(d1); destination(d2); ...

    flags(flag1[, flag2...]);
};
```

The following log statement sends all messages arriving to the localhost to a remote server.

```
source s_localhost { network(ip(127.0.0.1) port(1999)); };
destination d_tcp { network("10.1.2.3" port(1999) localport(999)); };
log { source(s_localhost); destination(d_tcp); };
```

The syslog-ng application has a number of global options governing DNS usage, the timestamp format used, and other general points. Each option may have parameters, similarly to driver specifications. To set global options, add an option statement to the syslog-ng configuration file using the following syntax:

```
options { option1(params); option2(params); ... };
```

Example 2. Using global options

To disable domain name resolving, add the following line to the syslog-ng configuration file:

```
options { use-dns(no); };
```

The sources, destinations, and filters available in syslog-ng are listed below. For details, see The syslog-ng Administrator Guide.

Table 1. Source drivers available in syslog-ng

Name

Description

file()

Opens the specified file and reads messages.

internal()

Messages generated internally in syslog-ng.

network()

Receives messages from remote hosts using the BSD-syslog protocol over IPv4 and IPv6. Supports the TCP, UDP, and TLS network protocols.

pipe()

Opens the specified named pipe and reads messages.

program()

Opens the specified application and reads messages from its standard output.

sun-stream(), sun-streams()

Opens the specified STREAMS device on Solaris systems and reads incoming messages.

syslog()

Listens for incoming messages using the new IETF-standard syslog protocol.

system()

Automatically detects which platform is running on, and collects the native log messages of that platform.

systemd-journal()

Collects messages directly from the journal of platforms that use systemd.

systemd-syslog()

Collects messages from the journal using a socket on platforms that use systemd.

unix-dgram()

Opens the specified unix socket in SOCK_DGRAM mode and listens for incoming messages.

unix-stream()

Opens the specified unix socket in SOCK_STREAM mode and listens for incoming messages.

Table 2. Destination drivers available in syslog-ng

Name

Description

elasticsearch2

Sends messages to an Elasticsearch server. The elasticsearch2 driver supports Elasticsearch version 2 and newer.

file()

Writes messages to the specified file.

hdfs()

Sends messages into a file on a Hadoop Distributed File System (HDFS)[3] node.

kafka()

Publishes log messages to the Apache Kafka[4] message bus, where subscribers can access them.

loggly()

Sends log messages to the Loggly[5] Logging-as-a-Service provider.

logmatic()

Sends log messages to the Logmatic.io[6] Logging-as-a-Service provider.

mongodb()

Sends messages to a MongoDB[7] database.

network()

Sends messages to a remote host using the BSD-syslog protocol over IPv4 and IPv6. Supports the TCP, UDP, and TLS network protocols.

pipe()

Writes messages to the specified named pipe.

program()

Forks and launches the specified program, and sends messages to its standard input.

sql()

Sends messages into an SQL database. In addition to the standard syslog-ng packages, the sql() destination requires database-specific packages to be installed. Refer to the section appropriate for your platform in ???.

syslog()

Sends messages to the specified remote host using the IETF-syslog protocol. The IETF standard supports message transport using the UDP, TCP, and TLS networking protocols.

unix-dgram()

Sends messages to the specified unix socket in SOCK_DGRAM style (BSD).

unix-stream()

Sends messages to the specified unix socket in SOCK_STREAM style (Linux).

usertty()

Sends messages to the terminal of the specified user, if the user is logged in.

Table 3. Filter functions available in

Name

Description

facility()

Filter messages based on the sending facility.

filter()

Call another filter function.

host()

Filter messages based on the sending host.

inlist()

File-based whitelisting and blacklisting.

level() or priority()

Filter messages based on their priority.

match()

Use a regular expression to filter messages based on a specified header or content field.

message()

Use a regular expression to filter messages based on their content.

netmask()

Filter messages based on the IP address of the sending host.

program()

Filter messages based on the sending application.

source()

Select messages of the specified source statement.

tags()

Select messages having the specified tag.

## FILES
/usr/

/etc/syslog-ng/syslog-ng.conf

## SEE ALSO
syslog-ng(8)

Note

For the detailed documentation of see The 3.34 Administrator Guide[8]

If you experience any problems or need help with syslog-ng, visit the syslog-ng mailing list[9].

For news and notifications about of syslog-ng, visit the syslog-ng blogs[10].

## AUTHOR
This manual page was written by the Balabit Documentation Team <documentation@balabit.com>.

## NOTES
1.

The Administrator Guide

https://www.balabit.com/support/documentation/

2.

the official syslog-ng website

https://www.balabit.com/log-management

3.

Hadoop Distributed File System (HDFS)

http://hadoop.apache.org/

4.

Apache Kafka

http://kafka.apache.org

5.

Loggly

https://www.loggly.com/

6.

Logmatic.io

https://logmatic.io/

7.

MongoDB

https://www.mongodb.com

8.

The 3.34 Administrator Guide

https://www.balabit.com/documents/syslog-ng-ose-latest-guides/en/syslog-ng-ose-guide-admin/html/index.html

9.

syslog-ng mailing list

https://lists.balabit.hu/mailman/listinfo/syslog-ng

10.

syslog-ng blogs

https://syslog-ng.org/blogs/