mirror of
https://mau.dev/maunium/synapse.git
synced 2024-08-23 10:45:48 +00:00
198 lines
5.6 KiB
Python
198 lines
5.6 KiB
Python
import argparse
|
|
from typing import (
|
|
Any,
|
|
Dict,
|
|
Iterable,
|
|
List,
|
|
MutableMapping,
|
|
Optional,
|
|
Tuple,
|
|
Type,
|
|
TypeVar,
|
|
Union,
|
|
)
|
|
|
|
import jinja2
|
|
|
|
from synapse.config import (
|
|
account_validity,
|
|
api,
|
|
appservice,
|
|
auth,
|
|
background_updates,
|
|
cache,
|
|
captcha,
|
|
cas,
|
|
consent,
|
|
database,
|
|
emailconfig,
|
|
experimental,
|
|
federation,
|
|
groups,
|
|
jwt,
|
|
key,
|
|
logger,
|
|
metrics,
|
|
modules,
|
|
oembed,
|
|
oidc,
|
|
password_auth_providers,
|
|
push,
|
|
ratelimiting,
|
|
redis,
|
|
registration,
|
|
repository,
|
|
retention,
|
|
room,
|
|
room_directory,
|
|
saml2,
|
|
server,
|
|
server_notices,
|
|
spam_checker,
|
|
sso,
|
|
stats,
|
|
third_party_event_rules,
|
|
tls,
|
|
tracer,
|
|
user_directory,
|
|
voip,
|
|
workers,
|
|
)
|
|
|
|
class ConfigError(Exception):
|
|
def __init__(self, msg: str, path: Optional[Iterable[str]] = None):
|
|
self.msg = msg
|
|
self.path = path
|
|
|
|
MISSING_REPORT_STATS_CONFIG_INSTRUCTIONS: str
|
|
MISSING_REPORT_STATS_SPIEL: str
|
|
MISSING_SERVER_NAME: str
|
|
|
|
def path_exists(file_path: str) -> bool: ...
|
|
|
|
TRootConfig = TypeVar("TRootConfig", bound="RootConfig")
|
|
|
|
class RootConfig:
|
|
server: server.ServerConfig
|
|
experimental: experimental.ExperimentalConfig
|
|
tls: tls.TlsConfig
|
|
database: database.DatabaseConfig
|
|
logging: logger.LoggingConfig
|
|
ratelimiting: ratelimiting.RatelimitConfig
|
|
media: repository.ContentRepositoryConfig
|
|
oembed: oembed.OembedConfig
|
|
captcha: captcha.CaptchaConfig
|
|
voip: voip.VoipConfig
|
|
registration: registration.RegistrationConfig
|
|
account_validity: account_validity.AccountValidityConfig
|
|
metrics: metrics.MetricsConfig
|
|
api: api.ApiConfig
|
|
appservice: appservice.AppServiceConfig
|
|
key: key.KeyConfig
|
|
saml2: saml2.SAML2Config
|
|
cas: cas.CasConfig
|
|
sso: sso.SSOConfig
|
|
oidc: oidc.OIDCConfig
|
|
jwt: jwt.JWTConfig
|
|
auth: auth.AuthConfig
|
|
email: emailconfig.EmailConfig
|
|
worker: workers.WorkerConfig
|
|
authproviders: password_auth_providers.PasswordAuthProviderConfig
|
|
push: push.PushConfig
|
|
spamchecker: spam_checker.SpamCheckerConfig
|
|
room: room.RoomConfig
|
|
groups: groups.GroupsConfig
|
|
userdirectory: user_directory.UserDirectoryConfig
|
|
consent: consent.ConsentConfig
|
|
stats: stats.StatsConfig
|
|
servernotices: server_notices.ServerNoticesConfig
|
|
roomdirectory: room_directory.RoomDirectoryConfig
|
|
thirdpartyrules: third_party_event_rules.ThirdPartyRulesConfig
|
|
tracing: tracer.TracerConfig
|
|
redis: redis.RedisConfig
|
|
modules: modules.ModulesConfig
|
|
caches: cache.CacheConfig
|
|
federation: federation.FederationConfig
|
|
retention: retention.RetentionConfig
|
|
background_updates: background_updates.BackgroundUpdateConfig
|
|
|
|
config_classes: List[Type["Config"]] = ...
|
|
def __init__(self) -> None: ...
|
|
def invoke_all(
|
|
self, func_name: str, *args: Any, **kwargs: Any
|
|
) -> MutableMapping[str, Any]: ...
|
|
@classmethod
|
|
def invoke_all_static(cls, func_name: str, *args: Any, **kwargs: Any) -> None: ...
|
|
def parse_config_dict(
|
|
self, config_dict: Dict[str, Any], config_dir_path: str, data_dir_path: str
|
|
) -> None: ...
|
|
def generate_config(
|
|
self,
|
|
config_dir_path: str,
|
|
data_dir_path: str,
|
|
server_name: str,
|
|
generate_secrets: bool = ...,
|
|
report_stats: Optional[bool] = ...,
|
|
open_private_ports: bool = ...,
|
|
listeners: Optional[Any] = ...,
|
|
tls_certificate_path: Optional[str] = ...,
|
|
tls_private_key_path: Optional[str] = ...,
|
|
) -> str: ...
|
|
@classmethod
|
|
def load_or_generate_config(
|
|
cls: Type[TRootConfig], description: str, argv: List[str]
|
|
) -> Optional[TRootConfig]: ...
|
|
@classmethod
|
|
def load_config(
|
|
cls: Type[TRootConfig], description: str, argv: List[str]
|
|
) -> TRootConfig: ...
|
|
@classmethod
|
|
def add_arguments_to_parser(
|
|
cls, config_parser: argparse.ArgumentParser
|
|
) -> None: ...
|
|
@classmethod
|
|
def load_config_with_parser(
|
|
cls: Type[TRootConfig], parser: argparse.ArgumentParser, argv: List[str]
|
|
) -> Tuple[TRootConfig, argparse.Namespace]: ...
|
|
def generate_missing_files(
|
|
self, config_dict: dict, config_dir_path: str
|
|
) -> None: ...
|
|
|
|
class Config:
|
|
root: RootConfig
|
|
default_template_dir: str
|
|
def __init__(self, root_config: Optional[RootConfig] = ...) -> None: ...
|
|
@staticmethod
|
|
def parse_size(value: Union[str, int]) -> int: ...
|
|
@staticmethod
|
|
def parse_duration(value: Union[str, int]) -> int: ...
|
|
@staticmethod
|
|
def abspath(file_path: Optional[str]) -> str: ...
|
|
@classmethod
|
|
def path_exists(cls, file_path: str) -> bool: ...
|
|
@classmethod
|
|
def check_file(cls, file_path: str, config_name: str) -> str: ...
|
|
@classmethod
|
|
def ensure_directory(cls, dir_path: str) -> str: ...
|
|
@classmethod
|
|
def read_file(cls, file_path: str, config_name: str) -> str: ...
|
|
def read_template(self, filenames: str) -> jinja2.Template: ...
|
|
def read_templates(
|
|
self,
|
|
filenames: List[str],
|
|
custom_template_directories: Optional[Iterable[str]] = None,
|
|
) -> List[jinja2.Template]: ...
|
|
|
|
def read_config_files(config_files: Iterable[str]) -> Dict[str, Any]: ...
|
|
def find_config_files(search_paths: List[str]) -> List[str]: ...
|
|
|
|
class ShardedWorkerHandlingConfig:
|
|
instances: List[str]
|
|
def __init__(self, instances: List[str]) -> None: ...
|
|
def should_handle(self, instance_name: str, key: str) -> bool: ...
|
|
|
|
class RoutableShardedWorkerHandlingConfig(ShardedWorkerHandlingConfig):
|
|
def get_instance(self, key: str) -> str: ...
|
|
|
|
def read_file(file_path: Any, config_path: Iterable[str]) -> str: ...
|