Skip to content

Commit

Permalink
Add upgrade guide for R48 and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-lerch committed Aug 20, 2020
1 parent 2a207db commit 7eeac40
Show file tree
Hide file tree
Showing 6 changed files with 28 additions and 138 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# OpenKool

[![](https://images.microbadger.com/badges/image/daniellerch/openkool:r47.svg)](https://microbadger.com/images/daniellerch/openkool:r47 "Get your own image badge on microbadger.com")
[![](https://images.microbadger.com/badges/version/daniellerch/openkool:r47.svg)](https://microbadger.com/images/daniellerch/openkool:r47 "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/daniellerch/openkool:r48.svg)](https://microbadger.com/images/daniellerch/openkool:r48 "Get your own image badge on microbadger.com")
[![](https://images.microbadger.com/badges/version/daniellerch/openkool:r48.svg)](https://microbadger.com/images/daniellerch/openkool:r48 "Get your own version badge on microbadger.com")

This application is a dockerized version of kOOL form [churchtool.org](http://www.churchtool.org).

kOOL is the most advanced open source church organization software which is currently available.
Unfortunately, kOOL is built on old software and never had a good architecture. Improving this, however, would result in thousands of merge conflicts for every new upstream version. That is why OpenKool just aims to keep kOOL operational for next the years until there are better alternatives available.

## Installation
The recommended deployment option for OpenKool is to use Docker containers. An official image is available at [daniellerch/openkool:r47](https://hub.docker.com/r/daniellerch/openkool).
The recommended deployment option for OpenKool is to use Docker containers. An official image is available at [daniellerch/openkool:r48](https://hub.docker.com/r/daniellerch/openkool).

For a detailed installation guide please refer to the `docs` folder.

Expand Down
132 changes: 0 additions & 132 deletions docs/INSTALL.txt

This file was deleted.

2 changes: 1 addition & 1 deletion docs/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: '2'

services:
app:
image: daniellerch/openkool:r47
image: daniellerch/openkool:r48
restart: unless-stopped
volumes:
- config:/var/www/html/config
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-r45-to-r46.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenKool upgrade instructions
# OpenKool R46 upgrade instructions

## Prerequisites
- Dockerized OpenKool R45 installation
Expand Down
2 changes: 1 addition & 1 deletion docs/upgrade-r46-to-r47.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# OpenKool upgrade instructions
# OpenKool R47 upgrade instructions

## Prerequisites
- Dockerized OpenKool R46 installation
Expand Down
22 changes: 22 additions & 0 deletions docs/upgrade-r47-to-r48.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# OpenKool R48 upgrade instructions

## Prerequisites
- Dockerized OpenKool R47 installation
- Backup of config files (might get overridden)
- MySQL database backup (no downgrade path)

## Steps
1. Change the image name in your compose file
`daniellerch/openkool:r47` > `daniellerch/openkool:r48`
2. Pull image and restart
`docker-compose up -d`
3. Run the setup script
A) `docker-compose exec app bash /var/www/html/install/setup.sh`
You reject overriding ko-config.php and other modified config files. Manual changes to ko-config.php are not required this time.
B) `docker-compose exec app bash /var/www/html/install/setup.sh --force`
The script will override your config files and you have to run the web installer again (see [install.md](install.md)).
4. Call install/update.phpsh from your web root with parameter -p to show changes, with -a to update the database and with -s to run update scripts.
`docker-compose exec app bash`
`./install/update.phpsh -a`
`./install/update.phpsh -s`
6. Your upgrade is finished. You may enable the new module `telegram` in `ko-config.php` now.

0 comments on commit 7eeac40

Please sign in to comment.