From 460e68dbf364c7e2aeb308e342f870a675cdda66 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Thu, 5 Nov 2020 22:24:35 +0100 Subject: [PATCH 1/3] Link Docker and Ubuntu repositories MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit To qualify for the Open Source Project status under the `Docker Open Source Policy` FOLIO as a publisher needs to comply with the `Joint Marketing Programs` requirement: "While the publisher retains the Open Source project status, the Publisher agrees to - * Become a Docker public reference for press releases, blogs, webinars, etc * Create joint blogs, webinars and other marketing content * Create explicit links to their Docker Hub repos, with no ‘wrapping’ or hiding sources of their images * Document that Docker Engine or Docker Desktop are required to run their whitelisted images * Give Docker full attribution" Okapi is the first pinned repository on https://github.com/folio-org The Docker text has been copied from https://dev.folio.org/download/artifacts/ --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index 51a21fd0b..a9f0dac81 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,28 @@ For example: When filing bug reports with unit test output, always use Maven option `-B` to avoid control characters in output. +## Docker image + +At Docker Hub: + +* https://hub.docker.com/u/folioorg/okapi released versions +* https://hub.docker.com/r/folioci/okapi snapshot versions + +See [Automation/Docker +Hub](https://dev.folio.org/guides/automation/#docker-hub) for details. + +Docker images are the primary distribution model for FOLIO modules. +To run the images you will need the Docker Engine or Docker Desktop +runtime. + +## Ubuntu package + +Import the FOLIO signing key and add the [FOLIO apt +repository](https://repository.folio.org/packages/ubuntu/): + + wget --quiet -O - https://repository.folio.org/packages/debian/folio-apt-archive-key.asc | sudo apt-key add - + sudo add-apt-repository "deb https://repository.folio.org/packages/ubuntu/ focal/" + ## Documentation * [Okapi Guide and Reference](doc/guide.md) From e41f757e29a5e007c785913c697cafbc8af59d77 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Fri, 6 Nov 2020 08:21:22 +0100 Subject: [PATCH 2/3] Fix docker hub link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a9f0dac81..567389054 100644 --- a/README.md +++ b/README.md @@ -46,7 +46,7 @@ option `-B` to avoid control characters in output. At Docker Hub: -* https://hub.docker.com/u/folioorg/okapi released versions +* https://hub.docker.com/r/folioorg/okapi released versions * https://hub.docker.com/r/folioci/okapi snapshot versions See [Automation/Docker From 904733641a470e838d24a8095fc7cc7e20379361 Mon Sep 17 00:00:00 2001 From: Julian Ladisch Date: Fri, 6 Nov 2020 12:46:20 +0100 Subject: [PATCH 3/3] Mention 20.04 Focal in the text, replace --quiet by -q --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 567389054..de78c3626 100644 --- a/README.md +++ b/README.md @@ -59,9 +59,10 @@ runtime. ## Ubuntu package Import the FOLIO signing key and add the [FOLIO apt -repository](https://repository.folio.org/packages/ubuntu/): +repository](https://repository.folio.org/packages/ubuntu/) for +Ubuntu 20.04 LTS (Focal Fossa): - wget --quiet -O - https://repository.folio.org/packages/debian/folio-apt-archive-key.asc | sudo apt-key add - + wget -q -O - https://repository.folio.org/packages/debian/folio-apt-archive-key.asc | sudo apt-key add - sudo add-apt-repository "deb https://repository.folio.org/packages/ubuntu/ focal/" ## Documentation