eric/onix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated local setup instruction in readme and setup.md files

Browse Source
This commit is contained in:
ameersohel45
2025-10-14 16:42:23 +05:30
parent 4974c6a465
commit e569cd670c
2 changed files with 21 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@@ -205,23 +205,28 @@ This automated script will:
- Start ONIX adapter in Docker - Start ONIX adapter in Docker
- Create environment configuration - Create environment configuration
**Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) **Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) and before running the automated setup, build the adapter image ,update docker-compose-adapter2.yaml to use the correct image
```bash
# from the repository root
docker build -f Dockerfile.adapter-with-plugins -t beckn-onix:latest .
```
**Services Started:** **Services Started:**
- Redis: localhost:6379 - Redis: localhost:6379
- ONIX Adapter: http://localhost:8081 - ONIX Adapter: http://localhost:8081
### Docker Deployment ### Docker Deployment
**Note:** Start redis before before running onix adapter.
```bash ```bash
# Build the Docker image # Build the Docker image
docker build -f Dockerfile.adapter -t beckn-onix:latest . docker build -t beckn-onix:latest -f Dockerfile.adapter-with-plugins .
# Run the container # Run the container
docker run -p 8081:8081 \ docker run -p 8081:8081 \
-v $(pwd)/config:/app/config \ -v $(pwd)/config:/app/config \
-v $(pwd)/schemas:/app/schemas \ -v $(pwd)/schemas:/app/schemas \
-v $(pwd)/plugins:/app/plugins \
-e CONFIG_FILE="/app/config/local-simple.yaml" \ -e CONFIG_FILE="/app/config/local-simple.yaml" \
beckn-onix:latest beckn-onix:latest
``` ```

16
SETUP.md
View File

@@ -88,7 +88,12 @@ This will automatically:
**Key Management:** Uses `simplekeymanager` with embedded keys - no Vault setup required! **Key Management:** Uses `simplekeymanager` with embedded keys - no Vault setup required!
**Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) **Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) and before running the automated setup, build the adapter image ,update docker-compose-adapter2.yaml to use the correct image
```bash
# from the repository root
docker build -f Dockerfile.adapter-with-plugins -t beckn-onix:latest .
```
### Option 2: Complete Beckn Network ### Option 2: Complete Beckn Network
@@ -120,12 +125,17 @@ This will automatically:
- ONIX Adapter: http://localhost:8081 - ONIX Adapter: http://localhost:8081
- Redis: localhost:6379 - Redis: localhost:6379
**Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) **Note:** Extract schemas before running: `unzip schemas.zip` (required for schema validation) and before running the automated full-network setup, build the adapter image , update docker-compose-adapter2.yaml to use the correct image
```bash
# from the repository root
docker build -f Dockerfile.adapter-with-plugins -t beckn-onix:latest .
```
**Intelligent Key Management:** **Intelligent Key Management:**
The script reads `docker-compose-adapter2.yml` to detect which config file is being used (default: `local-simple.yaml`), extracts keys from protocol server configs, and automatically updates the `simplekeymanager` section in that config file - no manual configuration needed! The script reads `docker-compose-adapter2.yml` to detect which config file is being used (default: `local-simple.yaml`), extracts keys from protocol server configs, and automatically updates the `simplekeymanager` section in that config file - no manual configuration needed!
**Note:** Update `docker-compose-adapter2.yml` to use the correct config file: **Note:** Update `docker-compose-adapter2.yml` to use the correct config file and correct image:
- For combined setup (simplekeymanager): `CONFIG_FILE: "/app/config/local-simple.yaml"` - For combined setup (simplekeymanager): `CONFIG_FILE: "/app/config/local-simple.yaml"`
- For combined setup (keymanager with Vault): `CONFIG_FILE: "/app/config/local-dev.yaml"` - For combined setup (keymanager with Vault): `CONFIG_FILE: "/app/config/local-dev.yaml"`
- For combined setup (production): `CONFIG_FILE: "/app/config/onix/adapter.yaml"` - For combined setup (production): `CONFIG_FILE: "/app/config/onix/adapter.yaml"`