Installation

Installation using the CLI

If you want to use the Journal-Plugin in a sophisticated way - i.e. together with custom made modules like members, students, readers etc. - it's best to install the Journal-Plugin from the command line:

run command

./base/scripts/include-plugin.sh journal

Note: this command is executed from the project’s root directory

If you use the version control system Git, the plugin is automatically registered as a git submodule when running this command.

If you have related models make sure you also run *

./base/scripts/clear-caches.sh
./base/scripts/generate-model.sh

Note: there are short cuts available for these commands if you add some code to your .bash_profile. More info at Quicker-Script-Access

generate-model.sh generates all the methods required for handling data from joined tables like users [members] After code generation, please import the new plugin-related generated sql from generated/data/schema.sql

Manual Installation

Simple installation - for MySQL only and not recommended

• Download the latest Newsletter-Plugin from the download page
• unzip/untar and put the content into your root/plugins dir (create if does not exist)
• Import the sql data from newsletter/data/schema.sql

Proceed to the chapter Configuration and Integration