Update README

This commit is contained in:
Raven 2024-08-09 03:54:33 -04:00
parent fdf370fbb8
commit 8a9f6e9a31
5 changed files with 18 additions and 2 deletions

View File

@ -1,3 +1,7 @@
Here is the updated version of the README with the screenshots section added:
---
# AI NGINX Log Analysis # AI NGINX Log Analysis
## Overview ## Overview
@ -12,6 +16,15 @@ This project is an Express.js-based server designed to interact with models via
- **Core Service Management**: Provides endpoints to restart the core GPT service and reset conversation histories. - **Core Service Management**: Provides endpoints to restart the core GPT service and reset conversation histories.
- **Cross-Origin Resource Sharing (CORS)**: Enabled for all routes, allowing for flexible API usage. - **Cross-Origin Resource Sharing (CORS)**: Enabled for all routes, allowing for flexible API usage.
## Screenshots
Here are some screenshots of the application in action:
- ![Screenshot 1](screenshots/s1.png)
- ![Screenshot 2](screenshots/s2.png)
- ![Screenshot 3](screenshots/s3.png)
- ![Screenshot 4](screenshots/s4.png)
## Installation ## Installation
**Note**: A `llama-cpp-python` OpenAI Emulation Server is required alongside the backend server. The server in this code is configured to run on `127.0.0.1:8003`. **Note**: A `llama-cpp-python` OpenAI Emulation Server is required alongside the backend server. The server in this code is configured to run on `127.0.0.1:8003`.
@ -81,9 +94,12 @@ The server logs key actions, including incoming requests, conversation history m
- Ensure the `llama-gpu-server` Docker container is running before starting the Express.js server. - Ensure the `llama-gpu-server` Docker container is running before starting the Express.js server.
- Conversation history is stored in memory and will be lost when the server restarts. Consider implementing persistent storage if long-term history is required. - Conversation history is stored in memory and will be lost when the server restarts. Consider implementing persistent storage if long-term history is required.
## Contributions ## Contributions
Contributions are welcome! Please fork the repository and submit a pull request with your changes. Contributions are welcome! Please fork the repository and submit a pull request with your changes.
This project leverages cutting-edge AI to enhance web security analysis, making it easier to identify and respond to threats in real-time. This project leverages cutting-edge AI to enhance web security analysis, making it easier to identify and respond to threats in real-time.
---
Let me know if you need any further changes!

BIN
screenshots/s1.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

BIN
screenshots/s2.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

BIN
screenshots/s3.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

BIN
screenshots/s4.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB