Skip to content

Document LYO_BASEURL for custom base URL configuration #491

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
berezovskyi merged 3 commits into from
Jan 26, 2026
Merged

Document LYO_BASEURL for custom base URL configuration #491

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5146ba1
Initial plan
Copilot Jan 26, 2026
f083641
Document LYO_BASEURL environment variable and add examples to docker-…
Copilot Jan 26, 2026
eeda559
Fix trailing slashes in LYO_BASEURL examples to match documentation g…
Copilot Jan 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,6 +161,34 @@ After that, OSLC servers are available at the following URLs:
- http://localhost:8802/services/catalog/singleton
- http://localhost:8803/services/catalog/singleton

### Configuring Base URLs

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
Comment on lines +166 to +169
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.

**Examples:**

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
```
Comment on lines +173 to +176
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.

When using Docker Compose, set environment variables for each service:
```yaml
services:
server-rm:
environment:
- 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.

**Note:** The servlet path (e.g., `/services/`) is automatically appended to the base URL, so you should only specify the base path up to but not including `/services/`.

### OAuth Configuration

Currently, OAuth 1.0 with Basic fallback is enabled only on the OSLC RM server (port 8800). Use `admin:admin` credentials for Basic authentication. In order to enable OAuth support on other servers, uncomment the following lines under `src/main/webapp/WEB-INF/web.xml` of each server:

```xml
Expand Down
12 changes: 12 additions & 0 deletions src/docker-compose.tomcat.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,33 @@ services:
dockerfile: ./server-rm/tomcat.Dockerfile
ports:
- "8800:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm
server-cm:
build:
context: ./
dockerfile: ./server-cm/tomcat.Dockerfile
ports:
- "8801:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/cm
server-qm:
build:
context: ./
dockerfile: ./server-qm/tomcat.Dockerfile
ports:
- "8802:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/qm
server-am:
build:
context: ./
dockerfile: ./server-am/tomcat.Dockerfile
ports:
- "8803:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/am
12 changes: 12 additions & 0 deletions src/docker-compose.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,33 @@ services:
dockerfile: server-rm/Dockerfile
ports:
- "127.0.0.1:8800:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/rm
server-cm:
build:
context: ./
dockerfile: server-cm/Dockerfile
ports:
- "127.0.0.1:8801:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/cm
server-qm:
build:
context: ./
dockerfile: server-qm/Dockerfile
ports:
- "127.0.0.1:8802:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/qm
server-am:
build:
context: ./
dockerfile: server-am/Dockerfile
ports:
- "127.0.0.1:8803:8080"
# Uncomment to configure the base URL for reverse proxy or custom domain deployments
# environment:
# - LYO_BASEURL=https://mytoolchain.example.com:9443/refimpl/am
Loading