@mojaloop/connection-manager-api 3.5.0 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/README.md +28 -8
- package/package.json +2 -2
package/CHANGELOG.md
CHANGED
|
@@ -2,6 +2,13 @@
|
|
|
2
2
|
|
|
3
3
|
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
|
|
4
4
|
|
|
5
|
+
## [3.6.0](https://github.com/mojaloop/connection-manager-api/compare/v3.5.0...v3.6.0) (2026-01-15)
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
### Features
|
|
9
|
+
|
|
10
|
+
* add docker compose profiles (ci, dev, full) and developer docs ([#176](https://github.com/mojaloop/connection-manager-api/issues/176)) ([8523040](https://github.com/mojaloop/connection-manager-api/commit/85230405ed056af7e47639c7f0063a9b56c29c8f))
|
|
11
|
+
|
|
5
12
|
## [3.5.0](https://github.com/mojaloop/connection-manager-api/compare/v3.4.0...v3.5.0) (2026-01-15)
|
|
6
13
|
|
|
7
14
|
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Connection Manager API
|
|
2
2
|
|
|
3
|
-
[](https://github.com/mojaloop/connection-manager-api/actions/workflows/releaseWorkflow.yml)
|
|
4
4
|
|
|
5
5
|
Connection Manager API is a component of the Mojaloop ecosystem that allows an administrator to manage the network configuration and PKI information for the Hub and a set of DFSPs.
|
|
6
6
|
|
|
@@ -61,9 +61,29 @@ To run them together, you can use the following setup:
|
|
|
61
61
|
```bash
|
|
62
62
|
mkdir mojaloop
|
|
63
63
|
cd mojaloop
|
|
64
|
-
git clone https://github.com/
|
|
64
|
+
git clone https://github.com/mojaloop/connection-manager-api
|
|
65
65
|
cd connection-manager-api
|
|
66
|
-
docker compose --profile
|
|
66
|
+
docker compose --profile full up -d --wait
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
### Docker Compose Profiles
|
|
70
|
+
|
|
71
|
+
| Profile | API | UI | Use case |
|
|
72
|
+
|---------|----------------------|-----------|-----------------------|
|
|
73
|
+
| `ci` | container (local) | - | CI/CD, running tests |
|
|
74
|
+
| `dev` | proxy → host | container | Local API development |
|
|
75
|
+
| `full` | container (official) | container | Full environment |
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
# CI/CD (builds local image, runs tests)
|
|
79
|
+
docker compose --profile ci up -d --wait
|
|
80
|
+
|
|
81
|
+
# Local development (run API on host, UI in container)
|
|
82
|
+
docker compose --profile dev up -d --wait
|
|
83
|
+
npm start # run API locally
|
|
84
|
+
|
|
85
|
+
# Full environment
|
|
86
|
+
docker compose --profile full up -d --wait
|
|
67
87
|
```
|
|
68
88
|
|
|
69
89
|
### Accessing Services
|
|
@@ -100,15 +120,15 @@ To run multiple instances simultaneously:
|
|
|
100
120
|
|
|
101
121
|
```bash
|
|
102
122
|
# Instance 1 (default ports)
|
|
103
|
-
COMPOSE_PROJECT_NAME=mcm1 COMPOSE_DOMAIN=mcm1.localhost docker compose up -d
|
|
123
|
+
COMPOSE_PROJECT_NAME=mcm1 COMPOSE_DOMAIN=mcm1.localhost docker compose --profile full up -d
|
|
104
124
|
|
|
105
|
-
# Instance 2 (different
|
|
106
|
-
COMPOSE_PROJECT_NAME=mcm2 COMPOSE_DOMAIN=mcm2.localhost DATABASE_PORT=3307 docker compose up -d
|
|
125
|
+
# Instance 2 (different ports)
|
|
126
|
+
COMPOSE_PROJECT_NAME=mcm2 COMPOSE_DOMAIN=mcm2.localhost TRAEFIK_HTTP_PORT=8080 DATABASE_PORT=3307 docker compose --profile full up -d
|
|
107
127
|
```
|
|
108
128
|
|
|
109
129
|
Access via:
|
|
110
|
-
- Instance 1:
|
|
111
|
-
- Instance 2:
|
|
130
|
+
- Instance 1: http://mcm1.localhost, MySQL at `localhost:3306`
|
|
131
|
+
- Instance 2: http://mcm2.localhost:8080, MySQL at `localhost:3307`
|
|
112
132
|
|
|
113
133
|
See [.env-example](./.env-example) for all available configuration options.
|
|
114
134
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mojaloop/connection-manager-api",
|
|
3
|
-
"version": "3.
|
|
3
|
+
"version": "3.6.0",
|
|
4
4
|
"description": "Mojaloop Connection Manager API",
|
|
5
5
|
"license": "Apache-2.0",
|
|
6
6
|
"author": "ModusBox",
|
|
@@ -46,7 +46,7 @@
|
|
|
46
46
|
"migrate:rollback": "npm run knex-cli migrate:rollback",
|
|
47
47
|
"migrate:new": "npm run knex-cli migrate:make",
|
|
48
48
|
"knex-cli": "DOTENV_CONFIG_PATH=$(pwd)/.env npx knex --knexfile src/knexfile.js ",
|
|
49
|
-
"backend:start": "docker compose --profile
|
|
49
|
+
"backend:start": "docker compose --profile ci up -d --wait",
|
|
50
50
|
"backend:stop": "docker compose down -v",
|
|
51
51
|
"backend:restart": "npm run backend:stop && npm run backend:start"
|
|
52
52
|
},
|