|
6 | 6 | <strong>Quickly collect server information and generate detailed reports</strong> |
7 | 7 | </div> |
8 | 8 |
|
| 9 | +<div align="center"> |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | +**GitHub Repository:** [jayscoder/server-analyzer](https://github.com/jayscoder/server-analyzer) |
| 16 | +**Latest Version:** [v1.2.0](https://github.com/jayscoder/server-analyzer/releases/tag/v1.2.0) |
| 17 | + |
| 18 | +</div> |
| 19 | + |
9 | 20 | <p align="center"> |
10 | 21 | <a href="README.md">中文</a> | |
11 | 22 | <a href="README_EN.md">English</a> | |
12 | 23 | <a href="README_JA.md">日本語</a> | |
13 | 24 | <a href="README_ES.md">Español</a> |
14 | 25 | </p> |
15 | 26 |
|
16 | | -## Overview |
| 27 | +## 📋 Overview |
17 | 28 |
|
18 | 29 | Server Analyzer is a powerful Bash script that quickly collects various system information from Linux/Unix servers and generates formatted reports. The tool is designed for system administrators, DevOps engineers, and AI engineers to help them quickly understand server configurations and status. |
19 | 30 |
|
20 | | -### Key Features |
| 31 | +### ✨ Key Features |
21 | 32 |
|
22 | | -- **Comprehensive Information Collection**: Collects hardware information about CPU, memory, storage, network, GPU, etc. |
23 | | -- **Software Environment Detection**: Detects operating systems, installed services, Docker containers, and programming language environments |
24 | | -- **Security Status Analysis**: Checks firewall status, SSH configuration, and basic security settings |
25 | | -- **AI Framework Support**: Detects common AI frameworks such as Ollama, PyTorch, TensorFlow, etc. |
26 | | -- **Multi-format Reports**: Supports generating detailed reports in Markdown or HTML format |
27 | | -- **Local/Remote Mode**: Supports analyzing local servers or remote servers via SSH |
| 33 | +- 🖥️ **Comprehensive Information Collection**: Collects hardware information about CPU, memory, storage, network, GPU, etc. |
| 34 | +- 🔍 **Software Environment Detection**: Detects operating systems, installed services, Docker containers, and programming language environments |
| 35 | +- 🔒 **Security Status Analysis**: Checks firewall status, SSH configuration, and basic security settings |
| 36 | +- 🤖 **AI Framework Support**: Detects common AI frameworks such as Ollama, PyTorch, TensorFlow, etc. |
| 37 | +- 📊 **Multi-format Reports**: Supports generating detailed reports in Markdown or HTML format |
| 38 | +- 🌐 **Local/Remote Mode**: Supports analyzing local servers or remote servers via SSH |
28 | 39 |
|
29 | | -## Using Reports as AI Model Context |
| 40 | +## 🧠 Using Reports as AI Model Context |
30 | 41 |
|
31 | 42 | The generated reports are well-formatted and information-rich, making them ideal as context information for large language models. You can: |
32 | 43 |
|
33 | 44 | 1. Upload the generated reports directly to AI models (such as ChatGPT, Claude, etc.) |
34 | 45 | 2. Have AI models provide customized optimization suggestions based on actual server conditions |
35 | 46 | 3. Use the reports to assist AI in more accurate server configuration, optimization, and troubleshooting |
36 | 47 |
|
37 | | -## Installation Methods |
| 48 | +## 📥 Installation Methods |
38 | 49 |
|
39 | | -### Direct Download |
| 50 | +### Method 1: Direct Download |
40 | 51 |
|
41 | 52 | ```bash |
42 | | -curl -o server_analyzer.sh https://raw.githubusercontent.com/username/server-analyzer/main/server_analyzer.sh |
| 53 | +curl -o server_analyzer.sh https://raw.githubusercontent.com/jayscoder/server-analyzer/main/server_analyzer.sh |
43 | 54 | chmod +x server_analyzer.sh |
44 | 55 | ``` |
45 | 56 |
|
46 | | -### Download from Releases |
| 57 | +### Method 2: Download from Releases |
47 | 58 |
|
48 | | -Visit the [Releases page](https://github.com/username/server-analyzer/releases) to download the latest version. |
| 59 | +Visit the [Releases page](https://github.com/jayscoder/server-analyzer/releases) to download the latest version. |
49 | 60 |
|
50 | | -## Usage |
| 61 | +### Method 3: Clone Repository |
| 62 | + |
| 63 | +```bash |
| 64 | +git clone [email protected]:jayscoder/server-analyzer.git |
| 65 | +cd server-analyzer |
| 66 | +chmod +x server_analyzer.sh |
| 67 | +``` |
| 68 | + |
| 69 | +## 🚀 Usage |
51 | 70 |
|
52 | 71 | ### Basic Usage |
53 | 72 |
|
@@ -83,24 +102,42 @@ Generate an HTML format report: |
83 | 102 | ./server_analyzer.sh -f html -o server_report.html |
84 | 103 | ``` |
85 | 104 |
|
86 | | -## Report Content |
| 105 | +## 📊 Report Content |
87 | 106 |
|
88 | 107 | The generated reports include the following main sections: |
89 | 108 |
|
90 | | -- **Basic Information**: Hostname, IP address, operating system, kernel version, etc. |
91 | | -- **Hardware Configuration**: CPU, memory, storage devices, and GPU information |
92 | | -- **Network Configuration**: Network interfaces, public IP, open ports, etc. |
93 | | -- **Software and Services**: System services, Docker containers, programming language environments, etc. |
94 | | -- **AI Frameworks**: Detection of Ollama, PyTorch, TensorFlow, and other AI frameworks |
95 | | -- **Performance and Resource Usage**: System load, processes with highest resource usage, etc. |
96 | | -- **Security Information**: Firewall status, SSH configuration, SELinux status, etc. |
97 | | -- **User Information**: Currently logged-in users, users with administrative privileges, etc. |
98 | | -- **Conclusions and Recommendations**: Suggestions based on collected information |
| 109 | +| Section | Content | |
| 110 | +| ----------------------------------- | --------------------------------------------------------------------------- | |
| 111 | +| **Basic Information** | Hostname, IP address, operating system, kernel version, etc. | |
| 112 | +| **Hardware Configuration** | CPU, memory, storage devices, and GPU information | |
| 113 | +| **Network Configuration** | Network interfaces, public IP, open ports, etc. | |
| 114 | +| **Software and Services** | System services, Docker containers, programming language environments, etc. | |
| 115 | +| **AI Frameworks** | Detection of Ollama, PyTorch, TensorFlow, and other AI frameworks | |
| 116 | +| **Performance and Resource Usage** | System load, processes with highest resource usage, etc. | |
| 117 | +| **Security Information** | Firewall status, SSH configuration, SELinux status, etc. | |
| 118 | +| **User Information** | Currently logged-in users, users with administrative privileges, etc. | |
| 119 | +| **Conclusions and Recommendations** | Suggestions based on collected information | |
| 120 | + |
| 121 | +## 🔧 Dependencies |
| 122 | + |
| 123 | +The tool will attempt to use the following commands (if available) to collect more information: |
| 124 | + |
| 125 | +- Basic commands: `ps`, `grep`, `awk`, `free`, `df`, `top`, etc. |
| 126 | +- Network analysis: `netstat` or `ss`, `curl`, `speedtest-cli` |
| 127 | +- GPU analysis: `nvidia-smi` (NVIDIA GPU), `rocm-smi` (AMD GPU), `npu-smi` (Huawei Ascend) |
| 128 | +- Programming environments: `python`/`python3`, `conda`, `node`, `npm`, `java` |
| 129 | +- AI frameworks: `ollama`, PyTorch, TensorFlow, ONNX Runtime |
| 130 | + |
| 131 | +## 📝 License |
99 | 132 |
|
100 | | -## License |
| 133 | +[MIT License](LICENSE) |
101 | 134 |
|
102 | | -MIT License |
| 135 | +## 👥 Contribution |
103 | 136 |
|
104 | | -## Contribution |
| 137 | +Issues and Pull Requests are welcome! You can participate in the project by: |
105 | 138 |
|
106 | | -Issues and Pull Requests are welcome! |
| 139 | +1. Forking the repository |
| 140 | +2. Creating your feature branch (`git checkout -b feature/amazing-feature`) |
| 141 | +3. Committing your changes (`git commit -m 'Add some amazing feature'`) |
| 142 | +4. Pushing to the branch (`git push origin feature/amazing-feature`) |
| 143 | +5. Opening a Pull Request |
0 commit comments