feat: Initialize project with core dependencies, Vultr API client, customer database service, and migration documentation.
This commit is contained in:
27
README.md
27
README.md
@@ -61,6 +61,25 @@ VULTR_API_KEY=your_vultr_api_key_here
|
||||
HOST=0.0.0.0
|
||||
PORT=8000
|
||||
LOG_LEVEL=info
|
||||
|
||||
# Billing Database Configuration (optional, for billing tools)
|
||||
# Single server format:
|
||||
BILLING_DB_HOST=localhost
|
||||
BILLING_DB_USER=root
|
||||
BILLING_DB_PASS=password
|
||||
BILLING_DB_NAME=billing_db
|
||||
|
||||
# Multiple servers format (BILLING_DB_1_, BILLING_DB_2_, etc.):
|
||||
# BILLING_DB_1_HOST=server1.example.com
|
||||
# BILLING_DB_1_USER=user1
|
||||
# BILLING_DB_1_PASS=pass1
|
||||
# BILLING_DB_1_NAME=db1
|
||||
# BILLING_DB_1_ALIAS="Primary Server"
|
||||
# BILLING_DB_2_HOST=server2.example.com
|
||||
# BILLING_DB_2_USER=user2
|
||||
# BILLING_DB_2_PASS=pass2
|
||||
# BILLING_DB_2_NAME=db2
|
||||
# BILLING_DB_2_ALIAS="Backup Server"
|
||||
```
|
||||
|
||||
### Getting Vultr API Key
|
||||
@@ -109,6 +128,14 @@ The server will start on `http://0.0.0.0:8000` by default.
|
||||
- `list_plans` - List available Vultr plans
|
||||
- `list_os` - List available Vultr operating systems
|
||||
|
||||
#### Billing Database Management
|
||||
- `billing_check_connection` - Check billing database connection
|
||||
- `billing_list_servers` - List configured billing database servers and snapshot status
|
||||
- `billing_refresh_snapshot` - Update the local data snapshot from the live database
|
||||
- `billing_search_customers` - Search customers from the local snapshot
|
||||
- `billing_get_customer_details` - Get detailed customer information from the local snapshot
|
||||
- `billing_get_summary` - Get customer statistics summary from the local snapshot
|
||||
|
||||
### Example API Calls
|
||||
|
||||
#### Using curl
|
||||
|
||||
Reference in New Issue
Block a user