Installation

django-honeyguard can be installed using pip or by cloning the repository.

Using pip

The recommended way to install django-honeyguard is using pip:

pip install django-honeyguard

Or to install from the latest source:

pip install git+https://github.com/alihtt/django-honeyguard.git

For development, install with extra dependencies:

pip install -e ".[dev]"

Dependencies

django-honeyguard requires:

Python: 3.10 or higher
Django: 5.0 or higher

All other dependencies are listed in pyproject.toml.

Django Configuration

Add to INSTALLED_APPS

Add django_honeyguard to your INSTALLED_APPS in settings.py:

INSTALLED_APPS = [
    "django.contrib.admin",
    "django.contrib.auth",
    # ...
    "django_honeyguard",
]

Run Migrations

Run Django migrations to create the necessary database tables:
```
python manage.py migrate django_honeyguard
```
This creates the HoneyGuardLog model table for storing attack logs.

Include URLs (Optional)

Option A: Include all URLs

If you want to use the default fake admin URLs, include them in your urls.py:

from django.urls import path, include

urlpatterns = [
    # ... your other URLs
    path("", include("django_honeyguard.urls")),
]

This adds the following URLs:

/admin/ - Fake Django admin login
/wp-admin.php - Fake WordPress admin login

Option B: Import views directly

If you only need specific fake login pages, you can import and use individual views:

from django.urls import path
from django_honeyguard.views import FakeDjangoAdminView, FakeWPAdminView

urlpatterns = [
    # ... your other URLs
    path("fake-admin/", FakeDjangoAdminView.as_view(), name="fake_django_admin"),
    # Or only WordPress:
    # path("wp-login/", FakeWPAdminView.as_view(), name="fake_wp_admin"),
]

This approach gives you more control over:

Which URLs to expose
URL path names
Custom URL patterns (e.g., path("admin/login/", ...))

Configure Settings

See Configuration for detailed configuration options.

Verification

To verify the installation:

Check that the app is properly configured:
```
python manage.py check
```

Verify the admin is registered:

python manage.py shell

>>> from django.contrib import admin
>>> from django_honeyguard.models import HoneyGuardLog
>>> HoneyGuardLog in admin.site._registry
True

Test the URLs are accessible:

Visit http://localhost:8000/admin/ in your browser (if URLs are included).

Next Steps

Read the Configuration guide to set up email alerts and logging
Check Examples for integration patterns and usage examples