django-terra-accounts¶

Django accounts management for terralego apps

Installation¶

Requirements¶

Minimum configuration :

Postgresql 10

Recommended configuration :

Postgresql 11

Your final django project should use postgresql or postgis as default DATABASE backend

USING docker image :

Prebuilt docker image builded by makinacorpus

https://cloud.docker.com/u/makinacorpus/repository/docker/makinacorpus/pgrouting/general

With pip¶

From Pypi:

pip install django-terra-accounts

From Github:

pip install -e https://github.com/Terralego/django-terra-accounts.git@master#egg=django-terra-accounts

With git¶

git clone https://github.com/Terralego/django-terra-accounts.git
cd django-terra-accounts
python setup.py install

Configuration¶

In your project :

# settings

# install required apps
INSTALLED_APPS = [
    ...
    # required apps to work with terra_accounts
    'rest_framework',
    'rest_framework_jwt',
    'terra_settings',
    # terra_accounts app
    'terra_accounts',
    ...
]

TERRA_USER_STRING_FORMAT = ''  # python doted path to function that return user string formatted

# urls

urlpatterns = [
    ...
    # required apps to work with terra_accounts
    path('', include('terra_settings.urls')),
    # terra_accounts app
    path('', include('terra_accounts.urls')),
    ...
]

You can customize default url and namespace by including terra_accounts.views directly

# ADMIN :

you can disable and / or customize admin

BACKWARD compatibility

# Password reset

you must set settings to correctly generate and send email for password reset.
- FRONT_URL : default to http://localhost:3000 . Should match with your front url
- Other settings to send mails ->
- https://docs.djangoproject.com/en/3.0/ref/settings/#std:setting-EMAIL_HOST