graham-campbell/cms-logviewer

CMS LogViewer Is A CMS Core Plugin That Adds A LogViewer Admin Module

CMS LogViewer

, _(*1)

WARNING

This package has been replaced, and is no longer maintained.

What Is CMS LogViewer?

CMS LogViewer is a CMS Core plugin that adds a LogViewer admin module., _(*2)

• CMS LogViewer was created by, and is maintained by Graham Campbell.
• CMS LogViewer is heavily based on Mike Mand's LogViewer.
• CMS LogViewer relies on my CMS Core package.
• CMS LogViewer uses Travis CI with Coveralls to check everything is working.
• CMS LogViewer uses Scrutinizer CI and SensioLabsInsight to run additional checks.
• CMS LogViewer uses Composer to load and manage dependencies.
• CMS LogViewer provides a change log, releases, and api docs.
• CMS LogViewer is licensed under the GNU AGPLv3, available here.

System Requirements

• PHP 5.4.7+ or PHP 5.5+ is required.
• You will need a CMS Core application like Bootstrap CMS because this package is designed for it.
• You will need Composer installed to load the dependencies of CMS-LogViewer.

Installation

Please check the system requirements before installing CMS LogViewer., _(*3)

To get the latest version of CMS LogViewer, simply require "graham-campbell/cms-logviewer": "0.2.*@alpha" in your composer.json file. You'll then need to run composer install or composer update to download it and have the autoloader updated., _(*4)

You will need to register many service providers before you attempt to load the CMS LogViewer service provider. Open up app/config/app.php and add the following to the providers key., _(*5)

• 'Lightgear\Asset\AssetServiceProvider'
• 'Cartalyst\Sentry\SentryServiceProvider'
• 'GrahamCampbell\Core\CoreServiceProvider'
• 'GrahamCampbell\Viewer\ViewerServiceProvider'
• 'GrahamCampbell\Queuing\QueuingServiceProvider'
• 'GrahamCampbell\HTMLMin\HTMLMinServiceProvider'
• 'GrahamCampbell\Markdown\MarkdownServiceProvider'
• 'GrahamCampbell\Security\SecurityServiceProvider'
• 'GrahamCampbell\Binput\BinputServiceProvider'
• 'GrahamCampbell\Passwd\PasswdServiceProvider'
• 'GrahamCampbell\Throttle\ThrottleServiceProvider'
• 'GrahamCampbell\Credentials\CredentialsServiceProvider'
• 'GrahamCampbell\Navigation\NavigationServiceProvider'
• 'GrahamCampbell\CMSCore\CMSCoreServiceProvider'

Once CMS LogViewer is installed, you need to register the service provider. Open up app/config/app.php and add the following to the providers key., _(*6)

• 'GrahamCampbell\CMSLogViewer\CMSLogViewerServiceProvider'

Configuration

CMS LogViewer supports optional configuration., _(*7)

To get started, first publish the package config file:, _(*8)

php artisan config:publish graham-campbell/cms-logviewer

There are two config options:, _(*9)

Log Directories, _(*10)

This option ('log_dirs') defines the paths to the log directories. The default value for this setting is array('app' => storage_path().'/logs')., _(*11)

Logs Per Page, _(*12)

This option ('per_page') defines how many log entries are displayed per page. The default value for this setting is 20., _(*13)

Usage

There is currently no usage documentation besides the API Documentation for CMS LogViewer., _(*14)

Note that Bootstrap CMS already ships with CMS LogViewer., _(*15)

Updating Your Fork

The latest and greatest source can be found on GitHub., _(*16)

Before submitting a pull request, you should ensure that your fork is up to date., _(*17)

You may fork CMS LogViewer:, _(*18)

git remote add upstream git://github.com/GrahamCampbell/CMS-LogViewer.git

The first command is only necessary the first time. If you have issues merging, you will need to get a merge tool such as P4Merge., _(*19)

You can then update the branch:, _(*20)

git pull --rebase upstream master
git push --force origin <branch_name>

Once it is set up, run git mergetool. Once all conflicts are fixed, run git rebase --continue, and git push --force origin <branch_name>., _(*21)

Pull Requests

Please review these guidelines before submitting any pull requests., _(*22)

• When submitting bug fixes, check if a maintenance branch exists for an older series, then pull against that older branch if the bug is present in it.
• Before sending a pull request for a new feature, you should first create an issue with [Proposal] in the title.
• Please follow the PSR-2 Coding Style and PHP-FIG Naming Conventions.

License

GNU AFFERO GENERAL PUBLIC LICENSE, _(*23)

CMS LogViewer Is A CMS Core Plugin That Adds A LogViewer Admin Module Copyright (C) 2013-2014 Graham Campbell, _(*24)

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

This program 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 Affero General Public License for more details., _(*26)

You should have received a copy of the GNU Affero General Public License along with this program. If not, see http://www.gnu.org/licenses/., _(*27)