Skip to main content

A Django app to only allow access to certain pages based on IP addresses.

Project description

1 Welcome to django-ip-whitelist’s documentation!

Version:

0.1.10

Source:

https://github.com/maykinmedia/django-ip-whitelist

Keywords:

Django IP Whitelist, IP whitelist, pip package

PythonVersion:

3.9

Build status Code quality checks black Coverage status Documentation Status

python-versions django-versions pypi-version

This package provides a Django middleware that allows you to whitelist IP addresses that are allowed to access your site.

By default the user’s IP needs to conform to the IP whitelist in order to access the Django admin. You can either specify individual IP addresses or IP ranges, and the whitelist is manageable via the Django admin.

2 Installation

2.1 Requirements

  • Python 3.8 or above

  • setuptools 40.8.0 or above

  • Django 3.2 or newer

2.2 Install

pip install django-ip-whitelist

Add ip_whitelist to your INSTALLED_APPS:

INSTALLED_APPS = [
    ...
    'ip_whitelist',
    ...
]

3 Usage

Add the middleware to your MIDDLEWARE setting:

MIDDLEWARE = [
    ...
    'ip_whitelist.middleware.IPWhitelistMiddleware',
    ...
]

Add the IP addresses you want to whitelist to your settings.py:

WHITELIST_IPS = [
    ...
    '127.0.0.1',
    ...
]

Add the WHITELIST_IP_RANGES to your settings.py:

WHITELIST_IP_RANGES = [
    ...
    '
    ...
]

Add the OUTSIDE_IP_DISALLOWED_PATHS to your settings.py with disallowed URLs:

OUTSIDE_IP_DISALLOWED_PATHS = (
    ...
    '/admin',
    ...
)

3.1 Migrations

Run the migrations:

python manage.py migrate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django_ip_whitelist-0.1.10.tar.gz (7.8 kB view hashes)

Uploaded Source

Built Distribution

django_ip_whitelist-0.1.10-py3-none-any.whl (9.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page