Skip to content
Permalink
Browse files

Unify master and kzsu branches (#22)

* unified master branch #20

* bumped to version 2.1.0-DEV
  • Loading branch information...
RocketMan committed May 16, 2019
1 parent b4a7fcf commit 524ef9b214a14185f2042ff9de7416cc4ffe1cfa
@@ -9,7 +9,7 @@
1. Fork Zookeeper Online
2. Clone Zookeeper from your fork
3. Create and check out a new branch for your feature or enhancement
4. Edit config/config.php as appropriate
4. Copy config/config.example.php to config/config.php and edit as appropriate
5. Apply and test your changes. Please keep the source code style
as consistent as possible with the existing codebase. Zookeeper
Online uses the [PSR-2 coding style](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)
@@ -57,6 +57,11 @@ The following is an overview of the source code directory structure:

css/
CSS files

custom/
Instance-specific customizations that you wish to keep
separate from the standard installation. For example,
if you have custom controllers, you can put them here.

engine/
Business operations, configuration, and session
@@ -103,7 +108,11 @@ The following is an overview of the source code directory structure:
main endpoint for the application

.htaccess
maps virtual endpoints onto index.php
maps virtual endpoints onto index.php. This file also
contains PHP settings when run via a webserver module.

.user.ini
PHP settings when run via fastCGI


### Guidelines
@@ -19,8 +19,9 @@ https://zookeeper.ibinx.com/master/
2. Create a database and populate it using the scripts in the 'db'
directory (see [Setting up the
Database](#user-content-setting-up-the-database), below);
3. Edit config/config.php file to point to your newly created
database (see [Configuration](#user-content-configuration), below).
3. Copy config/config.example.php to config/config.php, and edit its
db stanza to point to your newly created database (see
[Configuration](#user-content-configuration), below).


### Setting up the Database
@@ -86,7 +87,12 @@ The file config/config.php contains site-specific configuration data,
such as the database name and credentials. Generally, it is the only
file which must be changed as part of the deployment process.

Update the db stanza of config/config.php as follows:
By default config/config.php does not exist; you must create it. An
example file config/config.example.php is provided which you can use
as a template. Simply copy it to config/config.php and change the
settings as desired.

At minimum, you will update the db stanza of config/config.php as follows:

...
'db' => [
@@ -1,4 +1,12 @@
<?php
/*
* This is a sample configuration file for Zookeeper Online that you
* can copy to config.php and customize for your own use.
*
* This sample file configures a radio station 'Example Radio' at 99.9FM.
* The various settings in this file are specific to the example and may
* be changed as appropriate.
*/
$config = [
/**
* name of the application
@@ -8,19 +16,21 @@
/**
* station name
*/
'station' => '9MMM',
'station' => 'Example Radio',
'station_medium' => '9MMM 89.7FM',
'station_medium' => 'Example Radio 99.9FM',
'station_full' => '9MMM Fictitious Radio 89.7 FM',
'station_full' => 'Example Fictitious Radio 99.9 FM',
'station_freq' => '89.7FM',
'station_freq' => '99.9FM',
'copyright' => '&copy; 2002-2018 Fictitious Radio, LTD. All rights reserved.',
'station_slogan' => 'Music with a difference...',
'logo' => 'img/9mmm_banner.png',
'copyright' => '&copy; 2002-2019 Fictitious Radio, LTD. All rights reserved.',
'stylesheet' => 'css/nostyle.css',
'logo' => 'img/example_banner.png',
'stylesheet' => 'css/example_style.css',
/**
* e-mail settings
@@ -50,23 +60,23 @@
* URLs
*/
'urls' => [
'home' => 'https://zookeeper.ibinx.com/master',
'listen' => 'https://zookeeper.ibinx.com/master',
'home' => 'https://www.example.com/',
'listen' => 'https://www.example.com/listen',
],
'contact' => [
'addr' => 'Morgan Park 1',
'city' => 'Westfield, ZQ',
'phone' => '+1 949 555 0899',
'fax' => '+1 949 555 0898',
'request' => '+1 949 555 0897',
'addr' => 'Example Park 1',
'city' => 'Example, ZQ',
'phone' => '+1 949 555 0997',
'fax' => '+1 949 555 0998',
'request' => '+1 949 555 0999',
],
/**
* domains allowed in the Origin header
*/
'allowed_domains' => [
"ibinx.com", "9mmm.fm", "9mmm.org",
"www.example.fm", "www.example.org",
],
/**
@@ -95,6 +105,24 @@
'pass' => '',
],
/**
* custom menu items
*
* menu items here are appended to the defaults
*/
'custom_menu' => [
// [ 'a', 'contact%', 'Contact Example Music', ZK\UI\Example_Contacts::class ],
],
/**
* custom controllers
*
* controllers here override/replace the defaults
*/
'custom_controllers' => [
// 'main' => ZK\UI\Example_UI_Controller::class,
],
/**
* label printer
*/
@@ -165,24 +193,24 @@
'apply_limit_per_dj' => 0,
'weekly_footer' => "\n\n--\n
If you ever want to remove yourself from this mailing list,
visit https://zookeeper.ibinx.com/mailman/listinfo/weekly-charts.\n
visit https://www.example.com/mailman/listinfo/weekly-charts.\n
Here's the general information for the list you've subscribed to,
in case you don't already have it:\n
The weekly-charts mailing list is for the distribution of 9MMM's
music charts. The charts are emailed out approximately once a week. 9MMM's
charts are compiled by tallying each play of every recording in current
rotation (400-450 CDs/LPs/7\"s). Any questions about 9MMM's charts
(philosophic or content-wise) can be directed to music@9mmm.fm.\n",
The weekly-charts mailing list is for the distribution of Example Radio's
music charts. The charts are emailed out approximately once a week. Example
Radio's charts are compiled by tallying each play of every recording in
current rotation (400-450 CDs/LPs/7\"s). Any questions about Example Radio's
charts (philosophic or content-wise) can be directed to music@example.com.\n",
'monthly_footer' => "\n\n--\n
If you ever want to remove yourself from this mailing list,
visit https://zookeeper.ibinx.com/mailman/listinfo/monthly-charts.\n
visit https://www.example.com/mailman/listinfo/monthly-charts.\n
Here's the general information for the list you've subscribed to,
in case you don't already have it:\n
The monthly-charts mailing list is for the distribution of 9MMM's
music charts. The charts are emailed out approximately once a month. 9MMM's
charts are compiled by tallying each play of every recording in current
rotation (400-450 CDs/LPs/7\"s). Any questions about 9MMM's charts
(philosophic or content-wise) can be directed to music@9mmm.fm.\n",
The monthly-charts mailing list is for the distribution of Example Radio's
music charts. The charts are emailed out approximately once a month. Example
Radio's charts are compiled by tallying each play of every recording in
current rotation (400-450 CDs/LPs/7\"s). Any questions about Example Radio's
charts (philosophic or content-wise) can be directed to music@example.com.\n",
],
];

0 comments on commit 524ef9b

Please sign in to comment.
You can’t perform that action at this time.