From bb72e566040cde5f03973835c469584f63f14e7f Mon Sep 17 00:00:00 2001 From: Steven Bal Date: Mon, 19 Feb 2024 14:16:23 +0100 Subject: [PATCH] :memo: [#33] Update docs --- docs/quickstart.rst | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/quickstart.rst b/docs/quickstart.rst index fd65f13..1ab4c03 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -20,7 +20,7 @@ Installation pip install django-log-outgoing-requests -#. Add ``log_outgoing_requests`` to ``INSTALLED_APPS`` in your Django +#. Add ``log_outgoing_requests`` to ``INSTALLED_APPS`` in your Django project's ``settings.py``. #. Run ``python manage.py migrate`` to create the necessary database tables @@ -97,9 +97,10 @@ you likely want to apply the following non-default settings: From a security and privacy perspective, we advise not enabling saving to the database by default via Django settings and instead rely on runtime configuration. - If Celery is installed but not configured in your environment, ``LOG_OUTGOING_REQUESTS_RESET_DB_SAVE_AFTER`` + If Celery is installed but not configured in your environment, ``LOG_OUTGOING_REQUESTS_RESET_DB_SAVE_AFTER`` (which defines if/when database logging is reset after changes to the library config) should - be set to ``None``. + be set to ``None``. The duration for **Reset saving logs in database after** can also be + configured from the admin and will override the value of the environment variable if defined. The library provides a Django management command as well as a Celery task to delete logs which are older than a specified time (by default, 1 day).