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.9

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.9.tar.gz (7.8 kB view details)

Uploaded Source

Built Distribution

django_ip_whitelist-0.1.9-py3-none-any.whl (8.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_ip_whitelist-0.1.9.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.9.tar.gz
Algorithm Hash digest
SHA256 e0131fe7c4c604f96ed08d9ebb56b10af2e95502e7278bef3d15f11c8ff53437
MD5 781fb69387d2327170e305d12803d1c0
BLAKE2b-256 f8db1e90837e3b60077c1e044a093a45daa05e1c872d2f6f53f319ce1c1a8a41

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for django_ip_whitelist-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 c3474728d846a97510e1d7c871b9bd321bc3041278176c9db1ffd58332877c85
MD5 125cc1dbb7aa707dad46b139090c296c
BLAKE2b-256 3ceb5b84b5e2e567c65ca8c166903d024f68e4bedab23e95c833d01ea34a4dbf

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