update docs

This commit is contained in:
Shihaam Abdul Rahman 2025-01-10 08:10:59 +05:00
parent a72f22b9a4
commit 37dfe7e261
Signed by: shihaam
GPG Key ID: 6DA2E87EBC227636
4 changed files with 14 additions and 4 deletions

View File

@ -6,6 +6,8 @@ PROFILE_ID=
PROFILE_TYPE= PROFILE_TYPE=
ACCOUNT_NUMBER= ACCOUNT_NUMBER=
COOKIE_SERVER=http://cookieserver:5000
APP_DEBUG=true APP_DEBUG=true
## This valu is for time difference between request json and actual time of the transacation (+ or -) in mins, 5 or 10 is probably a good value ## This valu is for time difference between request json and actual time of the transacation (+ or -) in mins, 5 or 10 is probably a good value

View File

@ -8,15 +8,20 @@
## How to deploy/get started (with docker/podman) ## How to deploy/get started (with docker/podman)
1. Login to MIB web [https://faisanet.mib.com.mv/](https://faisanet.mib.com.mv/) and get the cookie: 1. Login to MIB web [https://faisanet.mib.com.mv/](https://faisanet.mib.com.mv/) and get the your profile id and type:
![get_cookie_env.jpg](get_cookie_env.jpg) ![select_profile.jpg](select_profile.jpg)
2. copy .env.example to .env and fill `QL_0` and `IBSID` with contents from step 1, Make sure to fill `ACCOUNT_NUMBER` with your account number. 2. copy .env.example to .env and fill your MIB Username, Password and TOTP Seed, `PROFILE_ID` and `PROFILE_TYPE` needs to be filled with contents from step 1, Make sure to fill `ACCOUNT_NUMBER` with your account number.
3. Create `compose.yml` with the follwing contents: 3. Create `compose.yml` with the follwing contents:
```yaml ```yaml
services: services:
keepalive: keepalive:
env_file: .env env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/keepalive image: git.shihaam.dev/shihaam/mib-payment-verify/keepalive
cookieserver:
env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/cookieserver
api: api:
env_file: .env env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/api image: git.shihaam.dev/shihaam/mib-payment-verify/api
@ -24,7 +29,7 @@ services:
- 5000:5000 - 5000:5000
``` ```
3. Run `docker compose up -d` and that is all. 4. Run `docker compose up -d` and that is all.
## Using the API with curl examples: ## Using the API with curl examples:

View File

@ -2,6 +2,9 @@ services:
keepalive: keepalive:
env_file: .env env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/keepalive image: git.shihaam.dev/shihaam/mib-payment-verify/keepalive
cookieserver:
env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/cookieserver
api: api:
env_file: .env env_file: .env
image: git.shihaam.dev/shihaam/mib-payment-verify/api image: git.shihaam.dev/shihaam/mib-payment-verify/api

BIN
select_profile.jpg Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB