Module ImportFrom alias ClassDef bases NameLoad body FunctionDef arguments args NameParam NameParam defaults body Assign AttributeStore NameLoad attr SubscriptLoad NameLoad Index Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr SubscriptLoad NameLoad Index Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str NameLoad Assign AttributeStore NameLoad attr SubscriptLoad NameLoad Index Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str NameLoad Assign AttributeStore NameLoad attr Call AttributeLoad NameLoad attr Str ListLoad Assign NameStore Call AttributeLoad NameLoad attr Str If NameLoad body Assign AttributeStore NameLoad attr ListLoad Assign NameStore Call AttributeLoad NameLoad attr Str Str Assign NameStore Call AttributeLoad NameLoad attr Str NameLoad Assign NameStore IfExp AttributeLoad NameLoad attr ListLoad Str Str ListLoad Str Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str Str Str Str Str NameLoad NameLoad NameLoad Str ListLoad Dict Str Str NameLoad NameLoad Dict Str Str ListLoad Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str BinOpSub NameLoad Num If NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str Str Str Str Str NameLoad NameLoad NameLoad Str ListLoad Dict Str Str NameLoad NameLoad Dict Str Str ListLoad Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str If NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str Str Str NameLoad Str Str Assign NameStore Call AttributeLoad NameLoad attr Str If NameLoad body Expr Call AttributeLoad AttributeLoad NameLoad attr attr Dict Str Str Str Str Str NameLoad Call AttributeLoad NameLoad attr Str Str NameLoad Str ListLoad Dict Str Str ListLoad Str NameLoad Assign NameStore Call AttributeLoad NameLoad attr Str If UnaryOpNot NameLoad body For NameStore AttributeLoad NameLoad attr body If BoolOpAnd CompareEq SubscriptLoad NameLoad Index Str Str UnaryOpNot Call AttributeLoad NameLoad attr Str NameLoad body Assign NameStore SubscriptLoad NameLoad Index Str Break orelse Raise Call NameLoad Str Assign NameStore AttributeLoad NameLoad attr If CompareNotIn Str NameLoad body Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad orelse Assign NameStore SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num Assign NameStore BinOpMod Str TupleLoad NameLoad NameLoad Assign NameStore BinOpMod Str TupleLoad NameLoad Assign AttributeStore NameLoad attr NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults kwarg body If CompareIn Str NameLoad body Assign NameStore Call NameLoad SubscriptLoad Call AttributeLoad NameLoad attr Str Index Num Assign NameStore BinOpSub NameLoad Num orelse Assign NameStore Num Assign NameStore Num Assign NameStore Call AttributeLoad NameLoad attr Str Return BinOpMod Str Call NameLoad decorator_list FunctionDef arguments args NameParam NameParam defaults body If CompareIsNot AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr If CompareIsNot AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr If CompareIsNot AttributeLoad NameLoad attr NameLoad body Assign AttributeStore NameLoad attr AttributeLoad NameLoad attr decorator_list FunctionDef arguments args NameParam NameParam defaults body Assign NameStore Call AttributeLoad NameLoad attr Str Expr Call AttributeLoad NameLoad attr Str Str keyword Str keyword NameLoad keyword Str Expr Call AttributeLoad NameLoad attr Str keyword Str keyword NameLoad keyword Str Expr Call AttributeLoad NameLoad attr Str keyword Str keyword Str keyword NameLoad keyword Str decorator_list decorator_list
N/A _base Config ServerConfig N/A Config N/A read_config N/A N/A self config N/A N/A N/A N/A self server_name N/A config N/A server_name N/A N/A self pid_file N/A N/A self abspath N/A N/A config get pid_file N/A N/A self web_client N/A config N/A web_client N/A N/A self web_client_location N/A N/A config get web_client_location None N/A N/A self soft_file_limit N/A config N/A soft_file_limit N/A N/A self daemonize N/A N/A config get daemonize N/A N/A self print_pidfile N/A N/A config get print_pidfile N/A N/A self user_agent_suffix N/A N/A config get user_agent_suffix N/A N/A self use_frozen_dicts N/A N/A config get use_frozen_dicts True N/A N/A self listeners N/A N/A config get listeners N/A N/A bind_port N/A N/A config get bind_port N/A bind_port N/A N/A N/A self listeners N/A N/A bind_host N/A N/A config get bind_host N/A gzip_responses N/A N/A config get gzip_responses True N/A names N/A N/A self web_client N/A client webclient N/A client N/A N/A N/A N/A self listeners append N/A port bind_address tls type resources bind_port bind_host True http N/A N/A names compress names gzip_responses N/A names compress N/A federation False N/A unsecure_port N/A N/A config get unsecure_port N/A bind_port 400 N/A unsecure_port N/A N/A N/A N/A N/A self listeners append N/A port bind_address tls type resources unsecure_port bind_host False http N/A N/A names compress names gzip_responses N/A names compress N/A federation False N/A manhole N/A N/A config get manhole N/A manhole N/A N/A N/A N/A N/A self listeners append N/A port bind_address type manhole 127.0.0.1 manhole N/A metrics_port N/A N/A config get metrics_port N/A metrics_port N/A N/A N/A N/A N/A self listeners append N/A port bind_address tls type resources metrics_port N/A N/A config get metrics_bind_host 127.0.0.1 False http N/A N/A names compress N/A metrics False N/A content_addr N/A N/A config get content_addr N/A N/A content_addr N/A N/A listener N/A self listeners N/A N/A N/A N/A N/A listener N/A type http N/A N/A N/A listener get tls False N/A N/A unsecure_port N/A listener N/A port N/A N/A N/A N/A RuntimeError Could not determine 'content_addr' N/A host N/A self server_name N/A N/A : host N/A N/A host N/A %s:%d N/A host unsecure_port N/A N/A host N/A N/A N/A host split : N/A 0 N/A host N/A %s:%d N/A host unsecure_port N/A content_addr N/A http://%s N/A host N/A N/A self content_addr content_addr N/A default_config N/A N/A self server_name N/A kwargs N/A N/A N/A : server_name N/A N/A bind_port N/A int N/A N/A N/A server_name split : N/A 1 N/A unsecure_port N/A bind_port 400 N/A N/A bind_port 8448 N/A unsecure_port 8008 N/A pid_file N/A N/A self abspath homeserver.pid N/A N/A         ## Server ##

        # The domain name of the server, with optional explicit port.
        # This is used by remote servers to connect to this server,
        # e.g. matrix.org, localhost:8080, etc.
        # This is also the last part of your UserID.
        server_name: "%(server_name)s"

        # When running as a daemon, the file to store the pid in
        pid_file: %(pid_file)s

        # Whether to serve a web client from the HTTP/HTTPS root resource.
        web_client: True

        # Set the soft limit on the number of file descriptors synapse can use
        # Zero is used to indicate synapse should set the soft limit to the
        # hard limit.
        soft_file_limit: 0

        # List of ports that Synapse should listen on, their purpose and their
        # configuration.
        listeners:
          # Main HTTPS listener
          # For when matrix traffic is sent directly to synapse.
          -
            # The port to listen for HTTPS requests on.
            port: %(bind_port)s

            # Local interface to listen on.
            # The empty string will cause synapse to listen on all interfaces.
            bind_address: ''

            # This is a 'http' listener, allows us to specify 'resources'.
            type: http

            tls: true

            # Use the X-Forwarded-For (XFF) header as the client IP and not the
            # actual client IP.
            x_forwarded: false

            # List of HTTP resources to serve on this listener.
            resources:
              -
                # List of resources to host on this listener.
                names:
                  - client     # The client-server APIs, both v1 and v2
                  - webclient  # The bundled webclient.

                # Should synapse compress HTTP responses to clients that support it?
                # This should be disabled if running synapse behind a load balancer
                # that can do automatic compression.
                compress: true

              - names: [federation]  # Federation APIs
                compress: false

          # Unsecure HTTP listener,
          # For when matrix traffic passes through loadbalancer that unwraps TLS.
          - port: %(unsecure_port)s
            tls: false
            bind_address: ''
            type: http

            x_forwarded: false

            resources:
              - names: [client, webclient]
                compress: true
              - names: [federation]
                compress: false

          # Turn on the twisted ssh manhole service on localhost on the given
          # port.
          # - port: 9000
          #   bind_address: 127.0.0.1
          #   type: manhole
         N/A locals N/A read_arguments N/A N/A self args N/A N/A N/A N/A N/A args manhole None N/A N/A N/A self manhole N/A args manhole N/A N/A N/A args daemonize None N/A N/A N/A self daemonize N/A args daemonize N/A N/A N/A args print_pidfile None N/A N/A N/A self print_pidfile N/A args print_pidfile N/A add_arguments N/A N/A self parser N/A N/A N/A server_group N/A N/A parser add_argument_group server N/A N/A N/A server_group add_argument -D --daemonize action store_true default None help Daemonize the home server N/A N/A N/A server_group add_argument --print-pidfile action store_true default None help Print the path to the pidfile just before daemonizing N/A N/A N/A server_group add_argument --manhole metavar PORT dest manhole type int help Turn on the twisted telnet manhole service on the given port. N/A N/A