| 
									
										
										
										
											2022-06-03 15:40:38 +02:00
										 |  |  | # Advanced
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | Advanced settings options are provided for the sake of allowing admins to tune their instance to their liking. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | These are set to sensible defaults, so most server admins won't need to touch them or think about them. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | **Changing these settings if you don't know what you're doing may break your instance**. | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ## Settings
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | ```yaml | 
					
						
							|  |  |  | #############################
 | 
					
						
							|  |  |  | ##### ADVANCED SETTINGS #####
 | 
					
						
							|  |  |  | #############################
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # Advanced settings pertaining to http timeouts, security, cookies, and more.
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # ONLY ADJUST THESE SETTINGS IF YOU KNOW WHAT YOU ARE DOING!
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # Most users will not need to (and should not) touch these settings, since
 | 
					
						
							|  |  |  | # they are set to sensible defaults, and may break if they are changed.
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # Nevertheless, they are provided for the sake of allowing server admins to
 | 
					
						
							|  |  |  | # tweak their instance for performance or security reasons.
 | 
					
						
							|  |  |  | 
 | 
					
						
							|  |  |  | # String. Value of the SameSite attribute of cookies set by GoToSocial.
 | 
					
						
							|  |  |  | # Defaults to 'lax' to ensure that the OIDC flow does not break, which is
 | 
					
						
							|  |  |  | # fine in most cases. If you want to harden your instance against CSRF attacks
 | 
					
						
							|  |  |  | # and don't mind if some login-related things might break, you can set this
 | 
					
						
							|  |  |  | # to 'strict' instead.
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # For an overview of what this does, see:
 | 
					
						
							|  |  |  | # https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie/SameSite
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # Options: ["lax", "strict"]
 | 
					
						
							|  |  |  | # Default: "lax"
 | 
					
						
							|  |  |  | advanced-cookies-samesite: "lax" | 
					
						
							| 
									
										
										
										
											2022-11-06 10:47:48 +01:00
										 |  |  | 
 | 
					
						
							|  |  |  | # Int. Amount of requests to permit from a single IP address within a span of 5 minutes.
 | 
					
						
							|  |  |  | # If this amount is exceeded, a 429 HTTP error code will be returned.
 | 
					
						
							|  |  |  | # See https://docs.gotosocial.org/en/latest/api/swagger/#rate-limit.
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # If you find yourself adjusting this limit because it's regularly being exceeded,
 | 
					
						
							|  |  |  | # you should first verify that your settings for `trusted-proxies` (above) are correct.
 | 
					
						
							|  |  |  | # In many cases, when the rate limit is exceeded it is because your instance sees all
 | 
					
						
							|  |  |  | # incoming requests as coming from the *same IP address* (you can verify this by looking
 | 
					
						
							|  |  |  | # at the client IPs in your instance logs). If this is the case, try adding that IP
 | 
					
						
							|  |  |  | # address to your `trusted-proxies` *BEFORE* you go adjusting this rate limit setting!
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # If you set this to 0 or less, rate limiting will be disabled entirely.
 | 
					
						
							|  |  |  | # | 
					
						
							|  |  |  | # Examples: [1000, 500, 0]
 | 
					
						
							|  |  |  | # Default: 1000
 | 
					
						
							|  |  |  | advanced-rate-limit-requests: 1000 | 
					
						
							| 
									
										
										
										
											2022-06-03 15:40:38 +02:00
										 |  |  | ``` |