diff --git a/automated install/basic-install.sh b/automated install/basic-install.sh index f1ef8887..20051b83 100755 --- a/automated install/basic-install.sh +++ b/automated install/basic-install.sh @@ -91,7 +91,7 @@ IPV4_ADDRESS=${IPV4_ADDRESS} IPV6_ADDRESS=${IPV6_ADDRESS} # Give settings their default values. These may be changed by prompts later in the script. QUERY_LOGGING= -WEBPORT=8080 +WEBPORT= PRIVACY_LEVEL= # Where old configs go to if a v6 migration is performed @@ -2446,7 +2446,7 @@ main() { if [[ $(pihole-FTL --config webserver.api.pwhash) == '""' ]]; then # generate a random password pw=$(tr -dc _A-Z-a-z-0-9 0)); then # display the password printf " %b Web Interface password: %b%s%b\\n" "${INFO}" "${COL_LIGHT_GREEN}" "${pw}" "${COL_NC}" - printf " %b This can be changed using 'pihole -a -p'\\n\\n" "${INFO}" + printf " %b This can be changed using 'pihole setpassword'\\n\\n" "${INFO}" fi if [[ "${useUpdateVars}" == false ]]; then + # Get the Web interface port, return only the first port and strip all non-numeric characters + WEBPORT=$(getFTLConfigValue webserver.port|cut -d, -f1 | tr -cd '0-9') + + # Display the completion dialog + displayFinalMessage "${pw}" + # If the Web interface was installed, printf " %b View the web interface at http://pi.hole:${WEBPORT}/admin or http://%s/admin\\n\\n" "${INFO}" "${IPV4_ADDRESS%/*}:${WEBPORT}" diff --git a/manpages/pihole.8 b/manpages/pihole.8 index 825a1fd1..97a6ec68 100644 --- a/manpages/pihole.8 +++ b/manpages/pihole.8 @@ -5,19 +5,15 @@ Pi-hole : A black-hole for internet advertisements .br .SH "SYNOPSIS" -\fBpihole\fR (\fB-w\fR|\fB-b\fR|\fB--wild\fR|\fB--regex\fR) [options] domain(s) +\fBpihole\fR (\fB-allow\fR|\fB-deny\fR) [options] domain(s) .br -\fBpihole -a\fR \fB-p\fR password +\fBpihole\fR (\fB--allow-regex\fR|\fB--regex\fR) [options] domain(s) .br -\fBpihole -a\fR (\fB-c|-f|-k\fR) +\fBpihole\fR (\fB--allow-wild\fR|\fB--wild\fR) [options] domain(s) .br -\fBpihole -a -i\fR interface +\fBpihole setpassword\fR password .br -\fBpihole -a -l\fR privacylevel -.br -\fBpihole -c\fR [-j|-r|-e] -.br -\fBpihole\fR \fB-d\fR [-a] +\fBpihole\fR \fB-d\fR [-a] [-c] .br \fBpihole -f .br @@ -25,7 +21,7 @@ pihole -r .br \fBpihole\fR \fB-t\fR [arg] .br -pihole -g\fR +\fBpihole -g\fR .br \fBpihole\fR -\fBq\fR [options] .br @@ -33,20 +29,22 @@ pihole -g\fR .br \fBpihole -up \fR[--check-only] .br -\fBpihole -v\fR [-p|-a|-f] [-c|-l|-hash] +\fBpihole -v\fR .br -\fBpihole uninstall +\fBpihole uninstall\fR .br -pihole status +\fBpihole status\fR .br -pihole reloaddns\fR +\fBpihole reloaddns\fR .br -pihole reloadlists\fR +\fBpihole reloadlists\fR .br \fBpihole\fR (\fBenable\fR|\fBdisable\fR [time]) .br \fBpihole\fR \fBcheckout\fR repo [branch] .br +\fBpihole\fR \api\fR endpoint +.br \fBpihole\fR \fBhelp\fR .br .SH "DESCRIPTION" @@ -99,6 +97,7 @@ Available commands and options: .br -a Enable automated debugging + -c Include a Pi-hole database integrity check .br \fB-f, flush\fR @@ -120,25 +119,6 @@ Available commands and options: (regular expressions are supported) .br -\fB-a, admin\fR [options] -.br - - (Admin options): -.br - -p, password Set Web Interface password -.br - -c, celsius Set Celsius as preferred temperature unit -.br - -f, fahrenheit Set Fahrenheit as preferred temperature unit -.br - -k, kelvin Set Kelvin as preferred temperature unit -.br - -i, interface Specify dnsmasq's interface listening behavior -.br - -l, privacylevel Set privacy level - (0 = lowest, 3 = highest) -.br - \fB-g, updateGravity\fR .br Update the list of ad-serving domains @@ -151,11 +131,9 @@ Available commands and options: (Query options): .br - -adlist Print the name of the block list URL + -partial Search the adlists for partially matching domains .br - -exact Search the block lists for exact domain matches -.br - -all Return all query matches within a block list + -all Return all query matches within a adlists .br \fB-h, --help, help\fR @@ -186,29 +164,14 @@ Available commands and options: --check-only Exit script before update is performed. .br -\fB-v, version\fR [repo] [options] +\fB-v, version\fR .br Show installed versions of Pi-hole, Web Interface & FTL .br +\fBsetpassword\fR .br - (repo options): -.br - -p, --pihole Only retrieve info regarding Pi-hole repository -.br - -a, --admin Only retrieve info regarding web - repository -.br - -f, --ftl Only retrieve info regarding FTL repository -.br - (version options): -.br - -c, --current Return the current version -.br - -l, --latest Return the latest version -.br - --hash Return the GitHub hash from your local - repositories + Set Web Interface password .br \fBuninstall\fR @@ -221,14 +184,14 @@ Available commands and options: Display the running status of Pi-hole subsystems .br -\fBenable\fR +\fBenable\fR [time] .br - Enable Pi-hole subsystems + Enable Pi-hole blocking, optionally for a set duration .br \fBdisable\fR [time] .br - Disable Pi-hole subsystems, optionally for a set duration + Disable Pi-hole blocking, optionally for a set duration .br (time options): @@ -270,6 +233,11 @@ Available commands and options: .br branchname Update subsystems to the specified branchname .br + +\fBapi\fR endpoint +.br + Query the Pi-hole API at +.br .SH "EXAMPLE" Some usage examples @@ -283,7 +251,7 @@ Allow-/denylist manipulation Allow "iloveads.example.com" .br -\fBpihole deny not noads.example.com\fR +\fBpihole deny remove noads.example.com\fR .br Removes "noads.example.com" from denylist .br @@ -303,7 +271,7 @@ Allow-/denylist manipulation Changing the Web Interface password .br -\fBpihole -a -p ExamplePassword\fR +\fBpihole setpassword ExamplePassword\fR .br Change the password to "ExamplePassword" .br @@ -319,9 +287,9 @@ Updating lists from internet sources Displaying version information .br -\fBpihole -v -a -c\fR +\fBpihole -v\fR .br - Display the current version of web + Display the current version of Pi-hole .br Temporarily disabling Pi-hole @@ -350,10 +318,11 @@ Switching Pi-hole subsystem branches Flush information stored in Pi-hole's network tables .br -.SH "SEE ALSO" - -\fBlighttpd\fR(8), \fBpihole-FTL\fR(8) +\fBpihole api stats/summary\fR .br + Queries FTL for the stats/summary endpoint +.br + .SH "COLOPHON" Get sucked into the latest news and community activity by entering Pi-hole's orbit. Information about Pi-hole, and the latest version of the software can be found at https://pi-hole.net. diff --git a/pihole b/pihole index 5657637b..f3e14ac6 100755 --- a/pihole +++ b/pihole @@ -501,6 +501,7 @@ Options: uninstall Uninstall Pi-hole from your system status Display the running status of Pi-hole subsystems enable Enable Pi-hole subsystems + Add '-h' for more info on enable usage disable Disable Pi-hole subsystems Add '-h' for more info on disable usage reloaddns Update the lists and flush the cache without restarting the DNS server