Skip to content

Commit 009c74e

Browse files
authored
Update README.md
1 parent 68c693d commit 009c74e

File tree

1 file changed

+14
-12
lines changed

1 file changed

+14
-12
lines changed

README.md

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,29 +10,31 @@ The project is based on Go and Vue to build a management system for sensitive in
1010

1111
For the usage of GShark, please refer to the [wiki](https://github.com/madneal/gshark/wiki).
1212

13-
# Features
13+
# Key Features
1414

15-
* Support multiple platforms, such as GitLab, GitHub, Searchcode, and Postman
16-
* Flexible menu and API permission settings
17-
* Flexible rules and filtering rules
18-
* Utilize gobuster for subdomain brute force
19-
* Easy-to-use management system
20-
* Support for Docker deployment
15+
* 🌐 Multi-Platform Support: GitHub, GitLab, Searchcode, Postman, and more*
16+
* 🔍 Flexible Rule Management: Custom scanning rules and filtering with whitelist/blacklist support*
17+
* 🔑 Fine-grained Access Control: Configurable menu and API permissions
18+
* 🔄 Subdomain Discovery: Integrated gobuster for subdomain enumeration
19+
* 🚀 Docker Deployment: Containerized deployment for easy setup
20+
* 📊 Visual Management Interface: Intuitive web interface for task and result management
2121

2222
# Quick start
2323

24-
## Docker
24+
## Docker Deployment
2525

2626
```
27+
# Clone the repository
2728
git clone https://github.com/madneal/gshark
29+
2830
cd gshark
31+
32+
# Build and start the container
2933
docker-compose build && docker-compose up
3034
```
3135

3236
> [!IMPORTANT]
33-
> Before the MySQL database initial, the scanner container will exit.
34-
35-
> Need to restart the scanner after the MySQL database initial.
37+
> Before the MySQL database initial, the scanner container will exit. Need to restart the scanner after the MySQL database initial.
3638
3739
## Manual Deployment
3840

@@ -41,7 +43,7 @@ docker-compose build && docker-compose up
4143
* Nginx
4244
* MySQL(version above **8.0**)
4345

44-
It is recommended to deploy the Front-End project using nginx. Place the `dist` folder in `/var/www/html`, and adjust the `nginx.conf` file (/etc/nginx/nginx.conf for Linux) to set up reverse proxy for the backend service. For detailed deployment tutorials, you can watch videos on [bilibili](https://www.bilibili.com/video/BV1Py4y1s7ap/) or [youtube](https://youtu.be/bFrKm5t4M54). For deployment on Windows, refer to [this link](https://www.bilibili.com/video/BV1CA411L7ux/).
46+
It is recommended to deploy the Front-End project using Nginx. Place the `dist` folder in `/var/www/html`, and adjust the `nginx.conf` file (/etc/nginx/nginx.conf for Linux) to set up reverse proxy for the backend service. For detailed deployment tutorials, you can watch videos on [bilibili](https://www.bilibili.com/video/BV1Py4y1s7ap/) or [youtube](https://youtu.be/bFrKm5t4M54). For deployment on Windows, refer to [this link](https://www.bilibili.com/video/BV1CA411L7ux/).
4547

4648
### Nginx
4749

0 commit comments

Comments
 (0)