Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/damienharper/auditor-bundle
The missing audit log library
https://github.com/damienharper/auditor-bundle
audit audit-bundle audit-entries audit-log audit-table audit-trail audited-entities auditor-bundle doctrine doctrine-audit doctrine-audit-bundle doctrine-orm-database doctrine2 orm symfony symfony-bundle
Last synced: 6 days ago
JSON representation
The missing audit log library
- Host: GitHub
- URL: https://github.com/damienharper/auditor-bundle
- Owner: DamienHarper
- License: mit
- Created: 2018-01-12T14:29:02.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-23T04:56:39.000Z (12 days ago)
- Last Synced: 2024-09-29T16:21:48.327Z (6 days ago)
- Topics: audit, audit-bundle, audit-entries, audit-log, audit-table, audit-trail, audited-entities, auditor-bundle, doctrine, doctrine-audit, doctrine-audit-bundle, doctrine-orm-database, doctrine2, orm, symfony, symfony-bundle
- Language: Twig
- Homepage:
- Size: 1.53 MB
- Stars: 386
- Watchers: 17
- Forks: 121
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# auditor-bundle [](https://twitter.com/intent/tweet?text=Create%20audit%20logs%20for%20all%20Doctrine%20ORM%20database%20related%20changes%20with%20auditor-bundle.&url=https://github.com/DamienHarper/auditor-bundle&hashtags=auditor-bundle)
[](https://packagist.org/packages/damienharper/auditor-bundle)
[](https://packagist.org/packages/damienharper/auditor-bundle)
[](https://github.com/DamienHarper/auditor-bundle/actions/workflows/ci-6.x.yml)
[](https://packagist.org/packages/damienharper/auditor-bundle)
[](https://scrutinizer-ci.com/g/DamienHarper/auditor-bundle/?branch=master)
[](https://app.codecov.io/gh/DamienHarper/auditor-bundle/branch/master)
[](https://packagist.org/packages/damienharper/auditor-bundle)
[](https://packagist.org/packages/damienharper/auditor-bundle)
[](https://packagist.org/packages/damienharper/auditor-bundle)
`auditor-bundle`, formerly known as `DoctrineAuditBundle` integrates `auditor` library into any Symfony 3.4+ application.
## Demo
You can try out this bundle by cloning its companion demo app.
Follow instructions at [auditor-bundle-demo](https://github.com/DamienHarper/auditor-bundle-demo).
## Official Documentation
`auditor-bundle` official documentation can be found [here](https://damienharper.github.io/auditor-docs/docs/auditor-bundle/index.html).
## Version Information
| Version | Status | Requirements | Badges |
|:--------|:----------------------------|:---------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| 6.x | Active development :rocket: | PHP >= 8.2, Symfony >= 5.4 | [](https://github.com/DamienHarper/auditor-bundle/actions/workflows/ci-6.x.yml)
[](https://scrutinizer-ci.com/g/DamienHarper/auditor-bundle/?branch=master)
[](https://app.codecov.io/gh/DamienHarper/auditor-bundle/branch/master) |
| 5.x | Active support | PHP >= 7.4, Symfony >= 4.4 | [](https://github.com/DamienHarper/auditor-bundle/actions/workflows/ci-5.x.yml)
[](https://scrutinizer-ci.com/g/DamienHarper/auditor-bundle/?branch=5.x)
[](https://app.codecov.io/gh/DamienHarper/auditor-bundle/branch/5.x) |
| 4.x | End of life | PHP >= 7.2, Symfony >= 3.4 | [](https://github.com/DamienHarper/auditor-bundle/actions/workflows/ci-4.x.yml)
[](https://scrutinizer-ci.com/g/DamienHarper/auditor-bundle/?branch=4.x) |
| 3.x | End of life | PHP >= 7.1, Symfony >= 3.4 | |
| 2.x | End of life | PHP >= 7.1, Symfony >= 3.4 | |
| 1.x | End of life | PHP >= 7.1, Symfony >= 3.4 | |
Changelog is available [here](https://damienharper.github.io/auditor-docs/docs/auditor-bundle/release-notes.html)
## Usage
Once [installed](https://damienharper.github.io/auditor-docs/docs/auditor-bundle/installation.html) and [configured](https://damienharper.github.io/auditor-docs/docs/auditor-bundle/configuration/general.html), any database change
affecting audited entities will be logged to audit logs automatically.
Also, running schema update or similar will automatically setup audit logs for every
new auditable entity.
## Contributing
`auditor-bundle` is an open source project. Contributions made by the community are welcome.
Send me your ideas, code reviews, pull requests and feature requests to help us improve this project.
Do not forget to provide unit tests when contributing to this project.
To do so, follow instructions in this dedicated [README](tests/README.md)
## Credits
- Thanks to [all contributors](https://github.com/DamienHarper/auditor-bundle/graphs/contributors)
## License
`auditor-bundle` is free to use and is licensed under the [MIT license](http://www.opensource.org/licenses/mit-license.php)