Skip to content

Commit 8ecf80b

Browse files
authored
Update README.md
1 parent fc9e56d commit 8ecf80b

File tree

1 file changed

+25
-22
lines changed

1 file changed

+25
-22
lines changed

README.md

Lines changed: 25 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -2,32 +2,13 @@
22
<h1 align="center">Pro-test</h1>
33
<h2 align="center">A management base for System Admins</h2>
44

5-
### Continuous Integration
6-
![build](https://img.shields.io/github/actions/workflow/status/openprotest/protest/dotnet.yml?label=Build&style=for-the-badge)
7-
![code-analyze](https://img.shields.io/github/actions/workflow/status/openprotest/protest/codeql.yml?label=Analyze%20Back-end&style=for-the-badge)
8-
![code-analyze](https://img.shields.io/github/actions/workflow/status/openprotest/protest/codeql-front.yml?label=Analyze%20Front-end&style=for-the-badge)
9-
10-
### Release
11-
![License](https://img.shields.io/github/license/openprotest/protest?style=for-the-badge)
12-
![Release](https://img.shields.io/github/release/openprotest/protest?style=for-the-badge)
13-
![Commits since](https://img.shields.io/github/commits-since/openprotest/protest/latest?style=for-the-badge)
14-
![Downloads](https://img.shields.io/github/downloads/openprotest/protest/total?style=for-the-badge)
15-
16-
### Platform support
17-
![Windows](https://img.shields.io/badge/Windows-0078D6?logo=windows&style=for-the-badge)
18-
![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=222&style=for-the-badge)
19-
![MacOS](https://shields.io/badge/Mac%20OS-ccc?logo=Apple&logoColor=222&style=for-the-badge)
20-
21-
### Repo components:
22-
- **Protest:** The front-end and back-end workings.
23-
- **Protest-CacheGenerator:** A source-generator that embeds the front-end web application within the binary executable.
24-
- **Protest Agent:** A tool to enable the browser talk to the client's computer using a local communication protocol (`protest://`).
25-
265
### Overview:
276
Pro-test is a robust solution for creating and managing an inventory database of your network environment.
287
It leverages data collection techniques by interacting with Active Directory or performing local network scans.
298
The suite automatically populates the database by targeting the domain controller or specified IP ranges.
309

10+
**Pro-test provides complite data ownership, with all collected data remaining fully under your control.**
11+
3112
<p align="center"><img src="https://raw.githubusercontent.com/openprotest/openprotest.github.io/refs/heads/main/screenshot.png" /></p>
3213

3314
### How to use:
@@ -36,7 +17,7 @@ If you need to run it remotely, the included `Reverse proxy` allows for external
3617
Authentication is required for requests originating from IPs other than the loopback address.
3718
If you opt to use a different reverse proxy, ensure that the `X-Real-IP` header is forwarded.
3819
If Pro-test fails to bind to the configured endpoint, it will attempt to bind to a fallback endpoint `127.0.0.1:8080`.
39-
Pro-test operates with the access level of the user executing it. To utilize protocols such as WMI and Active Directory services, it must be run as a Network Administrator.
20+
Pro-test runs with the privileges of the user executing it. For administrative tasks like WMI or Active Directory access, it must be run with Network Administrator privileges.
4021

4122
### Tools and utilities:
4223
Pro-test includes a wide range of tools and utilities designed for system administration and network management:
@@ -67,6 +48,28 @@ Pro-test includes a wide range of tools and utilities designed for system admini
6748
- Address book
6849
- Integrated team chat
6950

51+
### Repo components:
52+
- **Protest:** The front-end and back-end workings.
53+
- **Protest-CacheGenerator:** A source-generator that embeds the front-end UI into the backend executable.
54+
- **Protest-MacLookupGenerator:** A source-generator that embeds the the mac-to-vendor database into the executable.
55+
- **Protest Agent:** A tool to enable the browser to communicate with the client's computer using a local communication protocol (`protest://`).
56+
-
57+
### Continuous Integration
58+
![build](https://img.shields.io/github/actions/workflow/status/openprotest/protest/dotnet.yml?label=Build&style=for-the-badge)
59+
![code-analyze](https://img.shields.io/github/actions/workflow/status/openprotest/protest/codeql.yml?label=Analyze%20Back-end&style=for-the-badge)
60+
![code-analyze](https://img.shields.io/github/actions/workflow/status/openprotest/protest/codeql-front.yml?label=Analyze%20Front-end&style=for-the-badge)
61+
62+
### Release
63+
![License](https://img.shields.io/github/license/openprotest/protest?style=for-the-badge)
64+
![Release](https://img.shields.io/github/release/openprotest/protest?style=for-the-badge)
65+
![Commits since](https://img.shields.io/github/commits-since/openprotest/protest/latest?style=for-the-badge)
66+
![Downloads](https://img.shields.io/github/downloads/openprotest/protest/total?style=for-the-badge)
67+
68+
### Platform support
69+
![Windows](https://img.shields.io/badge/Windows-0078D6?logo=windows&style=for-the-badge)
70+
![Linux](https://img.shields.io/badge/Linux-FCC624?logo=linux&logoColor=222&style=for-the-badge)
71+
![MacOS](https://shields.io/badge/Mac%20OS-ccc?logo=Apple&logoColor=222&style=for-the-badge)
72+
7073
### Sponsor:
7174
*[![Sponsor](https://img.shields.io/badge/Sponsor%20on%20GitHub-374046?style=for-the-badge&logo=github)](https://github.com/sponsors/veniware)*
7275
*[![Donate](https://img.shields.io/badge/Donate-00457C?style=for-the-badge&logo=paypal)](https://www.paypal.com/paypalme/veniware)*

0 commit comments

Comments
 (0)