zishuo/netmaker
1
0
Fork 0
mirror of https://github.com/gravitl/netmaker.git synced 2025-10-18 22:55:15 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
afeiszli
2021-06-03 08:29:20 -04:00
parent 85d363b1ad
commit 3960482cf5
9 changed files with 261 additions and 67 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/examplecode/netclient-help.txt Normal file
View File

@@ -0,0 +1,20 @@
NAME:
Netclient CLI - Netmaker's netclient agent and CLI. Used to perform interactions with Netmaker server and set local WireGuard config.
USAGE:
netclient [global options] command [command options] [arguments...]
COMMANDS:
register Register with Netmaker Server for secure GRPC communications.
join Join a Netmaker network.
leave Leave a Netmaker network.
checkin Checks for local changes and then checks into the specified Netmaker network to ask about remote changes.
push Push configuration changes to server.
pull Pull latest configuration and peers from server.
list Get list of networks.
uninstall Uninstall the netclient system service.
unregister Unregister the netclient from secure server GRPC.
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--help, -h show help (default: false)

35
docs/examplecode/netclient-join.txt Normal file
View File

@@ -0,0 +1,35 @@
NAME:
netclient join - Join a Netmaker network.
USAGE:
netclient join [command options] [arguments...]
OPTIONS:
--network value, -n value Network to perform specified action against. (default: "all") [$NETCLIENT_NETWORK]
--password value, -p value Password for authenticating with netmaker. (default: "badpassword") [$NETCLIENT_PASSWORD]
--endpoint value, -e value Reachable (usually public) address for WireGuard (not the private WG address). [$NETCLIENT_ENDPOINT]
--macaddress value, -m value Mac Address for this machine. Used as a unique identifier within Netmaker network. [$NETCLIENT_MACADDRESS]
--publickey value, --pubkey value Public Key for WireGuard Interface. [$NETCLIENT_PUBLICKEY]
--privatekey value, --privkey value Private Key for WireGuard Interface. [$NETCLIENT_PRIVATEKEY]
--port value Port for WireGuard Interface. [$NETCLIENT_PORT]
--keepalive value Default PersistentKeepAlive for Peers in WireGuard Interface. (default: 0) [$NETCLIENT_KEEPALIVE]
--operatingsystem value, --os value Identifiable name for machine within Netmaker network. [$NETCLIENT_OS]
--name value Identifiable name for machine within Netmaker network. [$NETCLIENT_NAME]
--localaddress value Local address for machine. Can be used in place of Endpoint for machines on the same LAN. [$NETCLIENT_LOCALADDRESS]
--address value, -a value WireGuard address for machine within Netmaker network. [$NETCLIENT_ADDRESS]
--addressIPv6 value, --a6 value WireGuard address for machine within Netmaker network. [$NETCLIENT_ADDRESSIPV6]
--interface value, -i value WireGuard local network interface name. [$NETCLIENT_INTERFACE]
--apiserver value Address + GRPC Port (e.g. 1.2.3.4:50051) of Netmaker server. [$NETCLIENT_API_SERVER]
--grpcserver value Address + API Port (e.g. 1.2.3.4:8081) of Netmaker server. [$NETCLIENT_GRPC_SERVER]
--key value, -k value Access Key for signing up machine with Netmaker server during initial 'add'. [$NETCLIENT_ACCESSKEY]
--token value, -t value Access Token for signing up machine with Netmaker server during initial 'add'. [$NETCLIENT_ACCESSTOKEN]
--localrange value Local Range if network is local, for instance 192.168.1.0/24. [$NETCLIENT_LOCALRANGE]
--dns value Sets private dns if 'on'. Ignores if 'off'. Will retrieve from network if unset. [$NETCLIENT_DNS]
--islocal value Sets endpoint to local address if 'yes'. Ignores if 'no'. Will retrieve from network if unset. [$NETCLIENT_IS_LOCAL]
--isdualstack value Sets ipv6 address if 'yes'. Ignores if 'no'. Will retrieve from network if unset. [$NETCLIENT_IS_DUALSTACK]
--ipforwarding value Sets ip forwarding on if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_IPFORWARDING]
--postup value Sets PostUp command for WireGuard. [$NETCLIENT_POSTUP]
--postdown value Sets PostDown command for WireGuard. [$NETCLIENT_POSTDOWN]
--daemon value Installs daemon if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_DAEMON]
--roaming value Checks for IP changes if 'on'. Ignores if 'off'. On by default. (default: "on") [$NETCLIENT_ROAMING]
--help, -h show help (default: false)

32
docs/examplecode/netconfig-example.yml Normal file
View File

@@ -0,0 +1,32 @@
server:
grpcaddress: 10.101.0.1:50051 # Address of GRPC Server (used for all interaction with server after registration)
apiaddress: 1.2.3.4:8081 # Address of API Server (used only for registration/unregistration)
accesskey: 5qKTbTgsvb45y3qyRmWft # Key used to sign up with server. Used only during registration
node:
name: my-computer # name of this node
interface: nm-example # name of interface to create/use for WG
network: example # name of network this ode is a part of
password: $2a$0afehuytviN/thMpVlCYkonxy.Ws2.rNCJjBSAa3HZuhrK5hpYxme # encrypted node password, used to retrieve JWT. Can be changed to new pass in plaintext and CLI will update/replace with encrypted pass
macaddress: 6c:4b:91:0g:68:7b # MAC of node. Used as a Unique ID
localaddress: 192.168.1.32 # Address on local network, used as endpoint for other local nodes for faster comms
wgaddress: 10.7.11.2 # Private WG addres on network
wgaddress6: "f8:34:41:77:5c:15" # Private ipv6 address if network is dual stack
roaming: "on" # Whether or not to grab new endpoint value automatically
dns: "off" # Whether or not to set local DNS based on Netmaker's Private DNS server
islocal: "no" # Based on network. If yes, will use local IP as endpoint.
isdualstack: "yes" # Use IPv6 in addition to IPv4
isingressgateway: "no" # whether or not node is an ingress gateway (will set iptables forwarding rules)
allowedips: "" # not currently used
localrange: "" # local range if it's a local network. For instance, 192.168.1.0/24
postup: "" # postup command, used by ingress/egress gateways to set iptables
postdown: "" # postdown command, used by ingress/egress gateways to set iptables
port: 51821 # WG port to use
keepalive: 20 # default keepalive with nodes
publickey: 8/q9cOg7c9QjnoXygVrY/VNE197VMRadJodkb1ZsujA= # public key of node to show to other nodes
privatekey: "" # private key, set only for changing and then will revert to blank in config
endpoint: 78.170.22.168 # public endpoint for reaching node
postchanges: "false" # if true, will post and config file changes on next checkin and then revert to false
ipforwarding: "on" # set ip forwarding; highly recommended to leave on
network: home # the network (duplicate of node.network)
daemon: "on" # whether or not to manage systemd
operatingsystem: "" # not currently in use