+
-
- 
@@ -36,30 +22,23 @@ | Using Docker | - Roadmap - | How To Contribute | - License
--- -This repo contains a [Mediator](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0046-mediators-and-relays/README.md) Agent for usage with [Hyperledger Aries and DIDComm v1 agents](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0004-agents). It is built using [Aries Framework JavaScript](https://github.com/hyperledger/aries-framework-javascript). +This repo contains a [Mediator](https://github.com/hyperledger/aries-rfcs/blob/main/concepts/0046-mediators-and-relays/README.md) Agent for usage with [Hyperledger Aries and DIDComm v1 agents](https://github.com/hyperledger/aries-rfcs/tree/main/concepts/0004-agents). It is built using [Credo](https://github.com/openwallet-foundation/credo-ts). Why should you use this mediator? - Automatically set up mediation with the mediator using the [Mediator Coordination Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0211-route-coordination). - Pick up messages implicitly using WebSockets, using the [Pickup V1 Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0212-pickup), and the [Pickup V2 Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0685-pickup-v2). - Configured to persist queued messages for recipient in a postgres. -- Use the pre-built docker image for easy deployment of your mediator. - -> **Warning** -> The repository is marked as the Animo **Development** Mediator because we have primarily used this repository for the publicly hosted Animo Development Mediator. There's nothing preventing it to be used in a production scenario, but it might needs some tweaks to make it production ready. We welcome contributions that work towards this effort, and we will try to make this repository more production ready in the future. ## Getting Started -> If you want to deploy the mediator based on the pre-built docker image, please see the [Using Docker](#using-docker) section. +> If you want to deploy the mediator based on the docker image, please see the [Using Docker](#using-docker) section. Install dependencies: @@ -91,7 +70,7 @@ When you've correctly started the mediator agent, and have extracted the invitat 2. Request mediation from the mediator using the [Mediator Coordination Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0211-route-coordination). 3. Start picking up messages implicitly by connecting using a WebSocket and sending any DIDComm message to authenticate, the [Pickup V1 Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0212-pickup), or the [Pickup V2 Protocol](https://github.com/hyperledger/aries-rfcs/tree/main/features/0685-pickup-v2). We recommend using the Pickup V2 Protocol. -If you're using an Aries Framework JavaScript agent as the client, you can follow the [Mediation Tutorial](https://aries.js.org/guides/next/tutorials/mediation) from the Aries Framework JavaScript docs. Please note, the tutorial points to the `next` version, which is for `0.4.0` at the time of writing. If the link stops working, please check the `0.4.0` docs for the tutorial. +If you're using an Credo agent as the client, you can follow the [Mediation Tutorial](https://credo.js.org/guides/0.5/tutorials/mediation) from the Credo docs. Please note, the tutorial points to the `next` version, which is for `0.5.0` at the time of writing. If the link stops working, please check the `0.5.0` docs for the tutorial. ## Environment Variables @@ -115,65 +94,23 @@ The `POSTGRES_` variables won't be used in development mode (`NODE_ENV=developme ## Postgres Database -To deploy the mediator, a postgres database is required. Any postgres database will do. The mediator deployed to `https://mediator.dev.animo.id` is deployed to a DigitalOcean managed postgres database. +To deploy the mediator, a postgres database is required. Any postgres database will do. 1. Create a postgres database and make sure it is publicly exposed. 2. Set the `POSTGRES_HOST`, `POSTGRES_USER`, `POSTGRES_PASSWORD`, `POSTGRES_ADMIN_USER`, `POSTGRES_ADMIN_PASSWORD` variables. For the mediator we use the same username and password for the admin user and the regular user, but you might want to create a separate user for the admin user. ## Using Docker -### Using the pre-built Docker Image - -1. Make sure you're [authenticated to the Github Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry#authenticating-to-the-container-registry) -2. Run the docker image using the following command: - -```sh -docker run \ - -e "AGENT_ENDPOINTS=http://localhost:3000,ws://localhost:3000" \ - -e "WALLET_KEY=