Update README.md
This commit is contained in:
70
README.md
70
README.md
@ -7,7 +7,8 @@
|
||||
|
||||
# Hysteria2 Management Shell Script
|
||||
|
||||
This shell script provides a menu-driven interface to manage Hysteria2 server operations. It includes options to install, configure, update, and uninstall Hysteria2, as well as manage users, ports, traffic status, and integrate with other tools like TCP Brutal and WARP.
|
||||
This bash script provides a comprehensive menu-driven interface to manage the Hysteria2 server, user accounts, and various services. It supports installation, user management, traffic monitoring, and integration with additional tools like WARP, Singbox SubLink, and a Telegram bot.
|
||||
|
||||
|
||||
### Install command :
|
||||
```shell
|
||||
@ -28,25 +29,50 @@ bash <(curl https://raw.githubusercontent.com/ReturnFI/Hysteria2/main/upgrade.sh
|
||||
<p/>
|
||||
|
||||
|
||||
## Features
|
||||
## Features :
|
||||
|
||||
### Hysteria2:
|
||||
- Install and Configure: Installs and configures Hysteria2 server.
|
||||
- Add User: Creates a new user for Hysteria2 access.
|
||||
- Show URI: Displays the connection URI and QR code for existing users.
|
||||
- Check Traffic Status: Monitors real-time traffic information for each user.
|
||||
- Remove User: Deletes a user from the Hysteria2 configuration.
|
||||
- Change Port: Modifies the listening port for the Hysteria2 server.
|
||||
- Update Core: Updates Hysteria2 to the latest available version.
|
||||
- Uninstall Hysteria2: Removes Hysteria2 server and its configuration.
|
||||
- **Hysteria2 Installation & Configuration:**
|
||||
- Install and configure Hysteria2 on your server.
|
||||
- Manage user accounts (add, edit, reset, remove, list).
|
||||
- Monitor traffic and display user URIs.
|
||||
|
||||
### Advance: (Optional features)
|
||||
- **Advanced Options:**
|
||||
- Install and manage additional services like WARP and TCP Brutal.
|
||||
- Start/Stop Singbox SubLink and Telegram bot services.
|
||||
- Change the port number for Hysteria2.
|
||||
- Update or uninstall Hysteria2.
|
||||
|
||||
- Install TCP Brutal: The script can optionally install TCP Brutal, a tool designed to improve performance on congested networks.
|
||||
- Install WARP: Integrate WARP from Cloudflare to add an extra layer of encryption to your Hysteria2 connections, further protecting your online activity.
|
||||
- Configure WARP: Manages WARP integration with Hysteria2 for traffic routing.
|
||||
- **Interactive Menus:**
|
||||
- User-friendly menu-driven interface for easier navigation and management.
|
||||
- Validations for user inputs and system checks to prevent misconfigurations.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
## Main Menu :
|
||||
|
||||
- **Hysteria2 Menu:**
|
||||
- **Install and Configure Hysteria2:** Set up Hysteria2 with your desired configuration.
|
||||
- **Add User:** Add a new user with traffic limits and expiration days.
|
||||
- **Edit User:** Modify user details like username, traffic limit, expiration days, password, etc.
|
||||
- **Reset User:** Reset user statistics.
|
||||
- **Remove User:** Remove a user from the system.
|
||||
- **Get User:** Retrieve detailed information of a specific user.
|
||||
- **List Users:** Display a list of all users.
|
||||
- **Check Traffic Status:** View the current traffic status.
|
||||
- **Show User URI:** Generate and display the URI for a user.
|
||||
|
||||
- **Advance Menu:**
|
||||
- **Install TCP Brutal:** Install the TCP Brutal service.
|
||||
- **Install WARP:** Install Cloudflare's WARP service.
|
||||
- **Configure WARP:** Configure WARP for different traffic routes.
|
||||
- **Uninstall WARP:** Remove WARP from the system.
|
||||
- **Telegram Bot:** Start or stop the Telegram bot service.
|
||||
- **Singbox SubLink:** Start or stop the Singbox service.
|
||||
- **Change Port Hysteria2:** Change the port on which Hysteria2 listens.
|
||||
- **Update Core Hysteria2:** Update Hysteria2 to the latest version.
|
||||
- **Uninstall Hysteria2:** Remove Hysteria2 and its configuration.
|
||||
|
||||
|
||||
## Prerequisites :
|
||||
Ensure the following packages are installed:
|
||||
|
||||
- Ubuntu-based Linux distribution (tested on Ubuntu)
|
||||
@ -57,8 +83,16 @@ Ensure the following packages are installed:
|
||||
- uuid-runtime
|
||||
|
||||
If any of these are missing, the script will attempt to install them automatically.
|
||||
|
||||
## Disclaimer:
|
||||
|
||||
## Contributing :
|
||||
|
||||
Contributions are welcome!
|
||||
|
||||
Feel free to contribute by creating issues or submitting pull requests
|
||||
|
||||
Please fork the repository and submit a pull request with your improvements.
|
||||
|
||||
## Disclaimer :
|
||||
|
||||
This script is provided for educational purposes only. The developer are not responsible for any misuse or consequences arising from its use. Please ensure you understand the implications of using Hysteria2 and related tools before deployment in a production environment.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user