diff --git a/README.md b/README.md index 4c70bde..8afb10a 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ ee auth Creates http authentication for a site. ~~~ -ee auth create [] [--user=] [--pass=] [--site] [--admin-tools] +ee auth create [] [--user=] [--pass=] [--ip=] ~~~ **OPTIONS** @@ -48,29 +48,29 @@ ee auth create [] [--user=] [--pass=] [--site] [--admin-t [--pass=] Password for http auth. - [--site] - Create auth on site. - - [--admin-tools] - Create auth on admin tools. + [--ip=] + IP to whitelist. **EXAMPLES** - # Add auth on site and its admin tools with default username(easyengine) and random password + # Add auth on site with default username(easyengine) and random password $ ee auth create example.com - # Add auth on all sites and its admin tools with default username and random password + # Add auth on all sites with default username and random password $ ee auth create global - # Add auth on site and its admin tools with predefined username and password + # Add auth on site with predefined username and password $ ee auth create example.com --user=test --pass=password - # Add auth only on admin tools - $ ee auth create example.com --admin-tools - - # Add auth on site and its admin tools with default username and random password + # Add auth on site with default username and random password $ ee auth create example.com --pass=password + # Whitelist IP on site + $ ee auth create example.com --ip=8.8.8.8,1.1.1.1 + + # Whitelist IP on all sites + $ ee auth create global --ip=8.8.8.8,1.1.1.1 + ### ee auth delete @@ -78,7 +78,7 @@ ee auth create [] [--user=] [--pass=] [--site] [--admin-t Deletes http authentication for a site. Default: removes http authentication from site. If `--user` is passed it removes that specific user. ~~~ -ee auth delete [] [--user=] [--site] [--admin-tools] +ee auth delete [] [--user=] [--ip] ~~~ **OPTIONS** @@ -89,11 +89,8 @@ ee auth delete [] [--user=] [--site] [--admin-tools] [--user=] Username that needs to be deleted. - [--site] - Delete auth on site. - - [--admin-tools] - Delete auth for admin tools. + [--ip] + IP to remove. Default removes all. **EXAMPLES** @@ -103,11 +100,17 @@ ee auth delete [] [--user=] [--site] [--admin-tools] # Remove auth on site and its admin tools with custom username $ ee auth delete example.com --user=example - # Remove global auth on all site's admin tools with default username(easyengine) - $ ee auth delete example.com --admin-tools - # Remove global auth on all sites (but not admin tools) with default username(easyengine) - $ ee auth delete example.com --site + $ ee auth delete global + + # Remove specific whitelisted IPs on site + $ ee auth delete example.com --ip=1.1.1.1,8.8.8.8 + + # Remove all whitelisted IPs on site + $ ee auth delete example.com --ip + + # Remove whitelisted IPs on all sites + $ ee auth delete global --ip=1.1.1.1 @@ -116,7 +119,7 @@ ee auth delete [] [--user=] [--site] [--admin-tools] Lists http authentication users of a site. ~~~ -ee auth list [] [--site] [--admin-tools] [--format=] +ee auth list [] [--ip] [--format=] ~~~ **OPTIONS** @@ -124,11 +127,8 @@ ee auth list [] [--site] [--admin-tools] [--format=] [] Name of website / `global` for global scope. - [--site] - List auth on site. - - [--admin-tools] - List auth for admin-tools. + [--ip] + Show whitelisted IPs of site. [--format=] Render output in a particular format. @@ -157,13 +157,13 @@ ee auth list [] [--site] [--admin-tools] [--format=] Updates http authentication password for a site. ~~~ -ee auth update [] [--user=] [--pass=] [--site] [--admin-tools] +ee auth update [] [--user=] [--pass=] [--ip=] ~~~ **OPTIONS** [] - Name of website / `global` for global scope. + Name of website / `global` for global auth. [--user=] Username for http auth. @@ -171,77 +171,22 @@ ee auth update [] [--user=] [--pass=] [--site] [--admin-t [--pass=] Password for http auth. - [--site] - Update auth on site. - - [--admin-tools] - Update auth on admin tools. - -**EXAMPLES** - - # Update auth password on site and its admin tools with default username(easyengine) and random password - $ ee auth update example.com - - # Update auth password on all sites and its admin tools with default username and random password - $ ee auth update global - - # Update auth password on site and its admin tools with predefined username and password - $ ee auth update example.com --user=test --pass=password - - # Update auth password only on admin tools - $ ee auth update example.com --admin-tools - - # Update auth password on site and its admin tools with default username and random password - $ ee auth update example.com --pass=password - - - -### ee auth whitelist - -Create, append, remove, list ip whitelisting for a site or globally. - -~~~ -ee auth whitelist [] [] [] [] [] [--ip=] -~~~ - -**OPTIONS** - - [] - Create ip whitelisting for a site or globally. - - [] - Append ips in whitelisting of a site or globally. - - [] - List whitelisted ip's of a site or of global scope. - - [] - Remove whitelisted ip's of a site or of global scope. - - [] - Name of website / `global` for global scope. - [--ip=] - Comma seperated ips. + IP to whitelist. **EXAMPLES** - # Whitelisted IP on site - $ ee auth whitelist create example.com --ip=127.0.0.1,192.168.0.1 + # Update auth password on global auth with default username and random password + $ ee auth update global --user=easyengine - # Whitelist IP on site where previous whitelisting are present - $ ee auth whitelist append example.com --ip=127.0.0.1 - - # List all whitelisted ips on site - $ ee auth whitelist list example.com + # Update auth password on site with predefined username and password + $ ee auth update example.com --user=test --pass=password - # Remove a whitelisted IP on site - $ ee auth whitelist remove example.com --ip=127.0.0.1 + # Update whitelisted IPs on site + $ ee auth update example.com --ip=8.8.8.8,1.1.1.1 - # Remove all whitelisted IPs on site - $ ee auth whitelist remove example.com --ip=all - - # Above all will work for global auth by replacing site name with global + # Update whitelisted IPs on all sites + $ ee auth update global --ip=8.8.8.8,1.1.1.1 ## Contributing @@ -249,7 +194,6 @@ We appreciate you taking the initiative to contribute to this project. Contributing isn’t limited to just code. We encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation. - ### Reporting a bug Think you’ve found a bug? We’d love for you to help us get it fixed. diff --git a/composer.json b/composer.json index dff5ba7..db7c89a 100644 --- a/composer.json +++ b/composer.json @@ -28,8 +28,7 @@ "auth create", "auth delete", "auth list", - "auth update", - "auth whitelist" + "auth update" ] } }