actionhero/config/api.js

actionhero.js is a multi-transport API Server with integrated cluster capabilities and delayed tasks

exports['default'] = {
  general: function(api){
    return {
      apiVersion: '0.0.1',
      serverName: 'actionhero API',
      // id can be set here, or it will be generated dynamically.
      //  Be sure that every server you run has a unique ID (which will happen when generated dynamically)
      //  id: 'myActionHeroServer',
      // A unique token to your application that servers will use to authenticate to each other
      serverToken: 'change-me',
      // The welcome message seen by TCP and webSocket clients upon connection
      welcomeMessage: 'Hello! Welcome to the actionhero api',
      // the redis prefix for actionhero's cache objects
      cachePrefix: 'actionhero:cache:',
      // the redis prefix for actionhero's cache/lock objects
      lockPrefix: 'actionhero:lock:',
      // how long will a lock last before it exipres (ms)?
      lockDuration: 1000 * 10, // 10 seconds
      // Watch for changes in actions and tasks, and reload/restart them on the fly
      developmentMode: true,
      // How many pending actions can a single connection be working on
      simultaneousActions: 5,
      // allow connections to be created without remoteIp and remotePort (they will be set to 0)
      enforceConnectionProperties: true,
      // disables the whitelisting of client params
      disableParamScrubbing: false,
      // params you would like hidden from any logs
      filteredParams: [],
      // values that signify missing params
      missingParamChecks: [null, '', undefined],
      // The default filetype to server when a user requests a directory
      directoryFileType : 'index.html',
      // The default priority level given to middleware of all types (action, connection, and say)
      defaultMiddlewarePriority : 100,
      // configuration for your actionhero project structure
      paths: {
        'action':      [__dirname + '/../actions'],
        'task':        [__dirname + '/../tasks'],
        'public':      [__dirname + '/../public'],
        'pid':         [__dirname + '/../pids'],
        'log':         [__dirname + '/../log'],
        'server':      [__dirname + '/../servers'],
        'initializer': [__dirname + '/../initializers'],
        'plugin':      [__dirname + '/../node_modules'],
        'locale':      [__dirname + '/../locales']
      },
      // hash containing chat rooms you wish to be created at server boot
      startingChatRooms: {
        // format is {roomName: {authKey, authValue}}
        //'secureRoom': {authorized: true},
      }
    };
  }
};

exports.test = {
  general: function(api){
    return {
      id: 'test-server',
      developmentMode: true,
      startingChatRooms: {
        'defaultRoom': {},
        'otherRoom': {},
      },
      paths: {
        'locale': [require('os').tmpdir()  + require('path').sep + 'locale']
      }
    };
  }
};

exports.production = {
  general: function(api){
    return {
      developmentMode: false
    };
  }
};