custom proxy domain by marcomc · Pull Request #188 · my127/workspace

marcomc · 2026-06-15T11:07:49Z

Summary

Adds configurable multi-domain support for the Global Proxy while keeping my127.site as the built-in default domain.

Changes

Adds machine-level proxy domain registry support via ~/.config/my127/workspace/proxy-domains.yml.
Adds ws global service proxy config domain ... commands for listing, adding, updating, removing, and importing domains.
Adds proxy runtime commands for generating Traefik host rules, TLS config, and downloading configured certificates.
Moves Global Proxy host rules into generated .env values while keeping the existing Docker Compose service layout.
Updates proxy, mail, logger, and tracing service init scripts to refresh generated proxy rules.
Adds concise upstream docs and cheatsheet entries for custom proxy domains.
Adds PHPUnit coverage for proxy domain management, runtime rule generation, TLS config generation, and certificate downloads.

Notes

my127.site remains the default and is not persisted in the registry.

Testing

vendor/bin/phpunit tests/Test/GlobalService/Proxy --testdox
php -d phar.readonly=0 vendor/bin/phpunit --testdox
vendor/bin/phpstan analyse --memory-limit=1G
vendor/bin/php-cs-fixer fix --dry-run --diff --config=.php-cs-fixer.php src/GlobalService/Proxy tests/Test/GlobalService/Proxy

- Added support for dynamic Traefik rules in mail, proxy, and tracing services using environment variables. - Implemented a new CertificateDownloader class for downloading certificates from specified URLs. - Introduced ProxyDomainCommand for managing proxy domains, including add, update, remove, and import functionalities. - Enhanced ProxyDomainConfiguration to handle domain normalization and conflict checks. - Updated init scripts for mail, proxy, and tracing services to utilize new domain management features. - Added tests for ProxyDomainCommand and ProxyRuntimeCommand to ensure proper functionality of domain management and TLS configurations.

…LS filenames and registry checks

…tting in scripts

…undancy

…e conflict handling in domain commands

marcomc · 2026-06-15T11:52:59Z

        touch .flag-built
    else
-        run docker-compose -p my127ws-logger start
+        run docker-compose -p my127ws-logger up -d


start would not pick up the new generated Traefik rule.
Logger now writes TRAEFIK_KIBANA_RULE into .env before enabling the service. That value is used inside the Compose labels:

labels: - traefik.enable=true - traefik.http.routers.kibana.rule=${TRAEFIK_KIBANA_RULE}

docker-compose up -d reconciles the Compose project: if the interpolated label changed, it recreates the affected container; if nothing changed, it is effectively a start/no-op.

…ement file writing

marcomc · 2026-06-15T12:29:01Z

    echo -ne "\\033[1E" >&2
 }
+
+updateEnvGeneratedKey()


updates one generated key in a .env file.

It rewrites the file by removing any existing line that starts with the same KEY=, preserves all other lines, then appends the new KEY=value at the end.

…xy domains

…y domains

marcomc · 2026-06-15T13:21:51Z

+use my127\Console\Usage\Input;
+use Symfony\Component\Yaml\Yaml;
+
+class ProxyDomainCommand


ProxyDomainCommand manages the registered proxy-domain data.

It handles user-facing registry operations such as:

list domains

add domain

update domain

remove domain

import domains

Supporting multiple domains seems quite complex.

I wonder if we could keep it down to one with a custom option/env var file override the config file or folder to read from, which is more common in multi use tools

like docker compose -f alternate-compose.yml ...

DOCKER_COMPOSE_FILE=alternate-compose.yml docker compose ...

ok, well it'd mean you couldn't run both proxies at the same time as they bind to same host port, but it's quite troubling this PR complexity, when ideally we should be lowering complexity

I wanted to keep compatibility with my127.site
so that a developer could work on multiple projects: some that still use the my127.site while other projects might ported to a custom domain progressively.

marcomc · 2026-06-15T13:23:02Z

+
+use my127\Console\Usage\Input;
+
+class ProxyRuntimeCommand


ProxyRuntimeCommand turns the effective proxy-domain config into runtime artifacts used by services.

It handles generated output such as:

Traefik host rules

Traefik TLS YAML

downloaded certificate files

marcomc · 2026-06-15T13:24:35Z

+
+use Symfony\Component\Yaml\Yaml;
+
+class ProxyDomainConfiguration


ProxyDomainConfiguration validates and normalizes proxy-domain definitions.

It handles:

built-in default domain injection

valid proxy-domain IDs

valid bare DNS names

required certificate/key URLs

derived certificate/key filenames

duplicate domain/filename conflict checks

marcomc · 2026-06-15T13:25:00Z

+
+use Symfony\Component\Yaml\Yaml;
+
+class ProxyDomainRegistry


ProxyDomainRegistry reads and writes the user-managed proxy-domain registry file.

It handles:

reading domains from ~/.config/my127/workspace/proxy-domains.yml

writing registered domains back to that file

creating the config directory when needed

excluding the built-in default domain from the saved registry

marcomc · 2026-06-15T13:25:25Z

+
+use Symfony\Component\Yaml\Yaml;
+
+class ProxyRuntimeConfiguration


ProxyRuntimeConfiguration converts proxy-domain config into Traefik runtime config.

It handles:

generating Traefik Host(...) rules for services

mapping services to host prefixes, such as mail. or kibana.

generating Traefik TLS YAML

pointing Traefik at local /tls/*.crt and /tls/*.key files

marcomc · 2026-06-15T13:25:50Z

+
+namespace my127\Workspace\GlobalService\Proxy;
+
+class CertificateDownloader


CertificateDownloader downloads configured certificate material onto disk.

It handles:

resolving the TLS output directory

downloading certificate/key URLs

writing them using the configured local filenames

cleaning up temporary files if a download fails

…e command references

…bute

…etadata

marcomc · 2026-06-16T15:39:45Z

+    {
+        return $this->attributes->getAttributeMetadata($key);
+    }
+


the function attributeMetadata is needed because domain update/remove must know whether the effective domain comes from proxy-domains.yml, given that it only edits proxy-domains.yml.

… commands

…RLs for certificates

andytson-inviqa · 2026-06-16T16:49:41Z

+        $serviceHostPrefix = [
+            'proxy' => '',
+            'mail' => 'mail.',
+            'logger' => 'kibana.',
+            'tracing' => 'tracing.',
+        ];


feels a bit centralised being here rather than in the services, not obvious to update this if a new service is created

I agree. I can change the command so that no longer takes a service name.
Instead of:

global service proxy config rule <service>

it becomes:

global service proxy config rule [<host-prefix>]

So the proxy runtime no longer needs a centralized service => host prefix map. Each service passes the public hostname prefix it wants to expose:

mail -> config rule mail logger -> config rule kibana tracing -> config rule tracing proxy -> config rule

This also means a future service can use any hostname prefix without having to update a centralised map, and the prefix does not need to match the service name.

would that me good for you?

…and add validation for invalid prefixes

…ificateDownloader

andytson-inviqa

I don't think we need this level of complexity when the only real goal is to make the my127.site domain reconfigurable.

Start small and simple with just making the 'my127.site' string and cert path configurable by configuration file only

marcomc added 6 commits June 15, 2026 12:37

feat(proxy): add documentation for custom global proxy domains

5e585dd

feat(proxy): enhance domain management with conflict resolution for T…

9735ea2

…LS filenames and registry checks

refactor: simplify conditional checks and improve error message forma…

e2c18e8

…tting in scripts

refactor(proxy): streamline domain command executions by reducing red…

f44a784

…undancy

feat(proxy): update documentation for custom proxy domains and improv…

1bd146b

…e conflict handling in domain commands

marcomc commented Jun 15, 2026

View reviewed changes

feat(proxy): add output option for TLS configuration command and impl…

077d98c

…ement file writing

marcomc commented Jun 15, 2026

View reviewed changes

marcomc added 2 commits June 15, 2026 15:04

fix(proxy): correct command syntax for adding and updating Global Pro…

b1c0cd0

…xy domains

fix(proxy): update command syntax for adding and updating Global Prox…

fed1ba8

…y domains

marcomc commented Jun 15, 2026

View reviewed changes

Comment thread src/Types/Workspace/Workspace.php

marcomc added 2 commits June 16, 2026 16:36

feat(proxy): enhance documentation for custom proxy domains and updat…

8b233c2

…e command references

fix(Collection): update source handling to use the last defined attri…

498730c

…bute

marcomc commented Jun 16, 2026

View reviewed changes

Comment thread src/Types/Attribute/Collection.php

marcomc added 2 commits June 16, 2026 17:30

test(Attribute): add test for attribute metadata source precedence

5be6146

feat(Workspace): add attributeMetadata method to retrieve attribute m…

2ef1a66

…etadata

marcomc commented Jun 16, 2026

View reviewed changes

marcomc added 5 commits June 16, 2026 17:41

feat(proxy): enhance proxy domain handling with validation and update…

20aaf8d

… commands

feat(proxy): update proxy configuration documentation with internal U…

c8288fd

…RLs for certificates

Fix proxy domain registry shadow checks

a15989b

Check proxy domain updates against registry

8e50383

Check proxy domain imports against registry

97f2dfb

marcomc requested a review from kierenevans June 16, 2026 16:38

marcomc requested review from andytson-inviqa and coledave June 16, 2026 16:38

marcomc marked this pull request as ready for review June 16, 2026 16:38

marcomc added the enhancement New feature or request label Jun 16, 2026

andytson-inviqa reviewed Jun 16, 2026

View reviewed changes

marcomc added 3 commits June 17, 2026 10:25

feat(proxy): update command for Traefik host rule to use host-prefix …

750b99f

…and add validation for invalid prefixes

feat(proxy): add validation for DNS hostname length in Traefik host rule

84d0402

feat(proxy): enhance error handling for temporary file writes in Cert…

e598829

…ificateDownloader

andytson-inviqa requested changes Jun 17, 2026

View reviewed changes


		use Symfony\Component\Yaml\Yaml;

		class ProxyDomainConfiguration


		use Symfony\Component\Yaml\Yaml;

		class ProxyRuntimeConfiguration


		namespace my127\Workspace\GlobalService\Proxy;

		class CertificateDownloader

Uh oh!

Conversation

marcomc commented Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Changes

Notes

Testing

Uh oh!

marcomc Jun 15, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andytson-inviqa Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andytson-inviqa Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

marcomc Jun 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

andytson-inviqa left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

marcomc commented Jun 15, 2026 •

edited

Loading

marcomc Jun 15, 2026 •

edited

Loading

andytson-inviqa Jun 16, 2026 •

edited

Loading

andytson-inviqa Jun 16, 2026 •

edited

Loading

marcomc Jun 16, 2026 •

edited

Loading

andytson-inviqa left a comment •

edited

Loading