Official Docker Image

[mikecardwell]

I noticed you have a github workflow for publishing to PyPI. I wonder if you could extend it, or create a new workflow for publishing an official image to Docker Hub too?

[pbiering]

Sorry, no plan to for a docker image. PyPI only contain Radicale itself, while a docker image would have to contain all required Python modules and potentially even Python itself.

Reasons at least lack of resources to maintain such and to support expected additional related upcoming issues. May change once an additional co-maintainer appears and focus on that.

[gentooboontoo]

@pbiering sorry for the delay, I completely missed the notifications. The package should be public right now.

Thank you for the PR @kalsi-avneet. You have been added as a maintainer to help ensure long-term support for the Docker image.

[kalsi-avneet]

@gentooboontoo , thank you for your support.

@pbiering , I will resume the other tasks in this activity now.

[kalsi-avneet]

From the listed future tasks in #1745 (reply in thread)

Add support for other architectures (e.g. arm64)

I have created this PR: #1787

It adds support for arm64. Other architectures can be added later if needed.

It is a draft PR. I will remove the draft status once I confirm the new docker image generated by the nightly trigger in my forked copy of this repo.

[pbiering]

oh sorry, I merged it already...please mark next time the PR itself explicitly by DRAFT prefix in title

[kalsi-avneet]

oh sorry, I merged it already...

Thank you for merging.

please mark next time the PR itself explicitly by DRAFT prefix in title

Sure, I will use the DRAFT prefix from next time

[mikecardwell]

FYI I have now set up a gitlab repo which automatically checks for new updates to Radicale once a day and if there is a new release it builds an image from your Dockerfile and pushes it to Docker Hub:

https://gitlab.com/grepular/docker-radicale/

https://hub.docker.com/r/grepular/radicale

[pbiering]

Thank you, feel free to add a Wiki page how to use it and refer to it on the main Wiki page below topic "Radicale Installation"

[josh1703658784]

Another alternative, which I recently discovered, is to build the image inline with Compose or docker build. Likely not ideal for real use but for home deployments it does fine.

  radicale:
    build: github.com/Kozea/Radicale#master
    ...

[mikecardwell]

I added to the wiki at https://github.com/Kozea/Radicale/wiki/Installing-on-Docker - Included instructions for using docker-compose build.

[kiler129]

It may be good to also add to https://radicale.org/v3.html

[kalsi-avneet]

Thank you for the suggestion.
I will add it to the list of my tasks for this activity..

@pbiering , i understand that
https://radicale.org/v3.html is generated from DOCUMENTATION.md. May I modify this file to include docker image documentation ?

[pbiering]

You can open a PR against this file in master branch, details should be documented in Wiki.

[kalsi-avneet]

Thank you for the reply. I will do it as you suggested.

[kalsi-avneet]

Created #1828 for this.

[Daniel-Leer]

Would it be possible to also include an ldap build or to also pack this into the image ? When I tried to get this image working with my setup I got warnings and error about missing ldap packages. So I had to adjust the lines in the Dockerfile and rebuild the image locally.

[kalsi-avneet]

Thank you for the suggestion.
I will add it to the list of my tasks for this activity.

[mikecardwell]

FYI, I've added ldap to the unofficial one on Dockerhub

[Daniel-Leer]

Cheers, thanks for the quick response. I noticed that I have to build this image by myself anyway... As I have this instance running on a pi. Any chance of including the linux/arm64(v8) platform ?

[mikecardwell]

Done. Latest version has a multi-arch build, linux/amd64+linux/arm64. Future versions will too, automatically

[kalsi-avneet]

Would it be possible to also include an ldap build or to also pack this into the image ? When I tried to get this image working with my setup I got warnings and error about missing ldap packages. So I had to adjust the lines in the Dockerfile and rebuild the image locally.

Thank you for the suggestion.
I will add it to the list of my tasks for this activity.

Created PR #1797

[pbiering]

@kalsi-avneet - would it be possible to define a job cleaning up nightly builds older than e.g. 30 days on regular basis?

[pbiering]

PR merged, let's wait for the scheduled run this night.

[pbiering]

@kalsi-avneet - something did not work, please analyze https://github.com/Kozea/Radicale/actions/runs/19020627334/job/54315152992#step:3:25

[kalsi-avneet]

Sorry, missed to export an environment variable. 🤦

I will confirm on a temporary branch and push a PR now.

[kalsi-avneet]

I will confirm on a temporary branch and push a PR now.

Made the above change and some more improvements.

PR: #1909

Deleted temporary branch.

Workflow logs:

1. https://github.com/Kozea/Radicale/actions/runs/19038210798/job/54368037312
2. https://github.com/Kozea/Radicale/actions/runs/19041565466/job/54379900957

All images older than 30 days have been deleted by the above 2 runs
URL: https://github.com/Kozea/Radicale/pkgs/container/radicale/versions?filters%5Bversion_type%5D=tagged

I will keep watching the workflow for a few days for any errors.

[pbiering]

Cleanup run is now working: https://github.com/Kozea/Radicale/pkgs/container/radicale/versions?filters%5Bversion_type%5D=tagged

[pbiering]

Can you also create a cleanup job for the untagged ones, e.g. older than 15 days?
https://github.com/Kozea/Radicale/pkgs/container/radicale/versions?filters[version_type]=untagged

[kalsi-avneet]

Hi @gentooboontoo ,

I have also set the DOCKERHUB_ORGNAME variable (note the ORG rather than USER) and the DOCKERHUB_TOKEN secret in the GitHub repository. The workflow will therefore use:

username: ${{ vars.DOCKERHUB_ORGNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}

If you try, tell me if you have any problem with the current setup.

It seems the token might have insufficient scope.

I have tried logging in to dockerhub using the username and password as suggested. Login works, but docker pull fails after that.

To confirm it, I have modified the yml to perform the following steps:

1. docker pull
2. docker login
3. docker pull again

Step 1 and 2 succeed, but step 3 fails with this err message:

Error response from daemon: Head "https://registry-1.docker.io/v2/library/alpine/manifests/latest": unauthorized: access token has insufficient scopes

Here is the link to the modified yml file: https://github.com/Kozea/Radicale/blob/8246f7d0c0b3f8929616e3ebd67eb72c1b538d2b/.github/workflows/docker-publish.yml

Request you to please re-generate and update the tokens in the repository secrets.
The workflow " Build and publish Docker image" can be triggered again on branch trial/push-to-dockerhub to confirm the token

[gentooboontoo]

Hi @kalsi-avneet. Sorry for the delay. I have updated the permissions of the existing token (Read public repositories was not checked).

Could you retry and tell me if it works?

[kalsi-avneet]

Hi @gentooboontoo ,

Thank you for the modification.

(Read public repositories was not checked).

Could you retry and tell me if it works?

I re-ran the workflow action and confirmed that it is working.

Executed action: https://github.com/Kozea/Radicale/actions/runs/20871719682/job/59974402200

I will proceed further now.

[kalsi-avneet]

I will proceed further now.

As a trial, I modified the workflow yaml file and ran a workflow dispatch for the "Build and publish docker image" action. It succeeded in pushing the image to dockerhub.

Details:

• Commit: 05e95eb
• Workflow run: https://github.com/Kozea/Radicale/actions/runs/21334407778/job/61404039441
• Dockerhub image: https://hub.docker.com/layers/kozea/radicale/workflow_dispatch-trial-push-to-dockerhub-05e95eb/images/sha256-723210b4203ba0a690e61c5077f7496c09b27f63c6b58156b06d4e598738fac7

I will now cleanup the yaml file and create a PR.

[kalsi-avneet]

I will now cleanup the yaml file and create a PR.

Created PR: #1976

I have also updated the description, overview and icon in dockerhub :

• Description and overview have been copied from this repository
• icon was copied from radicale/web/internal_data/css/logo.svg and converted to png :

  $ convert -background none logo.svg logo.png
  

@gentooboontoo , request you to review if the above changes in dockerhub are ok.

After the PR #1976 is merged, images will be pushed to dockerhub as well. Next I will work on cleanup of the nightly images in dockerhub.

Please let me know if any further change is required.

[xduugu]

Thanks a lot for your efforts to provide an official container image.

What prevents me from using it is the lack of a "stable" tag name that refers to the latest stable version. It would be great if you could add the major and minor versions as tags to the images. For example, the tags 3 and 3.5 should refer to the latest version of the major branch 3 and the minor branch 3.5, respectively.

Something like this should work:

tags: |
    type=semver,pattern={{version}}
    type=semver,pattern={{major}}.{{minor}}
    type=semver,pattern={{major}}

By the way, latest usually refers to the latest stable version. Perhaps you could use a nightly tag for the nightlies instead.

I think removing

flavor: latest=true

and adding

tags: |
    type=schedule,pattern=nightly

would work.

[G-Huber]

Seconded.

Came here to ask for a "latest stable" tag too.

[kalsi-avneet]

@xduugu , @G-Huber ,

Thank you for the suggestions. I will implement them soon.

[kalsi-avneet]

I will implement them soon.

Implemented the changes in #1944

From the next release, the following tags should be available:

1. Major
2. Major.Minor
3. Major.Minor.Patch (Version)
4. stable - This will always point to the latest stable build.

I have kept latest as-is to always correspond to the latest docker build.

[xduugu]

Thanks a lot, @kalsi-avneet, I switched to your image with the 3.6.0 release. Unfortunately, it took me several days to notice that my storage hook did not work anymore, because git is not installed in the image. I created #1967 which fixes this remaining issue for me.

[kalsi-avneet]

A compose file and documentation has been added to the repository via #1950

• Compose file: compose.yaml
• Documentation: DOCUMENTATION.md | https://radicale.org/master.html#docker

[kalsi-avneet]

@pbiering , may I also update the wiki at https://github.com/Kozea/Radicale/wiki/Installing-on-Docker#official-image ?

[pbiering]

@pbiering , may I also update the wiki at https://github.com/Kozea/Radicale/wiki/Installing-on-Docker#official-image ?

for sure!

[kalsi-avneet]

@pbiering , may I also update the wiki at https://github.com/Kozea/Radicale/wiki/Installing-on-Docker#official-image ?

for sure!

Thank you for confirming. I will update it.