osjs-mongo-auth

OS.js v3 MongoDB Auth Adapter

This is the MongoDB Auth Provider Adapter for OS.js v3.

To set this up, you need to do the following steps:

1. Set up your database
2. Install
3. Configure Server
4. Configure Client
5. Configure CLI
6. Manage Users

Please see the OS.js Authentication Guide for general information.

Installation

Install the required OS.js module and database driver:

npm install --save --production osjs-mongo-auth

Configure Server

To connect the server with the database authentication module, you'll have to modify your Server bootstrap script.

In your src/server/index.js file:

// In the top of the file load the library
const dbAuth = require('osjs-mongo-auth');
 
// Locate this line in the file and add the following:
osjs.register(AuthServiceProvider, {
  args: {
    adapter: dbAuth.adapter,
    config: {
      url: 'mongodb://localhost:27017',
      dbName: 'osjs'
    }
  }
});

NOTE: You have to restart the server after making these changes.

Configure Client

By default OS.js is set up to log in with the demo / demo user for demonstration purposes.

In your src/client/config.js file:

module.exports = {
  public: '/',
 
  // Either comment out this section, or remove it entirely
  /*
  auth: {
    login: {
      username: 'demo',
      password: 'demo'
    }
  }
  */
};

NOTE: You have to rebuild using npm run build after making these changes.

Configure CLI

To get CLI commands to manage users, you'll have to modify your CLI bootstrap script.

In your src/cli/index.js file:

// In the top of the file load the library
const dbAuth = require('osjs-mongo-auth');
 
// Create a database authentication instance
const dbCli = dbAuth.cli({
  // Change this to match your local database server
  url: 'mongodb://localhost:27017',
  dbName: 'osjs'
 
  // See TypeORM documentation for more settings
});
 
// Then finally add 'dbCli' to the tasks array
module.exports = {
  discover: [],
  tasks: [dbCli]
};

Manage Users

You can now manage users with ex. npx osjs-cli <task>

The npx command comes with npm 5.2 or later, but if you for some reason don't have this you can install it manually. Or alternatively use node node_modules/.bin/osjs-cli <task>

Available tasks:

• user:list - Lists users
• user:add --username=STR - Adds user (as admin)
• user:add --username=STR --groups=GROUP1,GROUP2 - Adds user with groups
• user:pwd --username=STR - Changes user password
• user:remove --username=STR - Removes user

Example: npx osjs-cli user:add --username=anders.