write about report
This commit is contained in:
parent
bd87703c78
commit
eddd7d4397
50
README.md
50
README.md
@ -26,16 +26,17 @@ Copy the generated configuration file to your device and connect!
|
|||||||
|
|
||||||
To send configurations, ffsend (with separately transferred password) or a local QR code generator may be used.
|
To send configurations, ffsend (with separately transferred password) or a local QR code generator may be used.
|
||||||
|
|
||||||
# Walkthrough of /etc/dsnetconfig.json
|
# Configuration overview
|
||||||
|
|
||||||
dsnetconfig.json is the only file the server needs to run the VPN. It contains
|
dsnetconfig.json is the only file the server needs to run the VPN. It contains
|
||||||
the server keys, peer public/shared keys and IP settings.
|
the server keys, peer public/shared keys and IP settings. A working version is
|
||||||
|
automatically generated by `dsnet init` which can be modified as required.
|
||||||
|
|
||||||
Currently its location is fixed as all my deployments are for a single network.
|
Currently its location is fixed as all my deployments are for a single network.
|
||||||
I may add a feature to allow setting of the location via environment variable
|
I may add a feature to allow setting of the location via environment variable
|
||||||
in the future to support multiple networks on a single host.
|
in the future to support multiple networks on a single host.
|
||||||
|
|
||||||
Main configuration example, generated by `dsnet init` and edited manually:
|
Main configuration example:
|
||||||
|
|
||||||
|
|
||||||
{
|
{
|
||||||
@ -188,6 +189,49 @@ dsnet due to the extra (post quantum!) security it provides.
|
|||||||
|
|
||||||
# Report file overview
|
# Report file overview
|
||||||
|
|
||||||
|
An example report file, generated by `dsnet report` to
|
||||||
|
`/var/lib/dsnetreport.json` by default:
|
||||||
|
|
||||||
|
{
|
||||||
|
"ExternalIP": "198.51.100.2",
|
||||||
|
"InterfaceName": "dsnet",
|
||||||
|
"ListenPort": 51820,
|
||||||
|
"Domain": "dsnet",
|
||||||
|
"IP": "10.164.236.1",
|
||||||
|
"Network": "10.164.236.0/22",
|
||||||
|
"DNS": "",
|
||||||
|
"PeersOnline": 4,
|
||||||
|
"PeersTotal": 13,
|
||||||
|
"Peers": [
|
||||||
|
{
|
||||||
|
"Hostname": "test",
|
||||||
|
"Owner": "naggie",
|
||||||
|
"Description": "Home server",
|
||||||
|
"Online": false,
|
||||||
|
"Dormant": true,
|
||||||
|
"Added": "2020-03-12T20:15:42.798800741Z",
|
||||||
|
"IP": "10.164.236.2",
|
||||||
|
"ExternalIP": "198.51.100.223",
|
||||||
|
"Networks": [],
|
||||||
|
"Added": "2020-05-07T10:04:46.336286992+01:00",
|
||||||
|
"ReceiveBytes": 32517164,
|
||||||
|
"TransmitBytes": 85384984,
|
||||||
|
"ReceiveBytesSI": "32.5 MB",
|
||||||
|
"TransmitBytesSI": "85.4 MB"
|
||||||
|
}
|
||||||
|
|
||||||
|
<...>
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
Fields mean the same as they do above, or are self explanatory. Note that some
|
||||||
|
data is converted into human readable formats in addition to machine formats --
|
||||||
|
this is technically redundant but useful with Hugo shortcodes and other site generators.
|
||||||
|
|
||||||
|
The report can be converted, for instance, into a HTML table as below:
|
||||||
|
|
||||||
|
![dsnet report table](https://raw.githubusercontent.com/naggie/dsnet/master/etc/report.png)
|
||||||
|
|
||||||
# FAQ
|
# FAQ
|
||||||
|
|
||||||
> Does dsnet support IPv6?
|
> Does dsnet support IPv6?
|
||||||
|
BIN
etc/report.png
Normal file
BIN
etc/report.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 91 KiB |
Loading…
Reference in New Issue
Block a user