Skip to content

Latest commit

 

History

History
87 lines (62 loc) · 4.48 KB

AdminGuide.md

File metadata and controls

87 lines (62 loc) · 4.48 KB

DIDComm mediator admin guide

Management command

There is management command manage in container to operate with database records, settings, user account. Much of these commands duplicate features of Admin Web page

  • Generate seed (to restore mediator did, verkey, secrets)

    • in container: manage generate_seed
    • out of container: docker-compose run --rm application manage generate_seed

  • Create superuser: enter Admin account username and password via console prompt

    • in container: manage create_superuser
    • out of container: docker-compose run --rm application manage create_superuser

  • Check configs and environment: detect issues, potential drawbacks and errors in environment variables configuration and

    • in container: manage check
    • out of container: docker-compose run --rm application manage check

  • Reset user accounts and settings stored in database

    • in container: manage reset
    • out of container: docker-compose run --rm application manage reset

  • Reload internal services like nginx when settings was updated

    • in container: manage reload
    • out of container: docker-compose run --rm application manage reload

WebRoot

Suppose mediator provide for AgentX endpoint with public URL https://mediator-service.com/e/xxx. That mean AgentX accessible for outer world by this address and any participant AgentY can communicate with AgentX in DIDComm manner

In example above https://mediator-service.com is Webroot, it is DNS-specific name of server to make it visible all over internet, it is static part of endpoint addresses with dynamic nature.

Typing right webroot value is critical part to achieve serviceable endpoints

There are two ways to configure webroot:

  1. Pass environment variable WEBROOT to docker container
  2. Configure with Admin page

Notice: environment variable has more priority, so if you have earlier configured webroot via admin page, value provided with env var will replace it

Grant endpoint address

See interoperability protocols details:

  • RFC 0160: establish P2P connection
  • RFC 0211: allocate endpoint address by client and maintain routing keys

Scaling

This app is ready to scale up via multiple redis instances and application instances. You may deploy app and redis in any docker orchestration environment. You should declare array of redis instances as comma separated list of redis addresses with MSG_DELIVERY_SERVICES environment variable.

Endpoint messages routing You can increase your system availability with increase redis and app instances

Redis health-check Example of health-checking for delivering via Redis

Environment variables

Critical variables:

  • MEMCACHED: address of memcached server (caching user sessions and cache database read ops)
  • MSG_DELIVERY_SERVICES: comma-separated list of message delivery service addresses, for example redis://192.168.1.10,redis://192.168.1.11
  • DATABASE_HOST: address of Postgres server
  • DATABASE_NAME: name of Postgres database
  • DATABASE_USER: username of Postgres database
  • DATABASE_PASSWORD: user password with write privileges to Postgres database
  • SEED: secret seed to generate persistent public key and private key of Mediator App. Notice, for the same seed you will get const keys, so keep this value in secret.

Optional variables:

  • DATABASE_PORT: database port, by default default postgres port 5432
  • WEBROOT: DNS-specific address of server with Mediator App running.
  • LABEL: Label that application will public in invitations.
  • FCM_API_KEY, FCM_SENDER_ID: Firebase cloud messaging Server API Keys to make able route traffic to mobile devices even OS Power-Save mode suspend Agent application on device.
  • CERT_FILE, CERT_KEY_FILE: SSL certificate and cert private key files
  • ACME_DIR: directory for Lets Encrypt certbot utility
  • ELK: set to on if you desire json formatted logs