|
1 | 1 | # Conduit Console |
2 | 2 |
|
3 | | - |
| 3 | + |
4 | 4 |  |
| 5 | + |
5 | 6 |  |
6 | | - |
7 | 7 |
|
8 | | -> **Professional Management Console** > A high-performance, bash-based tool to manage, monitor, and optimize Native (Systemd) and Docker instances. |
9 | | -> *Developed & Maintained by [Babak Sorkhpour](https://github.com/babakskr)* |
| 8 | +> **Professional Management Console** > A unified console to manage Native (Systemd) and Docker instances. |
| 9 | +> *Developed by Babak Sorkhpour* |
10 | 10 |
|
11 | 11 | --- |
12 | 12 |
|
|
15 | 15 | - [Installation](#-installation) |
16 | 16 | - [Tools Reference](#-tools-reference) |
17 | 17 | - [Configuration](#-configuration) |
18 | | -- [Development Guidelines](#-development-guidelines) |
| 18 | +- [Release Management](#-release-management) |
19 | 19 |
|
20 | 20 | --- |
21 | 21 |
|
22 | | -## 🚀 Installation |
| 22 | +## 📂 Project Structure (Manifest) |
23 | 23 |
|
24 | | -### Prerequisites |
25 | | -* **OS:** Linux (Ubuntu/Debian) |
26 | | -* **User:** Root privileges required. |
27 | | -* **Dependencies:** `curl`, `git`, `docker` (optional). |
| 24 | +### 🔹 Core Components |
| 25 | +| File | Ver | Description | |
| 26 | +| :--- | :--- | :--- | |
| 27 | +| `conduit-console.sh` | v0.2.19 | No description provided. | |
| 28 | +| `conduit-optimizer.sh` | v1.8.2 | Adjusts CPU (Nice) and I/O priorities for Conduit instances to prevent lag. | |
28 | 29 |
|
29 | | -### Quick Start |
30 | | -```bash |
31 | | -# 1. Clone the repository |
32 | | -git clone https://github.com/babakskr/Conduit-console |
33 | | -cd Conduit-console |
| 30 | +### 🔹 Utilities & Automation |
| 31 | +| File | Ver | Description | |
| 32 | +| :--- | :--- | :--- | |
| 33 | +| `git_op.sh` | v2.4.0 | Automates version control, README generation, deletions, and GitHub releases. | |
34 | 34 |
|
35 | | -# 2. Set permissions |
36 | | -chmod +x *.sh |
37 | | - |
38 | | -# 3. Run the Main Console |
39 | | -sudo ./conduit-console.sh |
40 | | -``` |
| 35 | +### 🔹 Documentation & Config |
| 36 | +| File | Description | |
| 37 | +| :--- | :--- | |
| 38 | +| `AI_DEV_GUIDELINES.md` | - | |
| 39 | +| `docs/AI_HANDOFF.md` | No description provided. | |
| 40 | +| `docs/KNOWN_RISKS.md` | No description provided. | |
| 41 | +| `.github/workflows/ci-bash.yml` | No description provided. | |
| 42 | +| `.github/workflows/release.yml` | No description provided. | |
41 | 43 |
|
42 | 44 | --- |
43 | 45 |
|
44 | | -## 🛠 Tools Reference |
| 46 | +## 🚀 Installation |
45 | 47 |
|
46 | | -### 1. Main Console (`conduit-console.sh`) |
47 | | -**Description:** The central hub for monitoring traffic, managing services, and viewing logs. |
48 | | -**Usage:** |
| 48 | +### Quick Setup |
49 | 49 | ```bash |
| 50 | +git clone https://github.com/babakskr/Conduit-console |
| 51 | +cd Conduit-console |
| 52 | +chmod +x *.sh |
50 | 53 | sudo ./conduit-console.sh |
51 | 54 | ``` |
52 | | -**Key Features:** |
53 | | -* Real-time Traffic Dashboard (HTOP style). |
54 | | -* Auto-detection of Systemd services and Docker containers. |
55 | | -* Zero-dependency architecture. |
56 | | - |
57 | | -### 2. Performance Optimizer (`conduit-optimizer.sh`) |
58 | | -**Description:** Adjusts CPU/IO priorities to prevent system lag under load. |
59 | | -**Usage:** |
60 | | -```bash |
61 | | -# Automatic Mode (Recommended) |
62 | | -sudo ./conduit-optimizer.sh |
63 | | - |
64 | | -# Manual Mode (Custom Priorities) |
65 | | -sudo ./conduit-optimizer.sh -dock 5 -srv 10 |
66 | | -``` |
67 | | - |
68 | | -### 3. Release Manager (`git_op.sh`) |
69 | | -**Description:** Automates versioning, documentation generation, and GitHub releases. |
70 | | -**Usage:** |
71 | | -```bash |
72 | | -./git_op.sh # Create a full release |
73 | | -./git_op.sh -l # Check project status |
74 | | -``` |
75 | 55 |
|
76 | 56 | --- |
77 | 57 |
|
78 | | -## ⚙️ Configuration |
79 | | - |
80 | | -The project uses a central configuration file `project.conf`. |
81 | | -You can customize the project name, repository URL, and defaults by editing this file. |
82 | | - |
83 | | -```bash |
84 | | -nano project.conf |
85 | | -``` |
86 | | - |
87 | | ---- |
88 | | - |
89 | | -## 📚 Development Guidelines |
90 | | - |
91 | | -We follow strict strict coding standards to ensure stability and security. |
92 | | -Please refer to the following documents before contributing: |
| 58 | +## 🔄 Release Management |
93 | 59 |
|
94 | | -* **[AI_DEV_GUIDELINES.md](AI_DEV_GUIDELINES.md):** The "Constitution" for AI assistants and developers. |
95 | | -* **[KNOWN_RISKS.md](KNOWN_RISKS.md):** Registry of known bugs and required guards. |
96 | | -* **[AI_HANDOFF.md](AI_HANDOFF.md):** Operational log for development continuity. |
| 60 | +| Command | Action | |
| 61 | +| :--- | :--- | |
| 62 | +| `./git_op.sh main` | **Full Release:** Merge to main, Update README, Tag, Push. | |
| 63 | +| `./git_op.sh -d <file>` | **Delete:** Remove file locally and remotely. | |
97 | 64 |
|
98 | 65 | --- |
99 | | -*Last Updated: Thu Jan 29 09:44:30 PM UTC 2026* *© 2026 Babak Sorkhpour. All Rights Reserved.* |
| 66 | +*Generated by Git Operations Manager v2.4.0 on Thu Jan 29 09:55:50 PM UTC 2026* |
0 commit comments