users-microservice 0.2.4

Django users Microservice

================== users-microservice

users-microservice is a django microservice build for user authentication and verification.

Detailed documentation is in the "docs" directory.

Quick start

1. Add "users-microservice" to your INSTALLED_APPS setting like this::

    INSTALLED_APPS = [
        ...
        'users-microservice',
    ]
   

2. Include the following to all the settings files in you microservice structure::

   Authentication parameters shared_security is our SDK package name, this param tell the SDK which user model to use

    AUTH_USER_MODEL = 'shared_security.User'
   

   this is the table name in the database for our users model

    AUTH_USER_TABLE = 'users_user'
   

   this is the name of the database holding the users model

    AUTH_DB = 'primary_db'
   
    DATABASE_ROUTERS = ['shared_security.dbrouter.AuthRouter']
   
    DATABASES = {
        'default': {
            'ENGINE': 'django.db.backends.mysql',
            'HOST': os.getenv('DB_HOST'),
            'PORT': int(os.getenv('DB_PORT', 3306)),
            'USER': os.getenv('DB_USER'),
            'PASSWORD': os.getenv('DB_PASSWORD'),
            'NAME': os.getenv('DB_NAME')
        },
        'primary_db': {
            'ENGINE': 'django.db.backends.mysql',
            'HOST': os.getenv('DB_HOST'),
            'PORT': int(os.getenv('DB_PORT', 3306)),
            'USER': os.getenv('DB_USER'),
            'PASSWORD': os.getenv('DB_PASSWORD'),
            'NAME': 'primary',
        }
    }
   

   Change all the 'shared_security' paramaters with the naming you use.

3. Run python manage.py migrate.

4. Start the development server and visit http://127.0.0.1:8000/