Added available commands.
This commit is contained in:
64
README.md
64
README.md
@@ -11,6 +11,10 @@ This repository includes:
|
|||||||
- **Dockerfile** – Configuration for containerized deployment.
|
- **Dockerfile** – Configuration for containerized deployment.
|
||||||
- **Install & Management Scripts** – Scripts for streamlined installation and maintenance.
|
- **Install & Management Scripts** – Scripts for streamlined installation and maintenance.
|
||||||
|
|
||||||
|
**Check [Legal \& Licensing](#legal--licensing)**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
### Table of Content:
|
### Table of Content:
|
||||||
|
|
||||||
|
|
||||||
@@ -34,6 +38,12 @@ This repository includes:
|
|||||||
- [Expose the API](#expose-the-api)
|
- [Expose the API](#expose-the-api)
|
||||||
- [Using Nginx](#using-nginx)
|
- [Using Nginx](#using-nginx)
|
||||||
- [Using Apache](#using-apache)
|
- [Using Apache](#using-apache)
|
||||||
|
- [🚀 Available Commands](#-available-commands)
|
||||||
|
- [🛠️ Source Code Management](#️-source-code-management)
|
||||||
|
- [🚦 App Running](#-app-running)
|
||||||
|
- [👥 User Management](#-user-management)
|
||||||
|
- [⚙️ Configuration](#️-configuration)
|
||||||
|
- [📚 Help](#-help)
|
||||||
- [Legal \& Licensing](#legal--licensing)
|
- [Legal \& Licensing](#legal--licensing)
|
||||||
- [⚠️ Important Legal Notice](#️-important-legal-notice)
|
- [⚠️ Important Legal Notice](#️-important-legal-notice)
|
||||||
|
|
||||||
@@ -432,6 +442,60 @@ sudo systemctl restart nginx
|
|||||||
sudo certbot renew --dry-run
|
sudo certbot renew --dry-run
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## 🚀 Available Commands
|
||||||
|
|
||||||
|
Organized by functionality to help you navigate easily.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🛠️ Source Code Management
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---------------|-----------------------------------------------------------------------------|
|
||||||
|
| `install` | Initializes the environment using `setup.sh`. Builds the image and setup scripts. |
|
||||||
|
| `update_code` | Updates local code (`~/.db-middleware/code`) and inside the container. |
|
||||||
|
| `upgrade` | Pulls latest code, rebuilds image, replaces container if updates exist. |
|
||||||
|
| `rebuild` | Rebuilds the image with the current local repository code. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 🚦 App Running
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---------------|-----------------------------------------------------------------------------|
|
||||||
|
| `status` | Displays container status and related info. |
|
||||||
|
| `test_setup` | Validates setup: checks image, container, and ping endpoint. |
|
||||||
|
| `start` | Starts the container if stopped or creates it if missing. |
|
||||||
|
| `restart` | Restarts the container or creates a new one if not found. |
|
||||||
|
| `stop` | Stops the container if it's currently running. |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 👥 User Management
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|-----------------|-----------------------------------------------------|
|
||||||
|
| `create_user` | Creates a user. Prompts for username and role (`admin`/`user`). |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### ⚙️ Configuration
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|-----------------|-----------------------------------------------------------|
|
||||||
|
| `show_config` | Displays the current configuration settings. |
|
||||||
|
| `update_config` | Walks you through updating configuration values. See [Configuration](#configuration). |
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
### 📚 Help
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---------|---------------------------------------|
|
||||||
|
| `help` | Lists all available commands with info. |
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Legal & Licensing
|
## Legal & Licensing
|
||||||
### ⚠️ Important Legal Notice
|
### ⚠️ Important Legal Notice
|
||||||
This software is NOT open source. You are not permitted to use, copy, modify, distribute, sublicense, or sell this software unless explicitly authorized in writing by the original author under a signed agreement.
|
This software is NOT open source. You are not permitted to use, copy, modify, distribute, sublicense, or sell this software unless explicitly authorized in writing by the original author under a signed agreement.
|
||||||
|
|||||||
Reference in New Issue
Block a user