diff --git a/docs/usage/configuration/config_documentation.md b/docs/usage/configuration/config_documentation.md index 569042c3d4..534dc079a1 100644 --- a/docs/usage/configuration/config_documentation.md +++ b/docs/usage/configuration/config_documentation.md @@ -364,7 +364,7 @@ enable_search: false --- ### `ip_range_blacklist` -*(array|null)* This option prevents outgoing requests from being sent to the specified blacklisted IP address CIDR ranges. If this option is not specified then it defaults to private IP address ranges (see the example below). +*(array)* This option prevents outgoing requests from being sent to the specified blacklisted IP address CIDR ranges. If this option is not specified then it defaults to private IP address ranges (see the example below). The blacklist applies to the outbound requests for federation, identity servers, push servers, and for checking key validity for third-party invite events. @@ -374,9 +374,7 @@ This option replaces `federation_ip_range_blacklist` in Synapse v1.25.0. Note: The value is ignored when an HTTP proxy is in use. -Defaults to `null`. - -Example configuration: +Default configuration: ```yaml ip_range_blacklist: - 127.0.0.0/8 @@ -822,7 +820,7 @@ server_context: context --- ### `limit_remote_rooms` -*(object)* When this option is enabled, the room "complexity" will be checked before a user joins a new remote room. If it is above the complexity limit, the server will disallow joining, or will instantly leave. This is useful for homeservers that are resource-constrained. +*(object)* When this option is enabled, the room "complexity" will be checked before a user joins a new remote room. If it is above the complexity limit, the server will disallow joining, or will instantly leave. This is useful for homeservers that are resource-constrained. Room complexity is an arbitrary measure based on factors such as the number of users in the room. This setting has the following sub-options: diff --git a/schemas/synapse-config.schema.json b/schemas/synapse-config.schema.json index 5ecc60b465..e5b060e30e 100644 --- a/schemas/synapse-config.schema.json +++ b/schemas/synapse-config.schema.json @@ -175,32 +175,29 @@ "examples": [false] }, "ip_range_blacklist": { - "type": ["array", "null"], + "type": "array", "description": "This option prevents outgoing requests from being sent to the specified blacklisted IP address CIDR ranges. If this option is not specified then it defaults to private IP address ranges (see the example below).\n\nThe blacklist applies to the outbound requests for federation, identity servers, push servers, and for checking key validity for third-party invite events.\n\n(0.0.0.0 and :: are always blacklisted, whether or not they are explicitly listed here, since they correspond to unroutable addresses.)\n\nThis option replaces `federation_ip_range_blacklist` in Synapse v1.25.0.\n\nNote: The value is ignored when an HTTP proxy is in use.", "items": { "type": "string" }, - "default": null, - "examples": [ - [ - "127.0.0.0/8", - "10.0.0.0/8", - "172.16.0.0/12", - "192.168.0.0/16", - "100.64.0.0/10", - "192.0.0.0/24", - "169.254.0.0/16", - "192.88.99.0/24", - "198.18.0.0/15", - "192.0.2.0/24", - "198.51.100.0/24", - "203.0.113.0/24", - "224.0.0.0/4", - "::1/128", - "fe80::/10", - "fc00::/7", - "2001:db8::/32", - "ff00::/8", - "fec0::/10" - ] + "default": [ + "127.0.0.0/8", + "10.0.0.0/8", + "172.16.0.0/12", + "192.168.0.0/16", + "100.64.0.0/10", + "192.0.0.0/24", + "169.254.0.0/16", + "192.88.99.0/24", + "198.18.0.0/15", + "192.0.2.0/24", + "198.51.100.0/24", + "203.0.113.0/24", + "224.0.0.0/4", + "::1/128", + "fe80::/10", + "fc00::/7", + "2001:db8::/32", + "ff00::/8", + "fec0::/10" ] }, "ip_range_whitelist": {