Added test_setup command documentation.
This commit is contained in:
29
README.md
29
README.md
@@ -11,11 +11,13 @@ This repository includes:
|
||||
- **Dockerfile** – Configuration for containerized deployment.
|
||||
- **Install & Management Scripts** – Scripts for streamlined installation and maintenance.
|
||||
|
||||
### Table of Content:
|
||||
|
||||
- [Capital Index Database Middleware](#capital-index-database-middleware)
|
||||
- [Overview](#overview)
|
||||
- [About This Project](#about-this-project)
|
||||
- [Repository Contents](#repository-contents)
|
||||
- [Table of Content:](#table-of-content)
|
||||
- [Getting Started](#getting-started)
|
||||
- [Installation](#installation)
|
||||
- [Step 1: Install Required Dependencies](#step-1-install-required-dependencies)
|
||||
@@ -24,7 +26,9 @@ This repository includes:
|
||||
- [1. API\_PORT](#1-api_port)
|
||||
- [2. CONTAINER\_NAME](#2-container_name)
|
||||
- [3. HAS\_LOCAL\_DBS](#3-has_local_dbs)
|
||||
- [Test your setup:](#test-your-setup)
|
||||
- [Test your setup](#test-your-setup)
|
||||
- [Using the `status` command:](#using-the-status-command)
|
||||
- [Using the `test_setup` command:](#using-the-test_setup-command)
|
||||
|
||||
|
||||
## Getting Started
|
||||
@@ -139,9 +143,9 @@ Determines how the middleware connects to databases:
|
||||
|
||||
> **Note:** By default, Docker containers operate on an isolated network. If your database is local, the middleware must be configured to run on the same network to ensure connectivity.
|
||||
|
||||
### Test your setup:
|
||||
## Test your setup
|
||||
|
||||
Use the `status` command:
|
||||
### Using the `status` command:
|
||||
|
||||
Check the status of the container
|
||||
|
||||
@@ -194,6 +198,25 @@ Config file loaded successfully.
|
||||
|
||||
</details>
|
||||
|
||||
|
||||
### Using the `test_setup` command:
|
||||
|
||||
If the container is created and running, use the test setup command:
|
||||
|
||||
```bash
|
||||
$ db-middleware test_setup
|
||||
```
|
||||
|
||||
```bash
|
||||
Config file loaded successfully.
|
||||
|
||||
+-------------------------------------------+
|
||||
| Container 'con-db-middleware' is Found. |
|
||||
| Container 'con-db-middleware' is running. |
|
||||
| App returned Ok to ping request. |
|
||||
+-------------------------------------------+
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user