- π LibreCode Development Proxy
-
- The shared development proxy is running.
-
-
- Open your environment using the URL shown by
- docker compose up.
-
-
-
- The hostname is usually based on the project directory name:
-
-
-
- php83-master/
- β https://php83-master.localhost
-
-
-
- Requests to *.localhost are routed automatically.
-
-
-
-
diff --git a/.docker/nginx-proxy/localhost.conf b/.docker/nginx-proxy/localhost.conf
deleted file mode 100644
index fef7b775..00000000
--- a/.docker/nginx-proxy/localhost.conf
+++ /dev/null
@@ -1,13 +0,0 @@
-server {
- listen 80;
- listen [::]:80;
-
- server_name localhost;
-
- root /usr/share/nginx/html;
- index index.html;
-
- location / {
- try_files /index.html =404;
- }
-}
diff --git a/.docker/nginx-proxy/localhost_location_override b/.docker/nginx-proxy/localhost_location_override
new file mode 100644
index 00000000..b3f4e9c6
--- /dev/null
+++ b/.docker/nginx-proxy/localhost_location_override
@@ -0,0 +1,2 @@
+root /usr/share/nginx/html;
+try_files $uri /index.html =404;
diff --git a/.docker/scripts/proxy-coordinator.sh b/.docker/scripts/proxy-coordinator.sh
old mode 100644
new mode 100755
index 8ac711c8..72f16a01
--- a/.docker/scripts/proxy-coordinator.sh
+++ b/.docker/scripts/proxy-coordinator.sh
@@ -2,253 +2,107 @@
set -eu
-proxy_project=librecode-dev-proxy
-proxy_network=librecode-dev-proxy
-proxy_label=coop.librecode.dev-proxy=true
-
-compose_project() {
- docker inspect \
- --format '{{ index .Config.Labels "com.docker.compose.project" }}' \
- "$(hostname)"
-}
-
-project="$(compose_project)"
-
-if [ -z "$project" ]; then
- echo 'Could not determine the Compose project from the coordinator container.' >&2
- exit 1
-fi
-
-if [ -z "${PROJECT_DIR:-}" ]; then
- echo 'The host project directory was not provided to the coordinator.' >&2
- exit 1
-fi
-
-compose() {
- docker compose \
- --project-name "$project" \
- --project-directory "$PROJECT_DIR" \
- --file "$PROJECT_DIR/docker-compose.yml" \
- "$@"
-}
-
-proxy_compose() {
- docker compose \
- --project-name "$proxy_project" \
- --project-directory "$PROJECT_DIR" \
- --file "$PROJECT_DIR/.docker/docker-compose.proxy.yml" \
- "$@"
-}
-
-container_for_published_port() {
- port="$1"
-
- docker ps \
- --filter "publish=$port" \
- --format '{{.ID}}\t{{.Names}}\t{{.Image}}\t{{.Label "coop.librecode.dev-proxy"}}'
-}
-
-port_is_in_use() {
- container_for_published_port "$1" | grep -q .
-}
-
-compatible_proxy_container() {
- docker ps \
- --filter "label=$proxy_label" \
- --format '{{.ID}}' |
- head -n 1
-}
-
-is_compatible_proxy_port_owner() {
- port="$1"
- info="$(container_for_published_port "$port" | head -n 1)"
-
- [ -n "$info" ] || return 1
-
- compatible="$(printf '%s\n' "$info" | cut -f4)"
-
- [ "$compatible" = "true" ]
-}
-
-proxy_is_ready() {
- [ -n "$(compatible_proxy_container || true)" ] &&
- is_compatible_proxy_port_owner 80 &&
- is_compatible_proxy_port_owner 443
-}
+script_dir="$(cd -- "$(dirname -- "$0")" && pwd)"
+proxy_lib_dir="${PROXY_LIB_DIR:-$script_dir/proxy}"
+release_marker=/tmp/librecode-proxy-lease-released
+
+# shellcheck source=.docker/scripts/proxy/common.sh
+. "$proxy_lib_dir/common.sh"
+
+COORDINATOR_CONTAINER="$(hostname)"
+PROJECT_NAME="$(container_project "$COORDINATOR_CONTAINER")"
+export COORDINATOR_CONTAINER PROJECT_NAME
+
+# These modules share only exported environment and common.sh accessors.
+# Keep the source directives in sync with the runtime paths so ShellCheck can
+# analyze the complete dependency graph without file-wide suppressions.
+# shellcheck source=.docker/scripts/proxy/infrastructure.sh
+. "$proxy_lib_dir/infrastructure.sh"
+# shellcheck source=.docker/scripts/proxy/assets.sh
+. "$proxy_lib_dir/assets.sh"
+# shellcheck source=.docker/scripts/proxy/diagnostics.sh
+. "$proxy_lib_dir/diagnostics.sh"
+# shellcheck source=.docker/scripts/proxy/services.sh
+. "$proxy_lib_dir/services.sh"
+# shellcheck source=.docker/scripts/proxy/lease.sh
+. "$proxy_lib_dir/lease.sh"
+
+validate_environment() {
+ if [ -z "$PROJECT_NAME" ]; then
+ echo 'Could not determine the Compose project from the coordinator container.' >&2
+ return 1
+ fi
-show_conflict() {
- port="$1"
- container_info="$(container_for_published_port "$port" | head -n 1)"
-
- printf 'ββ β Development proxy cannot start βββββββββββββββββββββ\n' >&2
- printf 'β\n' >&2
- printf 'β Port 80 or 443 is already in use by another service.\n' >&2
- printf 'β\n' >&2
- printf 'β This development environment requires:\n' >&2
- printf 'β\n' >&2
- printf 'β HTTP localhost:80\n' >&2
- printf 'β HTTPS localhost:443\n' >&2
- printf 'β\n' >&2
- printf 'β Stop the conflicting service and run:\n' >&2
- printf 'β\n' >&2
- printf 'β docker compose up\n' >&2
- printf 'β\n' >&2
-
- if [ -n "$container_info" ]; then
- name="$(printf '%s\n' "$container_info" | cut -f2)"
- image="$(printf '%s\n' "$container_info" | cut -f3)"
-
- printf 'β Conflicting container\n' >&2
- printf 'β Name %s\n' "$name" >&2
- printf 'β Image %s\n' "$image" >&2
- printf 'β Port %s\n' "$port" >&2
- else
- printf 'β Port %s is already in use by a process outside Docker.\n' "$port" >&2
+ if [ -z "${PROJECT_DIR:-}" ]; then
+ echo 'The host project directory was not provided to the coordinator.' >&2
+ return 1
fi
- printf 'β\n' >&2
- printf 'βββββββββββββββββββββββββββββββββββββββββββββββββββββββββ\n' >&2
+ echo "Validating Compose project ${PROJECT_NAME} at ${PROJECT_DIR}."
+ compose config --quiet
}
-ensure_ports_available() {
- for port in 80 443; do
- if port_is_in_use "$port"; then
- show_conflict "$port"
- exit 1
- fi
- done
+success() {
+ case "$1" in
+ reused)
+ echo 'β
Existing LibreCode development proxy reused. Coordinator lease is active.'
+ ;;
+ started)
+ echo 'β
Development proxy started successfully. Coordinator lease is active.'
+ ;;
+ esac
}
-start_proxy() {
- if proxy_compose up --detach; then
+release() {
+ if [ -f "$release_marker" ]; then
return 0
fi
- # Another checkout may have created the shared proxy concurrently.
- if proxy_is_ready; then
+ echo 'Releasing shared development proxy lease.'
+ disconnect_proxy_from_project_network
+ if release_proxy_if_unused; then
+ touch "$release_marker"
return 0
fi
- for port in 80 443; do
- if port_is_in_use "$port"; then
- show_conflict "$port"
- exit 1
- fi
- done
-
- echo 'Could not start the LibreCode development proxy.' >&2
- exit 1
-}
-
-running_services="$(compose ps --status running --services)"
-
-service_is_running() {
- printf '%s\n' "$running_services" |
- grep -qx "$1"
+ return 1
}
-container_for_service() {
- compose ps -q "$1" 2>/dev/null || true
-}
-
-connect_to_proxy_network() {
- service="$1"
- container="$(container_for_service "$service")"
-
- [ -n "$container" ] || return 0
-
- if docker inspect \
- --format '{{ json .NetworkSettings.Networks }}' \
- "$container" |
- grep -q "\"$proxy_network\""; then
- return 0
- fi
-
- docker network connect "$proxy_network" "$container"
+shutdown() {
+ trap - INT TERM HUP
+ release || true
+ exit 0
}
-connect_running_service_to_proxy_network() {
- service="$1"
+wait_for_shutdown() {
+ trap shutdown INT TERM HUP
- service_is_running "$service" || return 0
- connect_to_proxy_network "$service"
+ while :; do
+ sleep 3600 &
+ wait "$!" || true
+ done
}
-report_environment_ready() {
- set -- \
- -e ENV_NEXTCLOUD_URL="https://${project}.localhost" \
- -e ENV_ADMIN_USER="$NEXTCLOUD_ADMIN_USER" \
- -e ENV_ADMIN_PASSWORD="$NEXTCLOUD_ADMIN_PASSWORD" \
- -e ENV_NEXTCLOUD_BRANCH="$VERSION_NEXTCLOUD"
+run() {
+ validate_environment
+ ensure_proxy_network
+ install_proxy_assets
- if service_is_running mailpit; then
- set -- "$@" \
- -e ENV_MAILPIT_URL="https://${project}-mailpit.localhost"
- fi
+ proxy_state="$(ensure_proxy_running)"
+ install_runtime_diagnostics
- if service_is_running eurooffice; then
- set -- "$@" \
- -e ENV_EUROOFFICE_URL="https://${project}-eurooffice.localhost"
- fi
+ acquire_proxy_lease
+ rm -f "$release_marker"
+ trap shutdown INT TERM HUP
- if service_is_running playwright; then
- set -- "$@" \
- -e ENV_PLAYWRIGHT_URL="https://${project}-playwright.localhost"
- fi
+ connect_proxy_to_project_network
- if service_is_running signal-gateway; then
- set -- "$@" \
- -e ENV_SIGNAL_URL="https://${project}-signal.localhost"
+ if ! report_environment_ready; then
+ echo 'Could not print environment banner.' >&2
fi
- compose exec -T \
- "$@" \
- nextcloud sh /var/www/scripts/report-environment-ready
-}
-
-install_proxy_assets() {
- docker run --rm \
- -v librecode-dev-proxy-conf:/conf \
- -v librecode-dev-proxy-html:/html \
- -v "$PROJECT_DIR/.docker/nginx-proxy:/source:ro" \
- alpine sh -c '
- cp /source/localhost.conf /conf/librecode-localhost.conf
- cp /source/index.html /html/index.html
- '
-}
-
-success() {
- case "$1" in
- reused)
- echo 'β
Existing LibreCode development proxy reused. Coordinator exiting normally.'
- ;;
- started)
- echo 'β
Development proxy started successfully. Coordinator exiting normally.'
- ;;
- esac
+ success "$proxy_state"
+ wait_for_shutdown
}
-echo "Validating Compose project ${project} at ${PROJECT_DIR}."
-compose config --quiet
-
-install_proxy_assets
-
-if proxy_is_ready; then
- proxy_state=reused
-else
- ensure_ports_available
- start_proxy
- proxy_state=started
-fi
-
-connect_running_service_to_proxy_network nginx
-connect_running_service_to_proxy_network mailpit
-connect_running_service_to_proxy_network eurooffice
-connect_running_service_to_proxy_network playwright
-connect_running_service_to_proxy_network signal-gateway
-
-if ! report_environment_ready; then
- echo 'Could not print environment banner.' >&2
-fi
-
-success "$proxy_state"
\ No newline at end of file
+run
diff --git a/.docker/scripts/proxy/assets.sh b/.docker/scripts/proxy/assets.sh
new file mode 100644
index 00000000..58991c5a
--- /dev/null
+++ b/.docker/scripts/proxy/assets.sh
@@ -0,0 +1,54 @@
+#!/bin/sh
+
+proxy_helper_image() {
+ if [ -n "${PROXY_HELPER_IMAGE:-}" ]; then
+ printf '%s\n' "$PROXY_HELPER_IMAGE"
+ return 0
+ fi
+
+ container_image "${COORDINATOR_CONTAINER:-}"
+}
+
+copy_to_named_volume() {
+ volume="$1"
+ source="$2"
+ destination="$3"
+ helper_image="$(proxy_helper_image)"
+
+ [ -n "$helper_image" ] || return 1
+
+ Docker run --rm -i \
+ -v "$volume:/target" \
+ "$helper_image" \
+ tee "/target/$destination" \
+ < "$source" >/dev/null
+}
+
+install_proxy_assets() {
+ assets_volume="$(proxy_assets_volume_name)"
+ vhost_volume="$(proxy_vhost_volume_name)"
+ helper_image="$(proxy_helper_image)"
+
+ [ -n "$helper_image" ] || return 1
+
+ Docker volume create "$assets_volume" >/dev/null
+ Docker volume create "$vhost_volume" >/dev/null
+
+ Docker run --rm \
+ -v "$assets_volume:/target" \
+ "$helper_image" \
+ sh -c 'rm -f /target/Procfile /target/docker-gen.cfg /target/dashboard.tmpl'
+
+ copy_to_named_volume "$assets_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/Procfile" Procfile
+ copy_to_named_volume "$assets_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/docker-gen.cfg" docker-gen.cfg
+ copy_to_named_volume "$assets_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/dashboard.tmpl" dashboard.tmpl
+
+ Docker run --rm \
+ -v "$vhost_volume:/target" \
+ "$helper_image" \
+ sh -c 'rm -f /target/librecode-localhost.conf /target/localhost /target/localhost_location_override /target/\*.localhost /target/\*.localhost_location_override'
+
+ copy_to_named_volume "$vhost_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/localhost_location_override" localhost_location_override
+ copy_to_named_volume "$vhost_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/*.localhost" '*.localhost'
+ copy_to_named_volume "$vhost_volume" "${PROJECT_DIR:-}/.docker/nginx-proxy/*.localhost_location_override" '*.localhost_location_override'
+}
diff --git a/.docker/scripts/proxy/common.sh b/.docker/scripts/proxy/common.sh
new file mode 100644
index 00000000..9ccc2667
--- /dev/null
+++ b/.docker/scripts/proxy/common.sh
@@ -0,0 +1,71 @@
+#!/bin/sh
+
+proxy_project_name() {
+ printf '%s\n' "${PROXY_PROJECT:-librecode-dev-proxy}"
+}
+
+proxy_network_name() {
+ printf '%s\n' "${PROXY_NETWORK:-librecode-dev-proxy}"
+}
+
+proxy_container_label() {
+ printf '%s\n' "${PROXY_LABEL:-coop.librecode.dev-proxy=true}"
+}
+
+proxy_client_label() {
+ printf '%s\n' "${PROXY_CLIENT_LABEL:-coop.librecode.dev-proxy-client=true}"
+}
+
+proxy_assets_volume_name() {
+ printf '%s\n' "${PROXY_ASSETS_VOLUME:-librecode-dev-proxy-assets}"
+}
+
+proxy_vhost_volume_name() {
+ printf '%s\n' "${PROXY_VHOST_VOLUME:-librecode-dev-proxy-vhost}"
+}
+
+Docker() {
+ docker "$@"
+}
+
+container_project() {
+ Docker inspect \
+ --format '{{ index .Config.Labels "com.docker.compose.project" }}' \
+ "$1" 2>/dev/null || true
+}
+
+container_image() {
+ Docker inspect \
+ --format '{{ .Config.Image }}' \
+ "$1" 2>/dev/null || true
+}
+
+container_virtual_host() {
+ Docker inspect \
+ --format '{{range .Config.Env}}{{println .}}{{end}}' \
+ "$1" 2>/dev/null |
+ sed -n 's/^VIRTUAL_HOST=//p' |
+ head -n 1
+}
+
+container_networks() {
+ Docker inspect \
+ --format '{{ json .NetworkSettings.Networks }}' \
+ "$1" 2>/dev/null || true
+}
+
+compose() {
+ Docker compose \
+ --project-name "${PROJECT_NAME:-}" \
+ --project-directory "${PROJECT_DIR:-}" \
+ --file "${PROJECT_COMPOSE_FILE:-${PROJECT_DIR:-}/docker-compose.yml}" \
+ "$@"
+}
+
+proxy_compose() {
+ Docker compose \
+ --project-name "$(proxy_project_name)" \
+ --project-directory "${PROJECT_DIR:-}" \
+ --file "${PROXY_COMPOSE_FILE:-${PROJECT_DIR:-}/.docker/docker-compose.proxy.yml}" \
+ "$@"
+}
diff --git a/.docker/scripts/proxy/diagnostics.sh b/.docker/scripts/proxy/diagnostics.sh
new file mode 100644
index 00000000..aaf79ea0
--- /dev/null
+++ b/.docker/scripts/proxy/diagnostics.sh
@@ -0,0 +1,88 @@
+#!/bin/sh
+
+runtime_version() {
+ component="$1"
+
+ case "$component" in
+ docker)
+ Docker version --format '{{.Server.Version}}'
+ ;;
+ runc)
+ Docker version --format '{{range .Server.Components}}{{if eq .Name "runc"}}{{.Version}}{{end}}{{end}}'
+ ;;
+ esac
+}
+
+version_at_most() {
+ version="${1#v}"
+ maximum="${2#v}"
+
+ version="${version%%-*}"
+ maximum="${maximum%%-*}"
+
+ IFS=. read -r version_major version_minor version_patch <