Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.89 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.89 KB

SciChat Wrapper API

Build Status DeepScan grade Known Vulnerabilities

Loopback API for communication between SciChat and Catamel.

Get started

  1. git clone https://github.com/SciCatProject/scichat-loopback.git
  2. npm install
  3. Add .env file to project root folder. See Environment Variables.
  4. npm start

Test the app

npm run test

Environment Variables

Valid environment variables for the .env file.

SciChat-LoopBack

  • PORT [number] The port that this service should be exposed on. Defaults to 3000 if value is not set.

RabbitMQ

  • RABBITMQ_ENABLED [string] Toggles RabbitMQ consumer. Valid values are "yes" and "no". Defaults to "no".
  • RABBITMQ_HOST [string] The hostname/URL of your RabbitMQ. Defaults to "localhost".
  • RABBITMQ_USER [string] Username of the RabbitMQ user.
  • RABBITMQ_PASSWORD [string] Password of the RabbitMQ user.
  • DEFAULT_PASSWORD [string] The default password for new SciChat users created from the RabbitMQ message queue

Synapse

  • SYNAPSE_SERVER_NAME [string] The name of of your Synapse server.
  • SYNAPSE_SERVER_HOST [string] The hostname/URL of your Synapse server.
  • SYNAPSE_BOT_NAME [string] The username of the account used for authenticating to your Synapse server.
  • SYNAPSE_BOT_PASSWORD [string] The password of the account used for authenticating to your Synapse server.