Skip to content

Gamerboy59/rpxy-webui

Repository files navigation

rpxy-webui: A Management Webinterface for rust-rpxy

rpxy-webui is a web-based management interface designed for the rust-rpxy project. This interface provides an easy and user-friendly way to manage and configure your proxy servers.

Project Overview

The rpxy-webui project aims to offer a comprehensive, intuitive, and responsive web interface for managing rust-rpxy instances. It is built using the Laravel framework, with a Bootstrap 5 frontend.

Features

  • Dashboard: Overview of all managed proxies and their status.
  • Proxy Management: Add, edit, and delete proxies.
  • Upstream Management: Configure upstreams for each proxy.
  • Settings Management: Configure global settings with validations to ensure consistency and correctness.

Screenshots

Dashboard

Dashboard Screenshot

Upstream Overview

Upstream Overview Screenshot

Edit Upstream

Edit Upstream Screenshot

Edit Rpxy Settings

Edit Rpxy Settings Screenshot

Installation and Update

There are various ways to install rpxy-webui and update it. Each has its pros and cons but you can switch installation type with just minimal effort by copying the database.sqlite and .env file to the new installation.

Distribution Package

The most easy way of using rpxy is to install the package manager version. It works just like any other system package and can be automatically updated. Also, this doesn't require the installation of an additional abstraction layer. The only requirement right now is that it's only compatible to apache24 but we look into adding more later or make this optional.

Installation Package

Container

You can install rpxy-webui as standalone container or in combination with rpxy as a separate container. The latter is recommended if you have already setup a container. However, this comes with some limitations. The rpxy container needs to run in host-network mode and should not be switched outside the ip range to continue working with full configuration set.

Installation Container

Shared Hosting

You can run rpxy-webui on allmost all shared hostings. This is cost effective and can save you some management effort. However, you'll need to make the generated config file available to your local rpxy instance.

Installation (pre-compiled)
Installation (self-compile)

Contribution

We welcome contributions to enhance the functionality and user experience of rpxy-webui. Feel free to open issues or submit pull requests for any bugs or new features you would like to see.

License

This project is licensed under the GNU General Public License v3.0 License. See the LICENSE file for details.

Acknowledgements

For more information on rust-rpxy, visit the official repository.


Enjoy managing your rust-rpxy proxies with rpxy-webui!