# Barong environments overview

#This document provides description, defaults and possible values for all environment variables that take a part in app configuration

# General configuration

# Password configuration

# Storage configuration

More details in storage configuration doc

# API CORS configuration

# CAPTCHA configuration

More details in captcha policy doc

# Twilio configuration

More details in twilio configuration

# RabbitMQ configuration

# Redis configuration

| barong_redis_cluster | false | false true | define redis mode usage (https://redis.io/topics/cluster-tutorial) | | barong_redis_url | redis://localhost:6379/1 | any valid url | url of redis server with port | | barong_redis_password | ~ | any string value | redis server access password |

# Vault configuration

| barong_vault_address | http://localhost:8200 | any valid url | vault server url with port | | barong_vault_token | | any string value | vault access token | | barong_vault_app_name | barong | any string value | the name of the application, all encryption keys in Vault will be prefixed with this application name |

# Sentry configuration

| barong_sentry_dsn_backend | ~ | valid host url | Sentry SDK client key |

# Auth0 configuration

# SMTP configuration

# Config files configuration

# Barong configurations overview

#Twilio configuration

For twilio configuration we need to set such required envs

• BARONG_TWILIO_ACCOUNT_SID, which acts as a twilio username
• BARONG_TWILIO_SERVICE_SID, which acts as a twilio password
• BARONG_TWILIO_PHONE_NUMBER, virtual phone numbers which will give you instant access to local, national, mobile, and toll-free phone numbers

We have ability to set twilio with 3 different ways

1. BARONG_PHONE_VERIFICATION == "twilio_sms" If you choose phone verification as twilio sms we will use send_sms API call Also you can add your own template for sms using BARONG_SMS_CONTENT_TEMPLATE
2. BARONG_PHONE_VERIFICATION == "twilio_verify" In this case we will use twilio Verify API call There are a lot of benefits of using Verify API like you can validate users via voice One verification service can be used to send multiple verification tokens, it is not necessary to create a new service each time, so you can set BARONG_TWILIO_SERVICE_SID at once
3. BARONG_PHONE_VERIFICATION == "mock" With this type of verification all the numbers will be accepted and validated as a right code for any given number

#Blacklist/Whitelist configuration

Pass routes will never be checked by AuthZ endpoint and will be available without session requirement. On Block routes user always will get 401, it doesn't depend on a session / role / ip / etc

You need to put whitelisted (public) routes for pass object and blacklisted routes for block in authz_rules.yml

rules:
  pass:
    - api/v2/barong/identity
    - api/v2/peatio/public
    - api/v2/ranger/public
    - api/v2/applogic/public
   block:
    - api/v2/barong/management
    - api/v2/peatio/managemen

#State configuration

We can customize barong configuration as we want

1. For user activation we just need to have verified email label in example below. You can put more labels to create your own rules for user activation
2. For example, if you want to ban your user you just need to put ban and fraud labels on tower admin panel. For sure you can customize this case too and put change or add label names in barong.yml
3. For document verification we use, as standard - following document types. But you can configure available document types by changing or extending existing list. This way we keep an opportunity to support any custom KYC services, logic, etc

activation_requirements:
  email: 'verified'
state_triggers:
  banned:
    - ban
    - fraud
  deleted:
    - delete
  locked:
    - suspicious
    - lock
document_types:
  - Passport
  - Identity card
  - Driver license
  - Utility Bill
  - Residental
  - Institutional