diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 2b23663..2793fd1 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -37,7 +37,7 @@ jobs: - name: Sleep for 10 seconds working-directory: temp run: sleep 10s - - name: Test defguard is available + - name: Test Defguard is available working-directory: temp run: curl -f http://id.localhost/api/v1/health - name: Stop compose stack diff --git a/charts/defguard-proxy/Chart.yaml b/charts/defguard-proxy/Chart.yaml index e94adf6..97bcfd9 100644 --- a/charts/defguard-proxy/Chart.yaml +++ b/charts/defguard-proxy/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: defguard-proxy -description: Defguard proxy is a public-facing proxy for core defguard service +description: Defguard proxy is a public-facing proxy for core Defguard service type: application version: 0.5.5 diff --git a/charts/defguard/values.yaml b/charts/defguard/values.yaml index 657f4af..ed16c42 100644 --- a/charts/defguard/values.yaml +++ b/charts/defguard/values.yaml @@ -12,18 +12,18 @@ autoscaling: cookie: domain: "" insecure: false -# defguard full name override +# Defguard full name override fullnameOverride: "" -# defguard name override +# Defguard name override nameOverride: "" -# defguard-core container image configuration +# Defguard-core container image configuration image: pullPolicy: IfNotPresent repository: ghcr.io/defguard/defguard tag: "" # overrides .Chart.AppVersion -# defguard-core container image pull secrets +# Defguard-core container image pull secrets imagePullSecrets: [] -# defguard-core ingress configuration +# Defguard-core ingress configuration ingress: grpc: annotations: {} diff --git a/docker-compose/.env.template b/docker-compose/.env.template index 61c2e22..2f8db01 100644 --- a/docker-compose/.env.template +++ b/docker-compose/.env.template @@ -20,7 +20,7 @@ DEFGUARD_URL= # Webauthn RP ID (https://w3c.github.io/webauthn/#rp-id) # E.g.: defguard.mycompany.com (without http/https) DEFGUARD_WEBAUTHN_RP_ID= -# Public URL of your defguard proxy gRPC server +# Public URL of your Defguard proxy gRPC server # DEFGUARD_PROXY_URL= # Public URL of your enrollment service # E.g.: https://enrollment.mycompany.com diff --git a/docker-compose/setup.sh b/docker-compose/setup.sh index 407c216..2b67dd5 100755 --- a/docker-compose/setup.sh +++ b/docker-compose/setup.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # shellcheck shell=bash -# This is a script that sets up an entire defguard instance (including core, +# This is a script that sets up an entire Defguard instance (including core, # gateway, enrollment proxy and reverse proxy). It's goal is to prepare # a working instance by running a single command. @@ -261,7 +261,7 @@ print_header() { _EOF_ echo -e "${C_END}" echo - echo "defguard docker-compose deployment setup script v${VERSION}" + echo "Defguard docker-compose deployment setup script v${VERSION}" echo -e "Copyright (C) 2023-2024 ${C_BOLD}teonite${C_END} <${C_BG_GREY}${C_YELLOW}https://teonite.com${C_END}>" echo } @@ -278,7 +278,7 @@ print_usage() { echo echo -e "\t--help this help message" echo -e "\t--non-interactive run in non-interactive mode - !REQUIRES SETTING all options/env vars" - echo -e "\t--domain domain where defguard web UI will be available" + echo -e "\t--domain domain where Defguard web UI will be available" echo -e "\t--enrollment-domain domain where enrollment service will be available" echo -e "\t--use-https configure reverse proxy to use HTTPS" echo -e "\t--volume Docker volumes directory - default: ${VOLUME_DIR}" @@ -491,7 +491,7 @@ load_configuration_from_input() { echo -ne "${C_ITALICS}${C_LBLUE}" cat << _EOF_ -Please provide the values to configure your defguard instance. If you've +Please provide the values to configure your Defguard instance. If you've already configured some options by setting environment variables or through CLI options, those will be used as defaults. @@ -504,7 +504,7 @@ echo -ne "${C_GREY}" cat << _EOF_ Choose domains that will be used to expose your instance through Caddy -reverse proxy. defguard uses a separate domain for the Web UI, and for +reverse proxy. Defguard uses a separate domain for the Web UI, and for the optional enrollment/desktop client configuration/password reset service. @@ -530,7 +530,7 @@ _EOF_ while [ X${domain} = "X" ]; do echo -ne "${C_YELLOW}${TXT_INPUT}${C_END} " - read -p "Enter defguard domain [default: ${CFG_DOMAIN}]: " domain + read -p "Enter Defguard domain [default: ${CFG_DOMAIN}]: " domain if [ "$domain" ]; then CFG_DOMAIN="$domain" fi @@ -644,7 +644,7 @@ validate_required_variables() { } generate_external_urls() { - # prepare full defguard URL + # prepare full Defguard URL if [ $CFG_USE_HTTPS ]; then CFG_DEFGUARD_URL="https://${CFG_DOMAIN}" else @@ -664,7 +664,7 @@ generate_external_urls() { print_config() { echo - echo " ${TXT_BEGIN} Setting up your defguard instance with following config:" + echo " ${TXT_BEGIN} Setting up your Defguard instance with following config:" echo echo -e " ${TXT_SUB} data volume: ${C_BOLD}${VOLUME_DIR}${C_END}" echo @@ -716,7 +716,7 @@ generate_certs() { # TODO: allow configuring CA parameters openssl req -x509 -new -nodes -key ${SSL_DIR}/defguard-ca.key -sha256 -days 1825 -out ${SSL_DIR}/defguard-ca.pem -passin pass:"${PASSPHRASE}" -subj "/C=PL/ST=Zachodniopomorskie/L=Szczecin/O=Example/OU=IT Department/CN=${CFG_DOMAIN}" 2>&1 >> ${LOG_FILE} - # generate CA-signed certificate for defguard gRPC + # generate CA-signed certificate for Defguard gRPC openssl genrsa -out ${SSL_DIR}/defguard-grpc.key 2048 2>&1 >> ${LOG_FILE} openssl req -new -key ${SSL_DIR}/defguard-grpc.key -out ${SSL_DIR}/defguard-grpc.csr -subj "/C=PL/ST=Zachodniopomorskie/L=Szczecin/O=Example/OU=IT Department/CN=${CFG_DOMAIN}" 2>&1 >> ${LOG_FILE} @@ -733,7 +733,7 @@ EOF openssl x509 -req -in ${SSL_DIR}/defguard-grpc.csr -CA ${SSL_DIR}/defguard-ca.pem -CAkey ${SSL_DIR}/defguard-ca.key -passin pass:"${PASSPHRASE}" -CAcreateserial \ -out ${SSL_DIR}/defguard-grpc.crt -days 1000 -sha256 -extfile ${SSL_DIR}/defguard-grpc.ext 2>&1 >> ${LOG_FILE} - # generate CA-signed certificate for defguard proxy gRPC + # generate CA-signed certificate for Defguard proxy gRPC openssl genrsa -out ${SSL_DIR}/defguard-proxy-grpc.key 2048 2>&1 >> ${LOG_FILE} openssl req -new -key ${SSL_DIR}/defguard-proxy-grpc.key -out ${SSL_DIR}/defguard-proxy-grpc.csr -subj "/C=PL/ST=Zachodniopomorskie/L=Szczecin/O=Example/OU=IT Department/CN=${CFG_DOMAIN}" 2>&1 >> ${LOG_FILE} @@ -910,9 +910,9 @@ enable_vpn_gateway() { print_instance_summary() { echo - echo -e "${C_LGREEN} ${TXT_CHECK} defguard setup finished successfully${C_END}. The Docker image version used for the setup was: ${IMAGE_TYPE_NAME}" + echo -e "${C_LGREEN} ${TXT_CHECK} Defguard setup finished successfully${C_END}. The Docker image version used for the setup was: ${IMAGE_TYPE_NAME}" echo - echo "If your DNS configuration is correct your defguard instance should be available at:" + echo "If your DNS configuration is correct your Defguard instance should be available at:" echo echo -e "\t${TXT_SUB} Web UI: ${C_BOLD}${CFG_DEFGUARD_URL}${C_END}" if [ "$CFG_ENABLE_ENROLLMENT" ]; then diff --git a/index.yaml b/index.yaml index 9da01ee..1a0e681 100644 --- a/index.yaml +++ b/index.yaml @@ -15,7 +15,7 @@ entries: - apiVersion: v2 appVersion: 1.2.0 created: "2025-01-22T13:08:49.18194+01:00" - description: Defguard proxy is a public-facing proxy for core defguard service + description: Defguard proxy is a public-facing proxy for core Defguard service digest: 4da4f264bea0fc94741abf1d31be308a8824f80f65a7edef2d7beb3f2ee3c0bb name: defguard-proxy type: application diff --git a/terraform/modules/core/setup.sh b/terraform/modules/core/setup.sh index 8496285..3c59bb2 100755 --- a/terraform/modules/core/setup.sh +++ b/terraform/modules/core/setup.sh @@ -57,10 +57,10 @@ DEFGUARD_DB_USER="${db_username}" DEFGUARD_DB_PASSWORD="${db_password}" EOF -log "Enabling defguard service..." +log "Enabling Defguard service..." systemctl enable defguard -log "Starting defguard service..." +log "Starting Defguard service..." systemctl start defguard %{ for network in vpn_networks ~} diff --git a/terraform/modules/gateway/setup.sh b/terraform/modules/gateway/setup.sh index 21529e3..5738935 100644 --- a/terraform/modules/gateway/setup.sh +++ b/terraform/modules/gateway/setup.sh @@ -57,22 +57,22 @@ GATEWAY_TOKEN="$${SIGNING_INPUT}.$${SIGNATURE}" log "Writing gateway configuration to /etc/defguard/gateway.toml..." tee /etc/defguard/gateway.toml <