From 18d2fe130327beb4bb718c83e1a636403bf067b3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Oliver=20G=C3=BCnther?= Date: Wed, 25 Sep 2024 08:49:49 +0200 Subject: [PATCH] Add documentation and logo for artifacthub.io https://artifacthub.io/packages/container/openproject-community/community --- .github/workflows/docker.yml | 12 ++++++++---- docker/prod/README.md | 30 ++++++++++++++++++++++++++++++ docker/prod/logo.png | Bin 0 -> 3364 bytes 3 files changed, 38 insertions(+), 4 deletions(-) create mode 100644 docker/prod/README.md create mode 100644 docker/prod/logo.png 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 0000000000000000000000000000000000000000..9e5b9caadbfaa4d25e6f7e209d89e8783fd67eaa GIT binary patch literal 3364 zcmai02|Sc*7k@RH#@LCdu9=ivW0@ICm?lifGPZ0@NoFuJCd-I123K~IB_vCQXrb(5 zyOKh4Nzsf;rPQP^S+m^=EvRo)->u(We&6%{-uIm6oc}rh^PJ~>e(#&&X3Zt-eetCVDK6Mz_KtxHIU38 z!C8R;L7^Dd9@Q@hj8I=QBURyFAPoOKsswu{xH&z94Bw@L(m|=3K;dvWHpG{Lakkj^ zEnGO;qw2?C1Y?lM@bGY*a6KJ*2o;GoHa140bdkEc+CqeOXhaZ$#L^B5-TpPn|MFOn zLw!PM!3-Kb2)>q=`_%+Bl>fEt&_~6eP;>^{kAOO0+DMTBw7cB{HHJmjq)#H zYo4!RU)J@N4!f2N<3wYT0}fiy0?9$4!qQC81}N+on!kCz7y3ga;a?+v@ccE>oE|_A zaS0~*kWJ9v$bK;WfL^N`;}}9C3tPI@xHb6SY~S!$y5&WC9%Sp z8Q*OhJu_qS1Y;a4VL^3J>%NCS_N4163zcHE3LDor$&02RKg8Kzgf2$E7mbaHML+HU zlmHMBkcbsQ0pNe1$Wc3Xs(3M9@G=~jHS_d6oWbZieP$+tm}xc#iPI@WlSzlC3Rf3D zEiU(dn0mc;(#2PblrlL@U%7j_IP>ZNEV~OAqq(0iE;m2jjBGbih!E3H=B!JZ_IDSr zU>!{_SZwO&Q6~m>_IdBjTX3z?SKfxjE6b))H3Vl(H_1B+dn#KIv-L*D zm+!aRhV`8^hu~9&_PNsU6fHm#!O9fa~aBMJ|VdF)_^*_7Axb9 zJQqZH63sYnX7wRP=P541X1#Qxg6*XyMlGVjURFL)q2%N<^@+ZLmP;x?$^A~=(SRc5 z$l_Q|q|3ve$$QP!UJIe*E(J<}Dv~=b1DP4?uiR|Ds>p=4YlO?%y`8d0ARKV90ZzWqz7HoZKDl9cQ5A zc=x~`$%_6!*dl1W+H}JihHulA1GR0KIU^0sjpg^7j@pk&cg(j(eLgjcGq_CvRh)Xh zvNh}Gc7N>tV{uKyS(??0o6`8Yy@Z?PyOO=sRkBupts+jmbJRiUB%^@k5BLsJFN^@gwfaPz-Gsso^WvT!K#JIzRiO)z$_K=#=S3jB zdU39~A`pD8gV9?FGs1bX%N0UV!Qh^y0^B!ta5pl*buN|XV?i=`)OF+t#KIyOglV-9=aQ?bXb=eS7N1&u_79s&3<$vI2%>Zr^KehYgWbMr30I(>rO z1GZilj^)Qx2}(m=P!p&H_UcL7j@yLY=BWYw-Zqc%5Atfq3tt+@{buOTt9>!(SGPl; z=I?<7!#!B14;A9Y%I z<^*B2^0qDHH-@J9x3MUF!{vcvkE~p(H3Awt=g&Tnv==DSE6-8R$>dEmjFxXGN43e{ zkgv61<>?V8^x0EXXVd+Mswmm3>__%q^Xa8AkIOoMT2`&>m7~#*;zxQ94=JR8QSX)b zK-lH{&(UGmOa*Vsl5Er5YEy}hld@d9%HnoqL`Em2grIn|0h5;K<~2MVg#&eOhai|u zR!ekVC@-lyp_NO~_HCnbK_LP16tf2L1%1&bg0dE8_VspyGQsh8pYVaI;AVnME>ofE zp;wN=jBvFkwY7C-@5NDMMMNdJ?mdi6r&!jc(kb<(cDM z00%MonY7FPSn2g`&V*J+e(~8?86TY<-D#(Qb*^d~wSIhEnHJVr=S{=vD zg2v^^B`$=OjO(HXH#}BxKy%5HW7g1x5KzfTTvy zFisRDjX9->dB<|(s&cmOjsHq#A*&d3-gK8c?d+b}UbDj&m~maz&$UuHD?P40+%1>v zK4MnbGIkf3+sLKf@|J}1*e!Ba#VJQ3+_9gO!cTbdO_u^9%}3I54O2OO_CHlmWk$YK zsk}$2Uv2aB$hrF=>U90>^l(To-~44rnGvK(vgvg05KOZu$-98y`9s#!OntS2v%f@GgRM z4K=H#b$!L@J#{sZ5RhXyGwI%Xo?C~Dtel=IwtXmxt+CMKN?6FFCr-5u>i4(BgE9<#A?9bX912SJlSBBJCpM zY`sy+=mc->rPp}!FCS~J^o?#4=zb_D#;feuy(}p_4X4w~pRkmCmJOG}l&&>sj;dNq zw7aPB8L4<)TG4%Md2y+to7C&7Noe_{k}yID5V<9}u40)rCyXx-*fk(HZOLvSO;a22@SHnn`H%76v64eH?n_l3?$U~Ky3t6F) za{cQ+K1nZFI$HM&1XMf|)sQoAGWscT##ZTp_pxC4BX^I>hCW=X)6`jf18yQnBzNyT zjBE5Lld4hhQqa5YroB&fUMi^W7c8&gy5T}p9}KUrJ#}!bZKMs9y!E2yQ#6jb~;JH^N|)&ffOOJSWx&7AFdY@Ab7z4 zfaVeCH5qAvhf2$#z2?u?KJ?PcQwh-U(M(GRWV#+zqiR@1dBRs#Ny8UpZ~6Z_#-2}RDLh+e1ii%VW`Ohgu}+t!J=j_ GG5)^|@0o-E literal 0 HcmV?d00001