Are there any docs for this plugin anywhere? about audit-stash HOT 9 CLOSED

Not yet, I haven't got the time for it.

@Adam-Je I am willing to guide you through the process of installing and using this plugin in exchange for help with the docs :)

from audit-stash.

Even just a few paragraphs in the README about what problem it solves and its basic approach would be useful!

from audit-stash.

This plugin is on my todo list for for this weekend so I am willing to make a start with the docs. That is... if @lorenzo will spoonfeed me through the process 😉

from audit-stash.

Hi guys,

Glad you also have the interest. I have absolutely no problem to contribute docs with some guidance. I'm just super tied down right now, probably til weekend after next. So @bravo-kernel please do us the favour. And please make the docs simple for the CakePHP newbies too, I'll contribute with improvements if needed.

Best of luck!

from audit-stash.

@bravo-kernel Thanks! Please ask me any question you need :)

from audit-stash.

@Adam-Je it seems I misunderstood the requirements and will not be able to jump in any time soon so... if you are willing to make a start it would be much appreciated

from audit-stash.

I'm willing to write some basic documentation for this project. Here's what I think I have so far:

1. Use composer to install lorenzo/audit-stash and cakephp/elastic-search
2. Deploy Elasticsearch (or use AWS Elasticsearch Service)
3. Add datasource configuration
4. Use elastic_mapping shell to create mappings in elastic search
5. Using friendsofcake/crud to display logs (install friendsofcake/crud using composer first)

Right now I'm stuck on trying to figure out what the configuration should look like. If you could get me a basic example, I think I can work out the rest pretty quickly.

from audit-stash.

This is the configuration for elastic search. In app.php, the Datasources section:

'auditlog_elastic' => [
            'className' => 'Cake\ElasticSearch\Datasource\Connection',
            'driver' => 'Cake\ElasticSearch\Datasource\Connection',
            'host' => '127.0.0.1',
            'port' => 9200,
            'index' => 'audit-logs',
        ],

You can also have indices per day suing this configuration:

'auditlog_elastic' => [
            'className' => 'Cake\ElasticSearch\Datasource\Connection',
            'driver' => 'Cake\ElasticSearch\Datasource\Connection',
            'host' => '127.0.0.1',
            'port' => 9200,
            'index' => 'audit-logs%s', // Added a %s
        ],

from audit-stash.

I wrote something in the readme, i hope it helps

from audit-stash.