Skip to content

Commit df08cea

Browse files
authored
Docs: WebConsole (BornToBeRoot#2244)
* Docs: Add some info blocks * Docs: Add title * Docs: Web Console
1 parent 48033f6 commit df08cea

10 files changed

Lines changed: 53 additions & 14 deletions

File tree

docs/Documentation/01_Application/14_WebConsole.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,37 @@ title: WebConsole
44
parent: Application
55
grand_parent: Documentation
66
nav_order: 14
7-
description: ""
7+
description: "Documentation of the WebConsole"
88
permalink: /Documentation/Application/WebConsole
99
---
1010

1111
# Web Console
1212

13+
The **Web Console** is designed to browse the website of a host (e.g. server, switch, router, dashboard, etc.) to display informations or to configure it.
14+
15+
Possible inputs:
16+
- `https://pihole.example.com/admin/`
17+
1318
![WebConsole](14_WebConsole.png)
1419

15-
## Profile
20+
## Profile
21+
22+
### URL
23+
24+
URL of the website to display in the web console.
25+
26+
**Type:** `String`
27+
28+
**Default:** `Empty`
29+
30+
**Example:** `https://pihole.example.com/admin/`
31+
32+
## Settings
33+
34+
### Show address bar
35+
36+
Show or hide the navigation / address bar.
37+
38+
**Type:** `Boolean`
39+
40+
**Default:** `Enabled`

docs/Documentation/01_Application/15_SNMP.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: SNMP
44
parent: Application
55
grand_parent: Documentation
66
nav_order: 15
7-
description: "Documentation of the SNMP"
7+
description: "Documentation of SNMP"
88
permalink: /Documentation/Application/SNMP
99
---
1010

docs/Documentation/01_Application/16_SNTPLookup.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ title: SNTP Lookup
44
parent: Application
55
grand_parent: Documentation
66
nav_order: 16
7-
description: ""
7+
description: "Documentation of the SNTP Lookup"
88
permalink: /Documentation/Application/SNTPLookup
99
---
1010

@@ -19,8 +19,14 @@ New Feature
1919
With **SNTP Lookup** you can query one or more SNTP servers to get the current network time.
2020
SNTP server and get the network current time. It will also show the offset to the local time.
2121

22+
{: .info}
23+
SNTP (Simple Network Time Protocol) is a protocol used for synchronizing time between computer systems on a network. It is a simplified version of the Network Time Protocol (NTP) that is widely used for time synchronization. SNTP is designed to provide a basic level of accuracy and is used when precise timing is not critical. SNTP servers typically obtain their time from other NTP or SNTP servers and distribute the time to client devices on the network. SNTP operates over the User Datagram Protocol (UDP) and typically uses port 123. It is widely supported by many operating systems and network devices and is an important component of network infrastructure.
24+
2225
![SNTPLookup](16_SNTPLookup.png)
2326

27+
{: .note}
28+
Right-click on the result to copy or export the information.
29+
2430
## Settings
2531

2632
### Servers

docs/Documentation/01_Application/17_DiscoveryProtocol.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ description: "Documentation of the Discovery Protocol"
88
permalink: /Documentation/Application/DiscoveryProtocol
99
---
1010

11-
1211
# Discovery Protocol
1312

1413
In **Discovery Protocol** you can capture for LLDP (Link Layer Discovery Protocol) and/or CDP (Cisco Discovery Protocol) frames to see to which switch or router your device is connected. The information such as device name, port, VLAN, etc. are displayed in a table.

docs/Documentation/01_Application/19_Whois.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ Possible inputs:
2727

2828
![Whois](19_Whois.png)
2929

30+
{: .note}
31+
Right-click on the result to copy or export the information.
32+
3033
## Profile
3134

3235
### Inherit host from general

docs/Documentation/01_Application/20_SubnetCalculator.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@ Possible inputs:
3838

3939
![SubnetCalculator_Subnetting](20_SubnetCalculator_Subnetting.png)
4040

41+
{: .note}
42+
Right-click on the result to copy or export the information.
43+
4144
## Wide Subnet
4245

4346
On the **Wide Subnet** tab, you can create a wide subnet that includes both given subnets. The subnet mask can be entered in CIDR notation.

docs/Documentation/01_Application/22_Lookup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,11 @@ On the **OUI** tab, you can search the manufacturer of a network interface card
1919
{: .info}
2020
The OUI (Organizationally Unique Identifier) is a 24-bit number that is assigned to a network interface card (NIC) by the IEEE Registration Authority. The OUI is used to identify the manufacturer of a network interface card. The OUI is the first 24 bits of the MAC address.
2121

22+
![Lookup_OUI](22_Lookup_OUI.png)
23+
2224
{: .note}
2325
Right-click on the result to copy or export the information.
2426

25-
![Lookup_OUI](22_Lookup_OUI.png)
26-
2727
## Port
2828

2929
On the **Port** tab, you can search for a port number to get information about the service and the protocol used by the port. You can also search by service name to get all registered port numbers of the service.

docs/Documentation/01_Application/23_Connections.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permalink: /Documentation/Application/Connections
1212

1313
In **Connections** you can see all the connections with source and destination IP addresses and port that are currently running on your computer.
1414

15+
![Connections](23_Connections.png)
16+
1517
{: .note}
1618
Right-click on the result to copy or export the information.
17-
18-
![Connections](23_Connections.png)

docs/Documentation/01_Application/24_Listeners.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permalink: /Documentation/Application/Listeners
1212

1313
In **Listeners** you can see all the listeners with IP addresses and port that are currently running on your computer.
1414

15-
{: .note}
16-
Right-click on the result to copy or export the information.
17-
1815
![Listeners](24_Listeners.png)
16+
17+
{: .note}
18+
Right-click on the result to copy or export the information.

docs/Documentation/01_Application/25_ARPTable.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,15 @@ permalink: /Documentation/Application/ARPTable
1111

1212
The **ARP table** shows you the IP address and MAC address of all devices on your network with which the computer has already established a connection.
1313

14+
{: .info}
15+
ARP (Address Resolution Protocol) is a layer 2 protocol for mapping IP addresses to MAC addresses. The ARP table is a list of all IP addresses and the corresponding MAC addresses of the devices on the network. When a device needs to send data to a specific IP address, it first checks its ARP table to see if it already has the MAC address for that IP address. If the MAC address is not found in the ARP table, the device will send a broadcast message called an ARP request to the network asking which device owns that IP address. The device that owns the IP address will then respond with its MAC address, and the requesting device will update its ARP table with the new mapping. ARP cache poisoning attacks can manipulate the contents of the ARP table, leading to security issues.
16+
1417
In addition, further actions can be performed using the buttons at the bottom left:
1518
- **Add entry...** - Opens a dialog to add an entry to the ARP table.
1619
- **Delete entry** - Delete the currently selected entry from the ARP table.
1720
- **Delete table** - Delete all entries from the ARP table.
1821

22+
![ARPTable](25_ARPTable.png)
23+
1924
{: .note}
2025
Right-click on the result to copy or export the information.
21-
22-
![ARPTable](25_ARPTable.png)

0 commit comments

Comments
 (0)