Update README.md
This commit is contained in:
35
README.md
35
README.md
@@ -1,5 +1,34 @@
|
||||
# nginx_modsite
|
||||
# 🚀 NGINX - Site Manager
|
||||
|
||||
A bash script to enable, disable, and list Nginx sites, and help reload the config.
|
||||
This script simplifies the process of managing NGINX sites by providing a command-line interface for common operations such as enabling/disabling, listing, and editing site configurations.
|
||||
|
||||
[Read all about it](https://www.ajsalkeld.com/project/2016/07/16/Nginx-modsite-a2ensite-tool-for-nginx-enable-disable-reload/).
|
||||
## 🛠️ Usage
|
||||
|
||||
```bash
|
||||
./nginx-sm.sh [options]
|
||||
```
|
||||
|
||||
## ⚙️ Options
|
||||
|
||||
- `-e, --enable`: Enable a site by enabling its configuration file.
|
||||
- `-d, --disable`: Disable a site by disabling its configuration file.
|
||||
- `-l, --list`: List all available sites and their status.
|
||||
- `-ed, --edit`: Edit the configuration file of a site.
|
||||
|
||||
## 📖 Examples
|
||||
|
||||
```bash
|
||||
./nginx-sm.sh --enable example.com # Enable the site example.com
|
||||
./nginx-sm.sh --list # List all available sites
|
||||
./nginx-sm.sh -edit example.com # Edit the configuration of example.com
|
||||
```
|
||||
|
||||
## 📚 Dependencies
|
||||
|
||||
- NGINX web server must be installed and running.
|
||||
- The script requires sudo privileges to modify NGINX configuration files.
|
||||
|
||||
---
|
||||
|
||||
Copyright (c) 2023 nobody
|
||||
Licensed under the MIT License.
|
||||
|
||||
Reference in New Issue
Block a user