Skip to content

Commit

Permalink
Add upgrade guide for R47 and update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
daniel-lerch committed Jul 28, 2020
1 parent 15d1844 commit c1490f0
Show file tree
Hide file tree
Showing 5 changed files with 31 additions and 7 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:r46.svg)](https://microbadger.com/images/daniellerch/openkool:r46 "Get your own image badge on microbadger.com")
[![](https://images.microbadger.com/badges/version/daniellerch/openkool:r46.svg)](https://microbadger.com/images/daniellerch/openkool:r46 "Get your own version badge on microbadger.com")
[![](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")

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:r46](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:r47](https://hub.docker.com/r/daniellerch/openkool).

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

Expand Down
Binary file added docs/assets/ko-config.php_r46_r47.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 1 addition & 3 deletions docs/docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,11 @@ version: '2'

services:
app:
image: daniellerch/openkool:r46
image: daniellerch/openkool:r47
restart: unless-stopped
volumes:
- config:/var/www/html/config
- my_images:/var/www/html/my_images
- webfolders:/var/www/html/webfolders
- .webfolders:/var/www/html/.webfolders
db:
image: mariadb:latest
restart: unless-stopped
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 upgrage instructions
# OpenKool upgrade instructions

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

## Prerequisites
- Dockerized OpenKool R46 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:r46` > `daniellerch/openkool:r47`
and remove the `.webfolders` and `webfolders` volumes
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. After that you have to edit the file manually and merge the change (see screenshot).
`docker-compose exec app vi /var/www/html/config/ko-config.php`
![](assets/ko-config.php_r46_r47.png)
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 and with -a to update the database.
`docker-compose exec app bash`
`./install/update.phpsh -a`
5. Stay in your container and run the update script
`php kool_update_r46_r47.php`
6. Your upgrade is finished. You may enable the two new modules `subscription` and `taxonomy` in `ko-config.php` now.

0 comments on commit c1490f0

Please sign in to comment.