📚docs(RST): Add documentation for LogiBoard integration in django_logging

- Introduced a new section in the documentation titled **LogiBoard Integration** to provide users with a detailed guide on how to set up and use the LogiBoard feature in the django_logging package.
- The new documentation covers:
  - A brief overview of LogiBoard's purpose and superuser access restriction.
  - Step-by-step setup instructions including:
    - Adding LogiBoard URLs to Django's URL configuration.
    - Running collectstatic to prepare static files.
    - Enabling LogiBoard via the DJANGO_LOGGING setting.
  - Detailed usage instructions on how to upload ZIP files and explore log files within the LogiBoard interface.
- Ensured instructions are clear for administrators managing log files through the upload and exploration process.

This addition aims to help users integrate and use LogiBoard seamlessly within their Django projects.

Closes #119

Author: MEHRSHAD-MIRSHEKARY

django_logging/static/LogiBoard/js/scripts.js

@@ -4,6 +4,7 @@ let folderTree = {};
 let interval;
 let progress = 0;
 let isStopped = false;
+let currentFile = null;
 
 const validFileTypes = ['application/zip', 'application/x-zip-compressed', 'multipart/x-zip'];
 
@@ -31,6 +32,7 @@ function uploadFile(file) {
     folderTree = {};
     document.getElementById('file-structure').innerHTML = '';
     document.getElementById('file-display').innerHTML = '';
+    currentFile = file;
     startUploadProgress(file);
 }
 
@@ -166,7 +168,7 @@ function toggleUploadState() {
     isStopped = !isStopped;
     clearInterval(interval);
     document.getElementById('stop-icon').src = icons[isStopped ? 'pause' : 'stop'];
-    if (!isStopped) startUploadProgress();
+    if (!isStopped && currentFile) startUploadProgress(currentFile);
 }
 
 document.getElementById('close-icon').addEventListener('click', resetAll);

docs/conf.py

@@ -13,8 +13,8 @@
 # -- Project information -----------------------------------------------------
 
 project = 'django_logging'
-copyright = '2024, django_logging'
-author = 'ARYAN NIKNEZHAD, MEHRSHAD-MIRSHEKARY'
+copyright = '2024, Lazarus'
+author = 'ARYAN-NIKNEZHAD, MEHRSHAD-MIRSHEKARY'
 
 # The full version, including alpha/beta/rc tags
 release = '2.0.0'

docs/index.rst

@@ -82,6 +82,7 @@ The documentation is organized into the following sections:
 
    quick_start
    usage
+   log_iboard
    settings
    contributing
    rules

docs/log_iboard.rst

@@ -0,0 +1,63 @@
+LogiBoard Integration
+=====================
+
+The ``LogiBoard`` in the ``django_logging`` package provides an interface for uploading, extracting, and exploring log files that have been zipped and shared via email. This allows for easier log management.
+
+.. note::
+
+   **Superuser Access Only**: Only superusers have access to the LogiBoard URL. If accessed by a non-superuser, they will get Access Denied page made by Lazarus.
+
+Setup Instructions
+------------------
+
+1. **Add to URLs**:
+   Include the following in your URL configuration to enable access to LogiBoard:
+
+   .. code-block:: python
+
+    from django.urls import path, include
+
+
+    urlpatterns = [
+        # ...
+        path("django-logging/", include("django_logging.urls")),
+        # ...
+    ]
+
+LogiBoard will be accessible at the following link in your project after setting it up:
+   ``/django-logging/log-iboard/``
+
+2. **Static Files**:
+   Run the following command to collect and prepare the static files necessary for LogiBoard's interface:
+
+   .. code-block:: bash
+
+      python manage.py collectstatic
+
+   The `collectstatic` command is required to gather and serve static assets (such as JavaScript, CSS, and images) used by LogiBoard. This ensures the front-end of the log upload and browsing interface works correctly.
+
+3. **Enable LogiBoard**:
+   In your settings file, ensure the following setting is added under ``DJANGO_LOGGING``:
+
+   .. code-block:: python
+
+      DJANGO_LOGGING = {
+          # ...
+          "INCLUDE_LOG_iBOARD": True,
+          # ...
+      }
+
+   This setting ensures that LogiBoard is available in your project.
+
+
+Using LogiBoard
+---------------
+
+Logiboard is designed to help administrators easily review log files that have been zipped and sent via email (generated by the ``send_logs`` management command). This is particularly useful for remotely retrieving log files from production systems or shared environments.
+
+- **Access Logiboard**: Go to the link ``/django-logging/log-iboard/`` in your project to open the LogiBoard interface.
+- **Upload ZIP Files**: Click the upload icon or drag and drop ZIP files into the upload area. Only ZIP files are supported for upload.
+- **Explore Log Files**: After uploading, Logiboard automatically extracts the log files and displays their structure. You can browse through directories and open log files in supported formats, such as ``.log``, ``.txt``, ``.json``, and ``.xml``.
+- **Upload New Files**: Once you're done reviewing, click the "Send Another" button to upload and explore more logs.
+
+LogiBoard makes it simple to manage and review logs, ensuring you can quickly access and analyze critical log data.

docs/settings.rst

@@ -11,6 +11,7 @@ Default configuration
     DJANGO_LOGGING = {
         "AUTO_INITIALIZATION_ENABLE": True,
         "INITIALIZATION_MESSAGE_ENABLE": True,
+        "INCLUDE_LOG_iBOARD": True,
         "LOG_SQL_QUERIES_ENABLE": True,
         "LOG_FILE_LEVELS": ["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
         "LOG_DIR": "logs",
@@ -65,6 +66,13 @@ Here's a breakdown of the available configuration options:
 - **Type**: ``bool``
 - **Description**: Enables logging of the initialization message when logging starts. Defaults to ``True``.
 
+``INCLUDE_LOG_iBOARD``
+----------------------
+
+- **Type**: ``bool``
+- **Description**: Makes LogiBoard url accessible in the project. Defaults to ``False``. for setting up the LogiBoard, please refer to the :doc:`LogiBoard Integration <log_iboard>`.
+
+
 ``LOG_SQL_QUERIES_ENABLE``
 --------------------------