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 details)

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

Details for the file django_ip_whitelist-0.1.10.tar.gz.

File metadata

  • Download URL: django_ip_whitelist-0.1.10.tar.gz
  • Upload date:
  • Size: 7.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.19

File hashes

Hashes for django_ip_whitelist-0.1.10.tar.gz
Algorithm Hash digest
SHA256 26087807fc5a65ccad3017cb3a7483b5bbfa17a6d8f7d4885d4f2369de6ac368
MD5 5ce0dd30d225a1d9c3677998ec7a4ad6
BLAKE2b-256 75bdb0f448b8d0ace79626c3a663d04e95354c87f8cf16f4d6b1d65b2dbe5c6c

See more details on using hashes here.

File details

Details for the file django_ip_whitelist-0.1.10-py3-none-any.whl.

File metadata

File hashes

Hashes for django_ip_whitelist-0.1.10-py3-none-any.whl
Algorithm Hash digest
SHA256 a7796e576f0c73df70c4d25db410948525c09e22e4b349eafb7cc8d88c7f5be7
MD5 5bb4f3be27855f4fa22db4c42c736bb9
BLAKE2b-256 963a3180f22555a1b37ad8d5d85c15f368a94a3ce460bbdc7860758cc0bb9b6a

See more details on using hashes here.

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