Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Latest commit

 

History

History
175 lines (120 loc) · 5.88 KB

README.md

File metadata and controls

175 lines (120 loc) · 5.88 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Project Name

Explore the docs »
--------------------
Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact

About The Project

This project is a manager for Nginx reverse proxy. It allows you to manage your reverse proxy configuration files and to generate them automatically.

(back to top)

Built With

  • Bash

(back to top)

Getting Started

You can install ... by following these steps.

Prerequisites

  1. Clone the repository on your computer.

    git clone https://github.com/ClubNix/Reverse-Proxy-Manager.git
cd Reverse-Proxy-Manager
    • If Git is not installed, you can install it from here or download the repository as a zip file from here 
      sudo apt install git

Usage

You just have to launch the script as root (not sudo invoke).

chmod +x Reverse-Proxy-Manager.sh
./Reverse-Proxy-Manager.sh

At the first start, it will ask you to install Nginx if it is not already installed. If Nginx is already installed, some paths will not be available. I recommend you to add the /etc/nginx/certs directory and execute the script to uninstall and reinstall Nginx with the script because of the recompilation of Nginx with specific modules.

(back to top)

Roadmap

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.md for more information.

(back to top)

Contact

Isnubi - @Louis_Gambart - [email protected]
Discord: isnubi#6221

Project Link: https://github.com/ClubNix/Reverse-Proxy-Manager

(back to top)