Insert here a brief overview of the page's content
This article serves as a guide to getting connectors set up for local development.
Insert here an image - centered - related to the subject here
Insert here a description of the section one
bundle install
rake db:setup
Before starting the connector, the environment variables must be set:
From your console run: cp config/application.sample.yml config/application.yml
Your application.yml
file should look something like this:
encryption_key1: encryption_key2: SIDEKIQ_USERNAME: admin SIDEKIQ_PASSWORD: password REDIS_URL: redis://localhost:6379/0/<project-name> MNO_DEVPL_HOST: https://dev-platform.maestrano.com MNO_DEVPL_API_PATH: /api/config/v1/marketplaces MNO_DEVPL_ENV_KEY: MNO_DEVPL_ENV_SECRET: |
These can be set to anything. Just be sure to set them as they are required for the connector to run.
To run your connector locally you may need to set the $PORT
and $RACK_ENV
variables manually. For example (In your terminal):
export PORT=3001 export RACK_ENV=development |
If you are using a connector that requires https requests (via an ngrok forwarding address). You will want to set the endpoint you are using on the developer platform. You can do so by logging in to the developer platform, finding the application you are using, and clicking on the appropriate environment (usually "Local"). Be sure to update the Host and IDM endpoints.
This must be done before starting the connector or you will experience redirection issues. |
Each specific connector may have some variations to the set-up process:
bc_client_id:
and bc_client_secret:
DEFAULT_APP_PROTOCOL:
and DEFAULT_APP_HOST: