From fd00212066e813013f7859dd2cd876f82ebf17e9 Mon Sep 17 00:00:00 2001 From: "Giesenberg, Jan" Date: Thu, 25 Nov 2021 11:26:19 +0100 Subject: [PATCH] docs: added more information to readme --- .github/workflows/docker-publish.yml | 2 +- README.md | 15 ++++++++++++++- 2 files changed, 15 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index 34dcd4a..eb05ce8 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -1,4 +1,4 @@ -name: Docker +name: Docker Build on: push: diff --git a/README.md b/README.md index 913027e..769ad10 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,20 @@ # ModX Revolution Docker +![Docker Build](https://github.com/749/docker-modx-revolution/actions/workflows/docker-publish.yml/badge.svg) + A docker setup that can autoupdate ModX Revolution. +*This is a heavily modified version of the FPM variant of [the official Docker Image](https://github.com/modxcms/docker-modx).* + ## Simplified Usage 1. Copy the `.env.example` file to `.env` 2. Run `docker-compose up` -3. The Webserver will now listen on Ports `80` and `443` \ No newline at end of file +3. The Webserver will now listen on Ports `80` and `443` + +## General +The build is completely automated, running every sunday at 00:00/GMT+0. + +It pulls in the latest 2.X version of ModX Revolution, based on the tags on the [Modx Revolution Tags](https://github.com/modxcms/revolution/tags). + +The build produces convenience tags so `2.8.3` is also tagged `2.8` and `2` + +__NOTE__: currently the build does not support building new versions for older minor tags. For Example the current minor is `2.8` and a new patch version commes out for `2.7`. A discussion issue is open at: [#1](https://github.com/749/docker-modx-revolution/issues/1) \ No newline at end of file