API server's port is not changed even though it's configured differently in the docker-compose.yaml

[duguyue100]

Describe the bug

A clear and concise description of what the bug is.

I've changed the default api-server port from 8008 to something else, even though the server is correctly served at the new port, in the UI, it didn't change. FYI, the web UI did change correctly.

api_server:http://127.0.0.1:8008

I'm aware of this problem when I first log in to the UI and read through getting started.

To reproduce

Exact steps to reproduce the bug. Provide example code if possible.

Expected behaviour

What is the expected behaviour? What should've happened but didn't?

Environment

• Server type (self hosted \ app.clear.ml): self-hosted
• ClearML SDK Version
• ClearML Server Version (Only for self hosted). Can be found on the bottom right corner of the settings screen. WebApp: 1.16.2-502 • Server: 1.16.2-502 • API: 2.30
• Python Version
• OS (Windows \ Linux \ Macos): Linux

Related Discussion

If this continues a slack thread, please provide a link to the original slack thread.

[jkhenning]

Hi @duguyue100,

See this Slack thread: https://clearml.slack.com/archives/CTK20V944/p1722500528781439?thread_ts=1722368165.495909&cid=CTK20V944

In nutshell, you'll need to set this environment variable to the webserver container:
WEBSERVER__displayedServerUrls={"apiServer":"<apiserver address>","filesServer":"<filesserver addess>"}

[duguyue100]

Cool, thanks, I will use this workaround. But this is still in general a valid bug, correct?

[jkhenning]

Actually I will not consider it a bug since this is a display issue that requires webserver configuration. This does, however, warrants documentation, and we will make sure this is added there

[duguyue100]

Feel free to close it if you want to.