Skip to content

API Reference

General Settings

This document outlines the configuration settings available in Grit One. These settings should be added to your app/settings.py file to customize your application's behavior.

DOMAIN_NAME

Default: None

The custom domain name where you app will live.

SUBDOMAIN_NAME

Default: 'www'

Subdomain name.

PLATFORM_NAME

Default: 'platform'

The subdomain used for the platform redirect URL. When combined with your DOMAIN_NAME, this creates the platform access URL. For example, if DOMAIN_NAME is "example.com" and PLATFORM_NAME is "platform", the resulting URL will be https://platform.example.com

AWS_RDS_ENDPOINT

Default: None

Your AWS RDS Endpoint for deployment.

AWS_PROFILE

Default: None

Your AWS Profile for deployment.

AWS_ACCOUNT_ID

Default: None

Your AWS Account ID for deployment.

Authentication Settings

AUTH_SETTINGS

LOGIN_VIEW

In app/settings.py: 

from customauth.types import AuthSettingsTypedDict

AUTH_SETTINGS: AuthSettingsTypedDict = {
    'LOGIN_VIEW': 'app_customauth.views.custom_login_view'
}

In app_customauth/views.py: 

class CustomLoginView(auth_views.LoginView):
    template_name = 'app_customauth/login.html'
    form_class = EmailAuthenticationForm


def custom_login_view(request):
    return CustomLoginView.as_view()(request)