Sails with Multitenancy by using dynamically loaded Tenant-specific collections and their corresponding connections.
See Pull Requests:
Generate a project
sails generate new sails-multitenancy-exampleInstall sails-generate-auth:
npm install sails-generate-auth --saveGenerate the authentication source code:
sails generate authAdd dependencies for Passport authentication
We will be using Passport with Passport-local strategy, for this example app.
npm install --save passport
npm install --save passport-local
npm install --save validator
npm install --save bcryptjs
Configure for authentication. See https://github.com/kasperisager/sails-generate-auth#requirements
Setup appropriate Passport providers.
Add following line:
sails.services.passport.loadStrategies();Add following line:
'*': [ 'passport' ]Add routes:
'get /login': 'AuthController.login',
'get /logout': 'AuthController.logout',
'get /register': 'AuthController.register',
'post /auth/local': 'AuthController.callback',
'post /auth/local/:action': 'AuthController.callback',
'get /auth/:provider': 'AuthController.provider',
'get /auth/:provider/callback': 'AuthController.callback',
'get /auth/:provider/:action': 'AuthController.callback',If you see
Excuse my interruption, but it looks like this app
does not have a project-wide "migrate" setting configured yet.
(perhaps this is the first time you're lifting it with models?)
In short, this setting controls whether/how Sails will attempt to automatically
rebuild the tables/collections/sets/etc. in your database schema.
You can read more about the "migrate" setting here:
http://sailsjs.org/#/documentation/concepts/ORM/model-settings.html?q=migrate
In a production environment (NODE_ENV==="production") Sails always uses
migrate:"safe" to protect inadvertent deletion of your data.
However during development, you have a few other options for convenience:
1. safe - never auto-migrate my database(s). I will do it myself (by hand)
2. alter - auto-migrate, but attempt to keep my existing data (experimental)
3. drop - wipe/drop ALL my data and rebuild models every time I lift Sails
What would you like Sails to do?
info: To skip this prompt in the future, set `sails.config.models.migrate`.
info: (conventionally, this is done in `config/models.js`)
warn: ** DO NOT CHOOSE "2" or "3" IF YOU ARE WORKING WITH PRODUCTION DATA **
prompt: ?:
Setup migration, so the Sails warning does not appear, by adding the following line to config/models.js:
migrate: 'alter'Configure your connection to enable multitenancy.
In config file config/connections.js edit the connection,
localDiskDb, which we are using for this app and add the following:
// === Multitenancy support ===
isMultiTenant: true, // Enable Multi-Tenancy feature
availableTenants: ['localhost:1337', 'tenant2'], // Tenants that pass validation
configForTenant: function(tenantId, config, cb) { // For Waterline
// console.log('configForTenant', tenantId);
// Validate Tenant
if (config.availableTenants.indexOf(tenantId) !== -1) {
// Tenant is allowed
config.fileName = tenantId;
return cb(null, config);
} else {
// Tenant is not allowed
return cb(new Error("Invalid tenant " + tenantId + "!"));
}
}The config.availableTenants is only an example of how you may want to validate
your Tenant requests. Feel free to change this to however you like,
or not even validate at all!
Since each tenant has their own User and Passport collections
you must modify the original source code generated
by sails-generate-auth.
Apply the .tenant API to each of the collections calls, User and Passport, in api/services/protocols/local.js.
For instance, User.find().exec() becomes
User.tenant(req.session.tenant).find().exec().
Note the addition of .tenant(req.session.tenant) to the collection.
This will mean that those calls to User or Passport will now be
scoped around the tenant as specified by req.session.tenant.
Test that you can currently register and login.
sails liftGo to http://localhost:1337/register
Example User:
- Username:
sails - Email:
[email protected] - Passport:
sails123
Go to http://localhost:1337/login and login with the same information you used to register above.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent