@sirolad/adonisjs-polis

AdonisJs Polis

This is a clone of Polis by JMiranda. A simple AdonisJs package that allows you to use multi tenancy in your application.

Instalation

Install package with adonis install:

adonis install @sirolad/adonisjs-polis

In case of installation using npm or yarn, you must copy the config/index.js file into your app config directory as config/polis.js.

Setup

Register Polis provider inside start/app.js file:

const providers = [
  ...
  '@sirolad/adonisjs-polis/providers/PolisProvider'
  ...
]

Set up the middleware in start/kernel.js file:

const namedMiddleware = {
  ...
  tenant: 'Adonis/Middleware/TenantDetector'
  ...
}

Usage

Add Polis trait to your multi tenant models:

const Model = use('Model')

class User extends Model {
  static boot () {
    super.boot()
    this.addTrait('@provider:TenantAware')
  }
}

And use Polis middleware in the related routes:

Route.group(() => {
  Route.post('/login', 'SessionController.create')
}).middleware(['tenant'])

You can override the default tenant source in config/polis.js file for certain routes by specifying the source of tenant as property of the middleware(header, url_query, url_param, subdomain). For example: middleware(['tenant:subdomain']).

References

This package is based on @brainnit/adonisjs-feud.