Installation¶

Install the package¶

Install Django-AWS-API-Gateway-WebSockets into your Django environment.

pip install django-aws-api-gateway-websockets

Add the package to INSTALLED_APPS in your Django settings.

INSTALLED_APPS = [
    # ...
    "django_aws_api_gateway_websockets",
]

Apply the database migrations.

python manage.py migrate

After installation, configure the required Django settings for your AWS account, API Gateway setup, and WebSocket routing.

See Configuration for details.

The application needs AWS IAM permissions to create and manage API Gateway resources and to send messages to active WebSocket connections.

See AWS IAM Setup for details.

Create an API Gateway configuration record using Django Admin, a management command, or your own deployment process.

Once the record exists, you can create the API Gateway resources and custom domain configuration if required.

Add Django URL routes that receive WebSocket callbacks from AWS API Gateway.

See Adding new routes for more information.