Skip to content

Commit

Permalink
docs: added more information to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Giesenberg, Jan committed Nov 25, 2021
1 parent 9063197 commit fd00212
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/docker-publish.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Docker
name: Docker Build

on:
push:
Expand Down
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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`
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)

0 comments on commit fd00212

Please sign in to comment.