diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml index 3db90e894c3..cd9a80911cd 100644 --- a/.github/workflows/docker.yml +++ b/.github/workflows/docker.yml @@ -174,8 +174,10 @@ jobs: with: context: git labels: | - io.artifacthub.package.readme-url=https://www.openproject.org/docs/installation-and-operations/installation/docker/ - org.opencontainers.image.documentation=https://www.openproject.org/docs/ + io.artifacthub.package.readme-url=https://raw.githubusercontent.com/opf/openproject/refs/heads/dev/docker/prod/REAMDE.md + io.artifacthub.package.logo-url=https://raw.githubusercontent.com/opf/openproject/refs/heads/dev/docker/prod/logo.png + org.opencontainers.image.source=https://github.com/opf/openproject + org.opencontainers.image.documentation=https://www.openproject.org/docs/installation-and-operations/installation/ org.opencontainers.image.vendor=OpenProject GmbH tags: | type=semver,pattern={{version}},value=${{ needs.setup.outputs.version }} @@ -272,8 +274,10 @@ jobs: with: images: ${{ env.REGISTRY_IMAGE }} labels: | - io.artifacthub.package.readme-url=https://www.openproject.org/docs/installation-and-operations/installation/docker/ - org.opencontainers.image.documentation=https://www.openproject.org/docs/ + io.artifacthub.package.readme-url=https://raw.githubusercontent.com/opf/openproject/refs/heads/dev/docker/prod/REAMDE.md + io.artifacthub.package.logo-url=https://raw.githubusercontent.com/opf/openproject/refs/heads/dev/docker/prod/logo.png + org.opencontainers.image.source=https://github.com/opf/openproject + org.opencontainers.image.documentation=https://www.openproject.org/docs/installation-and-operations/installation/ org.opencontainers.image.vendor=OpenProject GmbH flavor: | latest=false diff --git a/docker/prod/README.md b/docker/prod/README.md new file mode 100644 index 00000000000..f01cb330587 --- /dev/null +++ b/docker/prod/README.md @@ -0,0 +1,30 @@ +# OpenProject Docker images + +OpenProject publishes docker images in two varieties: + +- `dev-slim, MAJOR-slim, MAJOR.MINOR-slim, MAJOR.MINOR.PATCH-slim` for the application container to be used with an external database, proxy. For use in [Docker compose](https://www.openproject.org/docs/installation-and-operations/installation/docker-compose/), [Kubernetes and Helm charts](https://www.openproject.org/docs/installation-and-operations/installation/helm-chart/) installations +- `dev, MAJOR, MAJOR.MINOR, MAJOR.MINOR.PATCH` for the [all-in-one container](https://www.openproject.org/docs/installation-and-operations/installation/docker/). This is meant as a quick start to get OpenProject up-and-running. We recommend to use the slim container for production systems. + + + +## Docker Hub + +All images are being published on Docker Hub. For more information on the available versions, please see https://hub.docker.com/r/openproject/openproject/tags. + + + +## Installation guides + +Please see our upstream documentation guides for installing OpenProject using Docker containers: + +- [**Installation with Docker Compose (recommended)**](https://www.openproject.org/docs/installation-and-operations/installation/docker-compose/): Guide for setting up OpenProject in an isolated manner using Docker Compose +- [**Installation with single Docker container**](https://www.openproject.org/docs/installation-and-operations/installation/docker/): How to setup OpenProject as a single Docker container +- [**Installation with Helm charts (recommended for Kubernetes)**](https://www.openproject.org/docs/installation-and-operations/installation/helm-chart): Set up OpenProject using Helm charts + +OpenProject also provides other means of installation. Please see https://www.openproject.org/docs/installation-and-operations/installation/ for the full reference. + + + +## User guides + +For all information related to using OpenProject, please see our user documentation at https://www.openproject.org/docs/ diff --git a/docker/prod/logo.png b/docker/prod/logo.png new file mode 100644 index 00000000000..9e5b9caadbf Binary files /dev/null and b/docker/prod/logo.png differ