WIP: feat(docker)!: Add ENTRYPOINT declaration #1485

Draft
Jade wants to merge 2 commits from jade/docker-entrypoint into main
Owner

means that you don't have to specify conduwuit in docker image runs, should make some docs more accurate

Pull request checklist:

  • This pull request targets the main branch, and the branch is named something other than
    main.
  • I have written an appropriate pull request title and my description is clear.
  • I understand I am responsible for the contents of this pull request.
  • I have followed the contributing guidelines:
means that you don't have to specify conduwuit in docker image runs, should make some docs more accurate <!-- In order to help reviewers know what your pull request does at a glance, you should ensure that 1. Your PR title is a short, single sentence describing what you changed 2. You have described in more detail what you have changed, why you have changed it, what the intended effect is, and why you think this will be beneficial to the project. If you have made any potentially strange/questionable design choices, but didn't feel they'd benefit from code comments, please don't mention them here - after opening your pull request, go to "files changed", and click on the "+" symbol in the line number gutter, and attach comments to the lines that you think would benefit from some clarification. --> <!-- Example: This pull request allows us to warp through time and space ten times faster than before by double-inverting the warp drive with hyperheated jump fluid, both making the drive faster and more efficient. This resolves the common issue where we have to wait more than 10 milliseconds to engage, use, and disengage the warp drive when travelling between galaxies. --> <!-- Closes: #... --> <!-- Fixes: #... --> <!-- Uncomment the above line(s) if your pull request fixes an issue or closes another pull request by superseding it. Replace `#...` with the issue/pr number, such as `#123`. --> **Pull request checklist:** <!-- You need to complete these before your PR can be considered. If you aren't sure about some, feel free to ask for clarification in #dev:continuwuity.org. --> - [x] This pull request targets the `main` branch, and the branch is named something other than `main`. - [x] I have written an appropriate pull request title and my description is clear. - [x] I understand I am responsible for the contents of this pull request. - I have followed the [contributing guidelines][c1]: - [x] My contribution follows the [code style][c2], if applicable. - [x] I ran [pre-commit checks][c1pc] before opening/drafting this pull request. - [x] I have [tested my contribution][c1t] (or proof-read it for documentation-only changes) myself, if applicable. This includes ensuring code compiles. - [x] My commit messages follow the [commit message format][c1cm] and are descriptive. - [x] I have written a [news fragment][n1] for this PR, if applicable<!--(can be done after hitting open!)-->. <!-- Notes on these requirements: - While not required, we encourage you to sign your commits with GPG or SSH to attest the authenticity of your changes. - While we allow LLM-assisted contributions, we do not appreciate contributions that are low quality, which is typical of machine-generated contributions that have not had a lot of love and care from a human. Please do not open a PR if all you have done is asked ChatGPT to tidy up the codebase with a +-100,000 diff. - In the case of code style violations, reviewers may leave review comments/change requests indicating what the ideal change would look like. For example, a reviewer may suggest you lower a log level, or use `match` instead of `if/else` etc. - In the case of code style violations, pre-commit check failures, minor things like typos/spelling errors, and in some cases commit format violations, reviewers may modify your branch directly, typically by making changes and adding a commit. Particularly in the latter case, a reviewer may rebase your commits to squash "spammy" ones (like "fix", "fix", "actually fix"), and reword commit messages that don't satisfy the format. - Pull requests MUST pass the `Checks` CI workflows to be capable of being merged. This can only be bypassed in exceptional circumstances. If your CI flakes, let us know in matrix:r/dev:continuwuity.org. - Pull requests have to be based on the latest `main` commit before being merged. If the main branch changes while you're making your changes, you should make sure you rebase on main before opening a PR. Your branch will be rebased on main before it is merged if it has fallen behind. - We typically only do fast-forward merges, so your entire commit log will be included. Once in main, it's difficult to get out cleanly, so put on your best dress, smile for the cameras! --> [c1]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md [c2]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/docs/development/code_style.mdx [c1pc]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#pre-commit-checks [c1t]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#running-tests-locally [c1cm]: https://forgejo.ellis.link/continuwuation/continuwuity/src/branch/main/CONTRIBUTING.md#commit-messages [n1]: https://towncrier.readthedocs.io/en/stable/tutorial.html#creating-news-fragments
(means that you don't have to specify conduwuit in docker image runs)
docs: Changelog
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Successful in 3m51s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
986ab7d051
Jade requested review from Owners 2026-03-03 20:09:33 +00:00
Beanie left a comment
First-time contributor

This is a big breaking change. Because existing deployments likely have their compose files or Kubernetes manifests set up to explicitly call the binary, especially if they are adding custom arguments, abruptly adding this entrypoint will break Continuwuity for many production environments.

We should consider building backwards compatibility directly into continuwuity, handling if the first argument passed to it is the binary path (e.g., /sbin/conduwuit) or the named binary, the application handles it gracefully instead of crashing due to an unrecognized command.

Couple that with a clear deprecation warning message, suggesting it should be removed from their configurations before the v0.6 release (suggestion)

This is a big breaking change. Because existing deployments likely have their compose files or Kubernetes manifests set up to explicitly call the binary, especially if they are adding custom arguments, abruptly adding this entrypoint will break Continuwuity for many production environments. We should consider building backwards compatibility directly into continuwuity, handling if the first argument passed to it is the binary path (e.g., `/sbin/conduwuit`) or the named binary, the application handles it gracefully instead of crashing due to an unrecognized command. Couple that with a clear deprecation warning message, suggesting it should be removed from their configurations before the `v0.6` release (suggestion)
@ -282,3 +282,4 @@
EXPOSE 8008
ENTRYPOINT [ "/sbin/conduwuit" ]
CMD ["/sbin/conduwuit"]
First-time contributor

CMD instruction should be removed. As currently written, the container will execute /sbin/conduwuit /sbin/conduwuit, which will cause the application to fail upon startup. This should be changed to default arguments, of which there aren't any for container environment specifically

`CMD` instruction should be removed. As currently written, the container will execute `/sbin/conduwuit /sbin/conduwuit`, which will cause the application to fail upon startup. ~~This should be changed to default arguments, of which there aren't any for container environment specifically~~
Author
Owner

Good point. I'll save this till I get time to implement that, then

Good point. I'll save this till I get time to implement that, then
Jade changed title from feat(docker)!: Add ENTRYPOINT declaration to WIP: feat(docker)!: Add ENTRYPOINT declaration 2026-03-03 20:26:00 +00:00
@ -282,3 +282,4 @@
EXPOSE 8008
ENTRYPOINT [ "/sbin/conduwuit" ]
CMD ["/sbin/conduwuit"]
Contributor

If you have an ENTRYPOINT in the Dockerfile, then any CMD will be passed as arguments to the entrypoint. So in this case, CMD should be removed.

If you have an ENTRYPOINT in the Dockerfile, then any CMD will be passed as arguments to the entrypoint. So in this case, CMD should be removed.
Some checks failed
Documentation / Build and Deploy Documentation (pull_request) Successful in 3m51s
Checks / Prek / Clippy and Cargo Tests (pull_request) Has been cancelled
Required
Details
Checks / Prek / Pre-commit & Formatting (pull_request) Has been cancelled
Required
Details
This pull request is marked as a work in progress.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u origin jade/docker-entrypoint:jade/docker-entrypoint
git switch jade/docker-entrypoint
Sign in to join this conversation.
No reviewers
continuwuation/Owners
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
continuwuation/continuwuity!1485
No description provided.