Skip to content

Latest commit

 

History

History
77 lines (44 loc) · 1.93 KB

README.md

File metadata and controls

77 lines (44 loc) · 1.93 KB
Raw

GoPanel

GoPanel is a minimal server management panel written in Go. It is designed to support LEMP (Linux, Nginx, MySQL/MariaDB, PHP) stacks and provides a streamlined solution for managing servers.

image

Features

  • Minimal Authentication Flow: Very simple secure access with OTP only to ensure that only authorized users can manage the server.
  • Simple API Framework: Provides a straightforward API for integration and automation.
  • EmbedFS: The entire panel operates from a single binary, simplifying deployment and management.

Getting Started

Prerequisites

  • Go (version 1.23 or higher) installed on your system. (Only for building)
  • Access to a server running a LEMP stack.

Installation

  1. Clone the Repository:

    git clone https://github.com/xaymup/gopanel.git
cd gopanel

  2. Build the Binary:

    go build -o gopanel cmd/gopanel/main.go

  3. Run GoPanel:

    sudo ./gopanel

Testing

To test GoPanel, you can run it directly using the following command:

sudo go run cmd/gopanel/main.go

Usage

  1. Access the Panel: Open your web browser and navigate to http://localhost:8888.

  2. Authenticate: Use your 2FA authenticator to log in.

Contributing

If you would like to contribute to GoPanel, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature-branch).
  3. Make your changes and commit them (git commit -am 'Add new feature').
  4. Push to the branch (git push origin feature-branch).
  5. Create a new Pull Request.

License

GoPanel is licensed under the MIT License. See the LICENSE file for more information.

Contact

For any questions or support, please reach out to hi@xaymup.me.