From 5791a3219957d5792508be7264a541bba109f20f Mon Sep 17 00:00:00 2001 From: Mya Date: Sat, 2 Jul 2022 16:04:57 +0000 Subject: [PATCH] Update 'Administration' --- Administration.md | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 Administration.md diff --git a/Administration.md b/Administration.md new file mode 100644 index 0000000..4b1055f --- /dev/null +++ b/Administration.md @@ -0,0 +1,34 @@ +## Configuring bind addresses + +``` +--private_address value configure the bind address for the server (default: "0.0.0.0:8081") [$PAGES_PRIVATE_ADDRESS] +--public_address value configure the bind address for the server (default: "0.0.0.0:8080") [$PAGES_PUBLIC_ADDRESS] +``` + +## Git setup + +``` +--git_branch value the name of the git branch to clone [$PAGES_GIT_BRANCH] +--git_password value the password used to authenticate with the git service [$PAGES_GIT_PASSWORD] +--git_tag value the name of the git tag to clone [$PAGES_GIT_TAG] +--git_url value the git url used to clone the repository [$PAGES_GIT_URL] +--git_username value the username used to authenticate with the git service [$PAGES_GIT_USERNAME] +``` + +## Securing with TLS + +``` +--tls_ca_file value override the ca file name (default: "ca.crt") [$PAGES_TLS_CA_FILE] +--tls_cert_file value override the cert file name (default: "tls.crt") [$PAGES_TLS_CERT_FILE] +--tls_cert_path value where to locate certificates for communication [$PAGES_TLS_CERT_PATH] +--tls_enable whether or not TLS should be enabled (default: false) [$PAGES_TLS_ENABLE] +--tls_key_file value override the key file name (default: "tls.key") [$PAGES_TLS_KEY_FILE] +--tls_reload_interval value how often to reload the config (default: 5m0s) [$PAGES_TLS_RELOAD_INTERVAL] +``` + +## Protecting `/_admin` endpoints + +``` +--admin_password value specify the password used to authenticate requests with the admin endpoints [$PAGES_ADMIN_PASSWORD] +--admin_username value specify the username used to authenticate requests with the admin endpoints (default: "admin") [$PAGES_ADMIN_USERNAME] +```