# BBClone Plugin for CMSimple

## Introduction Back to top

BBClone is a PHP based web counter. This plugin integrates BBClone into CMSimple.

Consider donating to support this plugin.

## Version Back to top

This is currently version 1.0.2 of the plugin, released Februrary 16th 2018.

## Requirements Back to top

### Supported CMSimple versions Back to top

- CMSimple XH 1.5 or higher (recommended)
- CMSimple XH 1.4.2
- CMSimple XH 1.1.4
- CMSimple Realblog 1.5 or higher
- CMSimple LE 3.4(.1) (Pluginloader needed, see installation guide below)
- CMSimple 3.3 (Pluginloader needed, see installation guide below)
- CMSimple 4.7.3

## Installation Back to top

Note that in CMSimple 4.7 or later, the CRSF protection needs to be disabled in order change configuration options. This means setting `$cf['use']['csrf_protection']="false";` in `cmsimple/config.php`.

### CMSimple XH Back to top

- Download the plugin.
- Copy the `bbclone` folder into the CMSimple root.
- In the `plugins` folder, create a new folder called `bbclone`.
- Copy the plugin files into the created folder.

### CMSimple 3.3 and CMSimple LE Back to top

This installation guide is left from older versions. This version does not support CMSimple LE and the original CMSimple, see supported CMSimple versions.

The images are taken in CMSimple 3.3, but should help installing the plugin in CMSimple LE, too.

- Download a working Pluginloader, see CMSimple Wiki: Pluginloader or the CMSimple Forum to get the current version.
- Create a folder named 'plugins' in the CMSimple root directory.
- Extract the pluginloader into this directory. You will have plugins/index.php and plugins/pluginloader.
- Edit cmsimple/config.php and add:

    $cf['plugins']['folder'] = "plugins";

- Go in your CMSimple backend, choose 'Settings' and edit configuration:

- Look for the plugins_folder configuration key:

- Copy the `bbclone folder into the CMSimple root.`
- In the `plugins` folder, create a new folder called `bbclone`.
- Copy the plugin files into the created folder.

## Access Control for BBClone Back to top

BBClone does not offer access control; this means, given the link, everybody can view the statistics and the configuration. To prevent this, the easiest solution is to setup a `.htaccess` file.

The `.htaccess` file might look as follows:

    AuthType Basic
    AuthName "BBClone"
    AuthUserFile /opt/lampp/htdocs/.htpasswd
    Require valid-user

The corresponding `.htpasswd` file might look like:

    david:$apr1$9ecnbHA9$M.Qg.7PC3UZwDT5NUHv1K/

Which corresponds to a user "david" with password "test". User/password generators can be found online, for example this one.

Also note that the path to the `.htpasswd` file varies across providers and setups.

## Configuration Back to top

### Configuration options Back to top

There is only one configuration option:

- track_backend: Set to 'true' if the web counter should track the backend as well, 'false' if not.

### The configuration file Back to top

    /**
     * @file config.php
     * @brief Containing configuration of the plugin.
     */

    	/**
    	 * If backend activity should be tracked by BBClone.
    	 * @var <string>
    	 */
    	$plugin_cf['bbclone']['track_backend']="false";

### BBClone configuration Back to top

BBClone as configurable using the `bbclone/conf/config.php` file contained within the bbclone folder in the CMSimple root.

## Usage Back to top

Simply go to "Plugins" > "BBClone" and select "Statistics". Using the "Go to statistics" button you can view BBClone's backend including all provided statistics.

## Changelog Back to top

## License Back to top

### Plugin's license Back to top

Copyright 2014 - 2018 David Stutz

The plugin is published under the GNU Public License Version 3. For more information see: GNU Licenses

The plugin is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The plugin is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

### BBClone Back to top

See here for license information.