2013-12-12 16:57:29 +00:00
|
|
|
Installation
|
|
|
|
|
============
|
|
|
|
|
|
|
|
|
|
Installing Auditlog is simple and straightforward. First of all, you need a copy of Auditlog on your system. The easiest
|
|
|
|
|
way to do this is by using the Python Package Index (PyPI). Simply run the following command:
|
|
|
|
|
|
|
|
|
|
``pip install django-auditlog``
|
|
|
|
|
|
|
|
|
|
Instead of installing Auditlog via PyPI, you can also clone the Git repository or download the source code via GitHub.
|
|
|
|
|
The repository can be found at https://github.com/jjkester/django-auditlog/.
|
|
|
|
|
|
2015-05-14 23:49:08 +00:00
|
|
|
**Requirements**
|
|
|
|
|
|
2019-08-22 13:20:18 +00:00
|
|
|
- Python 3.5 or higher
|
|
|
|
|
- Django 1.11 or higher
|
2015-05-14 23:49:08 +00:00
|
|
|
|
2016-08-02 15:03:03 +00:00
|
|
|
Auditlog is currently tested with Python 2.7 and 3.4 and Django 1.8, 1.9 and 1.10. The latest test report can be found
|
2015-10-19 14:09:01 +00:00
|
|
|
at https://travis-ci.org/jjkester/django-auditlog.
|
2015-05-14 23:49:08 +00:00
|
|
|
|
2013-12-12 16:57:29 +00:00
|
|
|
Adding Auditlog to your Django application
|
|
|
|
|
------------------------------------------
|
|
|
|
|
|
2015-07-21 23:16:58 +00:00
|
|
|
To use Auditlog in your application, just add ``'auditlog'`` to your project's ``INSTALLED_APPS`` setting and run
|
2015-05-14 22:56:01 +00:00
|
|
|
``manage.py migrate`` to create/upgrade the necessary database structure.
|
2013-12-12 16:57:29 +00:00
|
|
|
|
|
|
|
|
If you want Auditlog to automatically set the actor for log entries you also need to enable the middleware by adding
|
2015-10-19 14:09:01 +00:00
|
|
|
``'auditlog.middleware.AuditlogMiddleware'`` to your ``MIDDLEWARE_CLASSES`` setting. Please check :doc:`usage` for more
|
|
|
|
|
information.
|
