Skip to content

All Django Settings options

Setting Description
GITHUB_SSO_ACCEPT_OUTSIDE_COLLABORATORS Accept outside collaborators. Default: False
GITHUB_SSO_ALLOW_ALL_USERS Explicity allow all users. Default: False
GITHUB_SSO_ALLOWABLE_DOMAINS List of domains that will be allowed to create users. Default: []
GITHUB_SSO_ALLOWABLE_ORGS List of organizations that will be allowed to create users. Default: []
GITHUB_SSO_ALWAYS_UPDATE_USER_DATA If true, update default user info from GitHub data at every login. This will also make their password unusable. Otherwise, all of this happens only on create. Default: False
GITHUB_SSO_AUTHENTICATION_BACKEND The authentication backend to use. Default: None
GITHUB_SSO_AUTO_CREATE_FIRST_SUPERUSER If True, the first user that logs in will be created as superuser if no superuser exists in the database at all. Default: False
GITHUB_SSO_AUTO_CREATE_USERS Enable or disable the auto-create users feature. Default: True
GITHUB_SSO_CALLBACK_DOMAIN The netloc to be used on Callback URI. Default: None
GITHUB_SSO_CHECK_ONLY_PRIMARY_EMAIL Check only primary email. Default: False
GITHUB_SSO_CLIENT_ID The GitHub OAuth 2.0 Web Application Client ID. Default: None
GITHUB_SSO_CLIENT_SECRET The GitHub OAuth 2.0 Web Application Client Secret. Default: None
GITHUB_SSO_ENABLE_MESSAGES Show Messages using Django Messages Framework. Default: True
GITHUB_SSO_ENABLED Enable or disable the plugin. Default: True
GITHUB_SSO_LOGIN_FAILED_URL The named url path that the user will be redirected to if an authentication error is encountered. Default: admin:index
GITHUB_SSO_LOGO_URL The URL of the logo to be used on the login button. Default: https://github.githubassets.com/assets/GitHub-Mark-ea2971cee799.png
GITHUB_SSO_NEEDED_REPOS List of repositories the user needs to be member to authorize login. Default: []
GITHUB_SSO_NEXT_URL The named url path that the user will be redirected if there is no next url after successful authentication. Default: admin:index
GITHUB_SSO_PRE_CREATE_CALLBACK Callable for processing pre-create logic. Default: django_github_sso.hooks.pre_create_user
GITHUB_SSO_PRE_LOGIN_CALLBACK Callable for processing pre-login logic. Default: django_github_sso.hooks.pre_login_user
GITHUB_SSO_PRE_VALIDATE_CALLBACK Callable for processing pre-validate logic. Default: django_github_sso.hooks.pre_validate_user
GITHUB_SSO_SAVE_ACCESS_TOKEN Save the access token in the session. Default: False
GITHUB_SSO_SAVE_BASIC_GITHUB_INFO Save basic GitHub info in the database. Default: True
GITHUB_SSO_SCOPES The GitHub OAuth 2.0 Scopes. Default: ["read:user", "user:email", "read:org"]
GITHUB_SSO_SESSION_COOKIE_AGE The age of the session cookie in seconds. Default: 3600
GITHUB_SSO_SHOW_ADDITIONAL_ERROR_MESSAGES Show additional error messages in django message system when authentication fails. Default: False
GITHUB_SSO_SHOW_FAILED_LOGIN_MESSAGE Show a message on browser when the user creation fails on database. Default: `False
GITHUB_SSO_STAFF_LIST List of emails that will be created as staff. Default: []
GITHUB_SSO_SUPERUSER_LIST List of emails that will be created as superuser. Default: []
GITHUB_SSO_TEXT The text to be used on the login button. Default: Sign in with GitHub
GITHUB_SSO_TIMEOUT The timeout in seconds for the GitHub SSO authentication returns info, in minutes. Default: 10
GITHUB_SSO_UNIQUE_EMAIL When get or create a new user, check if the email already exists. Default: False
SSO_SHOW_FORM_ON_ADMIN_PAGE Show the form on the admin page. Default: True
SSO_USE_ALTERNATE_W003 Use alternate W003 warning. You need to silence original templates.E003 warning. Default: False