config.toml file usage not documented anywhere

[pandalion98]

What problem or use case are you trying to solve?
I'm trying to figure out how to edit config.toml and use it for my Docker deployment. I'm starting off from the quick installation guide.

Describe the UX of the solution you'd like
Update the documentation, perhaps a sample command, that will make the use of config.toml straightforward.

Do you have thoughts on the technical implementation?
No.

Describe alternatives you've considered
There are no alternatives. I searched diligently on how to use it, even opening a console on the container and trying to look for this config file.

I modified the quick start command by adding an additional line -v /root/config.toml:/app/config.toml

docker run -it --rm --pull=always \
    -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:0.17-nikolaik \
    -e LOG_ALL_EVENTS=true \
    -v /var/run/docker.sock:/var/run/docker.sock \
    -v ~/.openhands-state:/.openhands-state \
    -v /root/config.toml:/app/config.toml \
    -p 3000:3000 \
    --add-host host.docker.internal:host-gateway \
    --name openhands-app \
    docker.all-hands.dev/all-hands-ai/openhands:0.17

to no effect.

Additional context
I'm trying to expose a port on the sandbox.

• I tried runtime_extra_build_args = ["-p 80:80", "-p 8080:8080"] from within config.toml.
• I also tried to add -e SANDBOX_RUNTIME_EXTRA_BUILD_ARGS=["-p 80:80", "-p 8080:8080"] \ to the starter command.
• Finally I tried to use host networking via -e SANDBOX_USE_HOST_NETWORK=True \ which works, however this seems to cause a UI bug where the workspace files are not visible.

I frequently see people using it such as this one that mentions "here's my toml file", however I could not find a single result that uses config.toml for Docker deployments.

[pandalion98]

Filed the UI bug under #5964

[mamoodi]

The config.toml doesn't get used for the docker mode. It gets used in the development workflow.

The configurations available are documented here: https://docs.all-hands.dev/modules/usage/configuration-options
However, we have some bugs that some configuration options don't seem to get respected.