Configuration

zulipbot supports custom configuration so project maintainers can enable or disable available features to support their various needs.

The configuration files are located in the ./config folder. ./config/default.js is the default configuration file and should be modified under no circumstances; instead, to modify the zulipbot configuration, simply

Authentication

Currently, the zulipbot client can only use basic authentication (username and password) to gain access to a user account. These credentials, along with the webhook secret, can be specified in two ways:

• By setting them as Node environment variables (USERNAME, PASSWORD, WEBHOOK_SECRET)
• By creating a file named ./config/secrets.json and storing the credentials in the following format:

  {
    "username": "examplebot",
    "password": "verysecurepassword0w0",
    "webhookSecret": "12345tgbj876tgvcdert"
  }
  

Issues

Commands

See Commands for descriptions about what each command does.

• exports.issues.commands.assign.claim.aliases:
  • Type: Array<string>
  • Description: Aliases for which the claim command can be activated.
• exports.issues.commands.assign.claim.permission:
  • Type: String (pull, push, or admin)
  • Description: Repository permission to give to new contributors claiming issues. Required if claiming issues is enabled.
• exports.issues.commands.label.add.aliases:
  • Type: Array<string>
  • Description: Aliases for which the add command can be activated.
• exports.issues.commands.label.remove.aliases:
  • Type: Array<string>
  • Description: Aliases for which the remove command can be activated.
• exports.issues.commands.label.self:
  • Types:
    • Boolean
    • Object:
      • users: Array<string>
  • Description: Whether or not users should be allowed to change the labels of issues that they did not create.
    • exports.issues.commands.label.self.users represents a group of users allowed to label others' issues.