# Homeserver Sample Config File - Synapse

## Keyboard shortcuts

Press `←` or `→` to navigate between chapters

Press `S` or `/` to search in the book

Press `?` to show this help

Press `Esc` to hide this help

# Homeserver Sample Configuration File

Below is a sample homeserver configuration file. The homeserver configuration file can be tweaked to change the behaviour of your homeserver. A restart of the server is generally required to apply any changes made to this file.

Note that the contents below are not intended to be copied and used as the basis for a real homeserver.yaml. Instead, if you are starting from scratch, please generate a fresh config using Synapse by following the instructions in Installation.

Documentation for all configuration options can be found in the Configuration Manual.

    # This file is maintained as an up-to-date snapshot of the default
    # homeserver.yaml configuration generated by Synapse. You can find a
    # complete accounting of possible configuration options at
    # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
    #
    # It is *not* intended to be copied and used as the basis for a real
    # homeserver.yaml. Instead, if you are starting from scratch, please generate
    # a fresh config using Synapse by following the instructions in
    # https://element-hq.github.io/synapse/latest/setup/installation.html.
    #
    ################################################################################

    # Configuration file for Synapse.
    #
    # This is a YAML file: see [1] for a quick introduction. Note in particular
    # that *indentation is important*: all the elements of a list or dictionary
    # should have the same indentation.
    #
    # [1] https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html
    #
    # For more information on how to configure Synapse, including a complete accounting of
    # each option, go to docs/usage/configuration/config_documentation.md or
    # https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html
    server_name: "SERVERNAME"
    pid_file: DATADIR/homeserver.pid
    listeners:
      - bind_addresses:
        - ::1
        - 127.0.0.1
        port: 8008
        resources:
        - compress: false
          names:
          - client
          - federation
        tls: false
        type: http
        x_forwarded: true
    database:
      name: sqlite3
      args:
        database: DATADIR/homeserver.db
    log_config: "CONFDIR/SERVERNAME.log.config"
    media_store_path: DATADIR/media_store
    signing_key_path: "CONFDIR/SERVERNAME.signing.key"
    trusted_key_servers:
      - server_name: "matrix.org"