Skip to content

Comments

Document LYO_BASEURL for custom base URL configuration#491

Merged
berezovskyi merged 3 commits intomainfrom
copilot/update-docker-compose-vars
Jan 26, 2026
Merged

Document LYO_BASEURL for custom base URL configuration#491
berezovskyi merged 3 commits intomainfrom
copilot/update-docker-compose-vars

Conversation

Copy link
Contributor

Copilot AI commented Jan 26, 2026

Users had no way to discover the existing LYO_BASEURL environment variable for configuring custom hosts, ports, and paths when deploying behind reverse proxies or to cloud environments.

Changes

  • README.md: Added "Configuring Base URLs" section with usage examples and deployment scenarios
  • docker-compose.yml: Added commented environment variable configuration for all services
  • docker-compose.tomcat.yml: Added commented environment variable configuration for all services

Usage

Set per-service URLs for reverse proxy deployments:

services:
  server-rm:
    environment:
      - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm

Or via shell:

export LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm

The servlet path (/services/) is automatically appended by the application.

Original prompt

This section details on the original issue you should resolve

<issue_title>Modifiable host and port</issue_title>
<issue_description>hi,
the host and ports seem to be hard coded, unless I missed something.
What would be nice is to put an environment variable into the docker-compose.yaml file in order to change the host and port for each of the services.

this seems not to be possible, as the rootservices document always tells me that services are on localhost:8800 (for example)

is there a way to change this that I have missed ?
many thanks </issue_description>

<agent_instructions>We allow LYO_BASEURL env variable to be set on every container, e.g. LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm/. This gives you the ability to fully adjust the URLs, unlocking all sorts of complex reverse proxy deployments.

Update documentation to reflect that and add a commented-out variant to the compose files.</agent_instructions>

Comments on the Issue (you are @copilot in this section)

@berezovskyi Hi @dhakehurst,

We allow LYO_BASEURL env variable to be set on every container, e.g. LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm/. This gives you the ability to fully adjust the URLs, unlocking all sorts of complex reverse proxy deployments.

Example: https://cm.refimpl.oslc.ldsw.eu/ Internally, it uses the 8xxx ports with Caddy serving as a reverse proxy.

Regards,
Andrew


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI and others added 2 commits January 26, 2026 19:43
…compose files

Co-authored-by: berezovskyi <64734+berezovskyi@users.noreply.github.com>
…uidance

Co-authored-by: berezovskyi <64734+berezovskyi@users.noreply.github.com>
@berezovskyi berezovskyi marked this pull request as ready for review January 26, 2026 19:44
Copilot AI review requested due to automatic review settings January 26, 2026 19:44
@berezovskyi berezovskyi enabled auto-merge January 26, 2026 19:45
Copilot AI changed the title [WIP] Update docker-compose to support host and port variables Document LYO_BASEURL for custom base URL configuration Jan 26, 2026
Copilot AI requested a review from berezovskyi January 26, 2026 19:45
@berezovskyi berezovskyi added this pull request to the merge queue Jan 26, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Documents and surfaces the existing LYO_BASEURL configuration so users can control the public/advertised URLs (host/port/prefix) that the RefImpl servers emit in rootservices and generated links—especially useful behind reverse proxies.

Changes:

  • Added README documentation explaining LYO_BASEURL, including usage examples and guidance about not including /services/.
  • Added commented-out LYO_BASEURL examples to src/docker-compose.yml.
  • Added commented-out LYO_BASEURL examples to src/docker-compose.tomcat.yml.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
src/docker-compose.yml Adds commented examples showing how to set LYO_BASEURL per service.
src/docker-compose.tomcat.yml Adds the same commented LYO_BASEURL examples for the Tomcat compose setup.
README.md Introduces a “Configuring Base URLs” section documenting LYO_BASEURL and how it affects advertised URLs.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +166 to +169
By default, the servers use `http://localhost:8080` as the base URL. You can override this using the `LYO_BASEURL` environment variable to configure the public-facing URL for each server. This is particularly useful when:
- Running behind a reverse proxy
- Deploying to a cloud environment with a custom domain
- Using non-standard ports or HTTPS
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new section says the servers use http://localhost:8080 as the base URL by default, but immediately above you document the servers as being available on http://localhost:8800..8803. Since LYO_BASEURL affects the advertised/public URIs in rootservices and generated links (not reachability), consider rewording this to explicitly call out the difference (container internal port 8080 vs published host ports 880x) and optionally mention that setting LYO_BASEURL to http://localhost:8800 etc. aligns the advertised URLs when using Docker Compose.

Copilot uses AI. Check for mistakes.
Comment on lines +173 to +176
For a reverse proxy deployment where the RM server is accessible at `https://mytoolchain.example.com:9443/refimpl/rm/`:
```bash
export LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm
```
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The reverse-proxy example shows the RM server accessible at https://mytoolchain.example.com:9443/refimpl/rm/ (trailing slash), but the LYO_BASEURL value in both examples omits the trailing slash. Please make these consistent and, if there’s a preferred format (with/without trailing slash), state it explicitly to avoid users accidentally ending up with double slashes or missing separators in generated URLs.

Copilot uses AI. Check for mistakes.
- LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm
```

See the commented examples in `docker-compose.yml` for more details.
Copy link

Copilot AI Jan 26, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This points readers only to docker-compose.yml, but the repo also provides docker-compose.tomcat.yml with the same LYO_BASEURL examples. Consider referencing both files here so users on the Tomcat compose path don’t miss the configuration guidance.

Suggested change
See the commented examples in `docker-compose.yml` for more details.
See the commented examples in `docker-compose.yml` and `docker-compose.tomcat.yml` for more details.

Copilot uses AI. Check for mistakes.
Merged via the queue into main with commit 19611cf Jan 26, 2026
14 of 16 checks passed
@berezovskyi berezovskyi deleted the copilot/update-docker-compose-vars branch January 26, 2026 19:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Modifiable host and port

3 participants