Skip to content

docs(docker): use the default port in docker run command#298

Open
risu729 wants to merge 1 commit intomatrix-construct:mainfrom
risu729:docs/docker-run-default-port
Open

docs(docker): use the default port in docker run command#298
risu729 wants to merge 1 commit intomatrix-construct:mainfrom
risu729:docs/docker-run-default-port

Conversation

@risu729
Copy link

@risu729 risu729 commented Feb 8, 2026

Summary

This PR addresses an issue in the docker run documentation.
Currently, the example command maps the port to 6167, but it's missing TUWUNEL_PORT=6167 to override the default port 8008.
This change fixes the example by aligning it with the default port 8008.

fn default_port() -> ListeningPort { ListeningPort { ports: Left(8008) } }

Context

I looked into the history of the port configurations.

  1. The very first example in conduit used port 14004 (9504727), though the underlying Rocket framework defaulted to 8000.

  2. The example was later updated from 14004 to 6167 (3bdaf6e).

  3. When refactoring to Axum, the default of 8000 was maintained (1f7b3fa).

  4. With the addition of multi-port support (67b307c), the internal default was changed to 8008, matching Synapse and Dendrite.

Proposed Changes

I suppose we can remove all 6167 references and update them to the default 8008, which makes the docs cleaner.

I'm sorry if you have kept 6167 on purpose, as you should already noticed this inconsistency.

Copilot AI review requested due to automatic review settings February 8, 2026 18:01
Copy link

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

Updates the Docker deployment documentation to use tuwunel’s default internal port in the docker run example, so the port mapping matches the app’s default configuration.

Changes:

  • Change docker run example port mapping from 8448:6167 to 8448:8008.

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


```bash
docker run -d -p 8448:6167 \
docker run -d -p 8448:8008 \
Copy link

Copilot AI Feb 8, 2026

Choose a reason for hiding this comment

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

This change updates the docker run example to use the default internal port (8008), but the PR description proposes removing all 6167 references. The repo still contains multiple 6167 references in the docker-compose examples and reverse-proxy docs, so either (a) broaden this PR to update those references as well, or (b) narrow/clarify the PR description/scope to just the docker run example to avoid documentation inconsistency for readers switching between docker run and the provided compose files.

Copilot uses AI. Check for mistakes.
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.

1 participant