mirror of
https://github.com/gravitl/netmaker.git
synced 2025-02-25 00:24:37 +08:00
ipv6 and private dns now working. docs updated.
This commit is contained in:
afeiszli
parent
3dafbc0daa
commit
0765c92efd
4 changed files with 150 additions and 37 deletions
105
README.md
105
README.md
|
|
@ -1,3 +1,4 @@
|
|||
|
||||
<p align="center">
|
||||
<img src="netmaker.png"><break/>
|
||||
</p>
|
||||
|
|
@ -6,7 +7,11 @@
|
|||
</p>
|
||||
|
||||
## What is Netmaker?
|
||||
Netmaker is a tool for creating and managing virtual networks. The goal is to provide functionality similar to Tailscale, ZeroTier, and Nebula, but faster, easier, and more dynamic. It should be like clicking a button. Netmaker consists of a server, an agent, and a UI. You spin up the Netmaker server and then install netclient (the agent) on your computers. Netmaker will do the rest. It will tell all of your computers how to reach each other and will keep them informed of any changes to the network.
|
||||
Netmaker is a tool for creating and managing virtual networks. If you have servers spread across multiple locations, data centers, or clouds, they all live on separate networks. This can make life very difficult. Netmaker takes all those machines and puts them on a single, flat network so that they can talk to each other easily and securely.
|
||||
|
||||
Think of it like Tailscale, ZeroTier, or Nebula, but faster, easier, and more dynamic.
|
||||
|
||||
You spin up the Netmaker server and UI, and then install the Netclient (agent) on your computers. Netmaker will do the rest. It will tell all of your computers how to reach each other and will keep them informed of any changes to the network.
|
||||
|
||||
Netmaker's handy dandy UI can be found [here](https://github.com/gravitl/netmaker-ui).
|
||||
|
||||
|
|
@ -28,7 +33,9 @@ Under the hood, Netmaker uses WireGuard to create encrypted tunnels between ever
|
|||
|
||||
## Compatible Systems
|
||||
|
||||
Netmaker works on most linux systems that have systemd. It works with Fedora, Ubuntu, and Raspian. Just make sure you have WireGuard installed. Having a problem? Open an issue or Contact us.
|
||||
Netmaker is primarily designed for **linux**, specifically **systemd-based linux.** This includes Fedora, Ubuntu, and Raspian. Just make sure you have WireGuard installed. Having a problem? Open an issue or Contact us.
|
||||
|
||||
In version 0.3 we have released Private DNS. Nameservers can be configured manually on any system, but to have the Netclient add dns automatically, it requires **resolvectl.**
|
||||
|
||||
In future releases, we have plans to support other platforms such as Windows and MacOS.
|
||||
|
||||
|
|
@ -47,33 +54,91 @@ In future releases, we have plans to support other platforms such as Windows and
|
|||
|
||||
[Intro/Overview Video Tutorial](https://youtu.be/PWLPT320Ybo)
|
||||
[Site-to-Site Video Tutorial](https://youtu.be/krCKBJhwwDk)
|
||||
|
||||
#### Prereqs:
|
||||
1. A server with an IP reachable by your computers (a small ec2 instance or droplet would do just fine).
|
||||
2. Linux installed on the above server (we use Ubuntu, but anything that runs Docker should work).
|
||||
3. Install Docker if running in Docker Mode (see below).
|
||||
|
||||
### Note about permissions
|
||||
The default installation requires special privileges on the server side, because Netmaker will control the local kernel Wireguard. This can be turned off and run in non-privileged mode if necessary (but disables some features). For more details, see the **Usage** docs.
|
||||
|
||||
### Prereqs
|
||||
1. A running linux server to host Netmaker, with an IP reachable by your computers (Debian-based preferred but not required).
|
||||
2. Linux installed on the above server (Debian-based preferred but not required).
|
||||
3. Install Docker and Docker Compose if running in Docker Mode (see below).
|
||||
4. System dependencies installed:
|
||||
- Docker (if running in default Docker mode. DO NOT use snap install for docker.)
|
||||
- Docker Compose
|
||||
- Wireguard + Resolvectl (if running in default Client mode)
|
||||
|
||||
#### CoreDNS Preparation
|
||||
v0.3 introduces CoreDNS as a private nameserver. To run CoreDNS on your server host, you must disable systemd-resolved to open port 53:
|
||||
1. systemctl stop systemd-resolved
|
||||
2. systemctl disable systemd-resolved
|
||||
3. vim /etc/systemd/resolved.conf
|
||||
- uncomment **DNS=** and add 8.8.8.8 or whatever is your preference
|
||||
- uncomment **DNSStubListener=** and set to **"no"**
|
||||
4. sudo ln -sf /run/systemd/resolve/resolv.conf /etc/resolv.conf
|
||||
|
||||
|
||||
#### Launch Netmaker:
|
||||
|
||||
Netmaker v0.2 introduces the server as a 'client'. This means the server can add itself into networks if you would like. To do so, Netmaker requires privileged access where it is running, and needs to modify the host filesystem. To run in this mode, we are not currently using Docker.
|
||||
|
||||
**If you would like to run with "client mode", you can use the following script to deploy:**
|
||||
`sudo curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/v0.2/netmaker-install-clientmode.sh | sudo SERVER_DOMAIN=< your server IP > sh -`
|
||||
|
||||
**If you would like to run without "client mode", and manually add/remove the server from networks:**
|
||||
### Launch Netmaker
|
||||
Note, this installs Netmaker with CoreDNS and a Netclient (privileged). If you want to run the server non-privileged or without CoreDNS, see the advanced usage docs.
|
||||
|
||||
1. Clone this repo or just copy contents of "docker-compose.yml" to your Netmaker server (from prereqs).
|
||||
2. In docker-compose.yml, change BACKEND_URL to the public IP of your server.
|
||||
3. Run `sudo docker-compose up`
|
||||
4. Navigate to your server's IP in the browser and you should see the Netmaker UI asking to create a new admin user.
|
||||
5. Create a new admin user
|
||||
6. You are now ready to begin using Netmaker. There should be a default network you can use or you can create your own. Then, Create a key or enable manual node sign up so that your nodes can connect.
|
||||
6. You are now ready to begin using Netmaker.
|
||||
|
||||
#### On your machines :
|
||||
A command will be displayed when you generate a token for signing up nodes. Run it on each machine you would like to connect.
|
||||
`curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/v0.2/netclient-install.sh | KEY=<your access key> sh -`
|
||||
(Note: Key can be left out if manual node signup is enabled)
|
||||
### Create a Network
|
||||
You can also just use the "default" network.
|
||||
1. Click "CREATE NETWORK" in the upper left of your console
|
||||
2. Enter a valid address range, e.g. 10.11.12.0/24
|
||||
3. Enter a name such as "homenet"
|
||||
4. Additional options:
|
||||
- **Dual Stack**: Machines will recieve a private IPv6 address in addition to their IPv4 address.
|
||||
- **Local:** Will use local address range for endpoints instead of public. Use Case: Home or Office network where most devices do not have public IP's. In this case you can create a gateway into the network after creating the Local Network.
|
||||
|
||||
After Network creation, you can edit the network in the NETWORK DETAILS pane, modifying the address range and default options. You can also toggle on **Allow Node Signup Without Keys**, which makes the next step unnecessary, but allows anyone to create a node in your network, which will be cordoned in pending state.
|
||||
|
||||
### Create Keys
|
||||
1. Click the "ACCESS KEYS" tab
|
||||
2. Click "ADD NEW ACCESSS KEY"
|
||||
3. Give your key a name and number of uses
|
||||
4. Several values will be displayed. Save these somewhere, as they will only be displayed once:
|
||||
- **Access Key:** Use only in special edge cases where server connection string must be modified
|
||||
- **Access Token:** Use on machines that already have the netclient utility
|
||||
- **Install Command:** Use on machines that do not have the netclient utility
|
||||
|
||||
### Install Agent:
|
||||
For machines **without** netclient, run the install command (from above): `curl -sfL https://raw.githubusercontent.com/gravitl/netmaker/v0.2/netclient-install.sh | KEY=<your access key> sh -`
|
||||
For machines **with** netclient run the following (with access token from above): `sudo netclient -c install -t <access token>`
|
||||
For networks with **manual signup** enabled (see above), install using the network name: `sudo netclient -c install -n <network name>`
|
||||
|
||||
### Manage Nodes
|
||||
Your machines should now be visible in the control pane.
|
||||
**Modify nodes:** Click the pencil icon in the NODES pane to modify details like WireGuard port, address, and node name. You can also **DELETE** nodes here and they will lose network access.
|
||||
**Approve nodes:** If a node is in pending state (signed up without key), you can approve it. An icon will appear for pending nodes that need approval.
|
||||
|
||||
**Gateway Mode:** Click the Gateway icon to enable gateway mode on a given node. A popup will allow you to choose an existing network, or enter a custom address range.
|
||||
*Example: You create a network in netmaker called Homenet. It has several machines on your home server. You create another network called Cloudnet. It has several machines in AWS. You have one server (server X) which is added to both networks. On Cloudnet, you make Server X a gateway to Homenet. Now, the cloudnet machines have access to your homenet machines. via Server X.*
|
||||
|
||||
*On Homenet, you add Server Y, a machine in AWS, and make it a gateway to a custom address range 172.16.0.0/16. The machines on your home network now have access to any AWS machines in that address range via Server Y*
|
||||
|
||||
### Manage DNS
|
||||
On the DNS tab you can create custom DNS entries for a given network.
|
||||
|
||||
1. All dns entries will be *postfixed* with a private TLD of the network name, for example, ".mynet"
|
||||
2. Default DNS is created for node name + TLD, for instance, node-c42wt.mynet. This is not editable.
|
||||
3. Click ADD ENTRY to add custom DNS
|
||||
- You can click CHOOSE NODE to direct DNS to a specific node in the network
|
||||
- You can also specify any custom address you would like, which can be outside the network (for instance, the IP for google.com)
|
||||
- Add a dns entry name, which will be postfixed with the network TLD. E.g. if you enter "privateapi.com", it will become "privateapi.com.networkname"
|
||||
|
||||
### Uninstalling Client
|
||||
To uninstall the client from a network: `sudo netclient -c remove -n < networkname >`
|
||||
To uninstall entirely, run the above for each network, and then run `sudo rm -rf /etc/netclient`
|
||||
|
||||
### Uninstralling Netmaker
|
||||
To uninstall the netmaker server, simply run `docker-compose down`
|
||||
|
||||
#### LICENSE
|
||||
|
||||
|
|
@ -81,5 +146,5 @@ Netmaker's source code and all artifacts in this repository are freely available
|
|||
|
||||
#### CONTACT
|
||||
|
||||
Email: info@gravitl.com
|
||||
Email: alex@gravitl.com
|
||||
Discord: https://discord.gg/zRb9Vfhk8A
|
||||
|
|
|
|||
|
|
@ -375,16 +375,11 @@ func CreateNode(node models.Node, networkName string) (models.Node, error) {
|
|||
//Anyways, this scrolls through all the IP Addresses in the network range and checks against nodes
|
||||
//until one is open and then returns it
|
||||
node.Address, err = functions.UniqueAddress(networkName)
|
||||
fmt.Println("Setting node address: " + node.Address)
|
||||
if err != nil {
|
||||
return node, err
|
||||
}
|
||||
fmt.Println("Setting node address: " + node.Address)
|
||||
|
||||
node.Address6, err = functions.UniqueAddress6(networkName)
|
||||
if node.Address6 != "" {
|
||||
fmt.Println("Setting node ipv6 address: " + node.Address6)
|
||||
}
|
||||
if err != nil {
|
||||
return node, err
|
||||
}
|
||||
|
|
|
|||
|
|
@ -35,6 +35,17 @@ func (s *NodeServiceServer) ReadNode(ctx context.Context, req *nodepb.ReadNodeRe
|
|||
}
|
||||
*/
|
||||
// Cast to ReadNodeRes type
|
||||
dualvar := false
|
||||
if network.IsDualStack != nil {
|
||||
dualvar = *network.IsDualStack
|
||||
}
|
||||
localvar := false
|
||||
if network.IsLocal != nil {
|
||||
localvar = *network.IsLocal
|
||||
}
|
||||
|
||||
|
||||
|
||||
response := &nodepb.ReadNodeRes{
|
||||
Node: &nodepb.Node{
|
||||
Macaddress: node.MacAddress,
|
||||
|
|
@ -54,8 +65,8 @@ func (s *NodeServiceServer) ReadNode(ctx context.Context, req *nodepb.ReadNodeRe
|
|||
Publickey: node.PublicKey,
|
||||
Listenport: node.ListenPort,
|
||||
Keepalive: node.PersistentKeepalive,
|
||||
Islocal: *network.IsLocal,
|
||||
Isdualstack: *network.IsDualStack,
|
||||
Islocal: localvar,
|
||||
Isdualstack: dualvar,
|
||||
Localrange: network.LocalRange,
|
||||
|
||||
},
|
||||
|
|
@ -127,6 +138,15 @@ func (s *NodeServiceServer) CreateNode(ctx context.Context, req *nodepb.CreateNo
|
|||
fmt.Sprintf("Internal error: %v", err),
|
||||
)
|
||||
}
|
||||
dualvar := false
|
||||
if network.IsDualStack != nil {
|
||||
dualvar = *network.IsDualStack
|
||||
}
|
||||
localvar := false
|
||||
if network.IsLocal != nil {
|
||||
localvar = *network.IsLocal
|
||||
}
|
||||
|
||||
// return the node in a CreateNodeRes type
|
||||
response := &nodepb.CreateNodeRes{
|
||||
Node: &nodepb.Node{
|
||||
|
|
@ -144,8 +164,8 @@ func (s *NodeServiceServer) CreateNode(ctx context.Context, req *nodepb.CreateNo
|
|||
Publickey: node.PublicKey,
|
||||
Listenport: node.ListenPort,
|
||||
Keepalive: node.PersistentKeepalive,
|
||||
Islocal: *network.IsLocal,
|
||||
Isdualstack: *network.IsDualStack,
|
||||
Islocal: localvar,
|
||||
Isdualstack: dualvar,
|
||||
Localrange: network.LocalRange,
|
||||
},
|
||||
}
|
||||
|
|
@ -256,6 +276,15 @@ func (s *NodeServiceServer) UpdateNode(ctx context.Context, req *nodepb.UpdateNo
|
|||
fmt.Sprintf("Could not find node with supplied Mac Address: %v", err),
|
||||
)
|
||||
}
|
||||
dualvar := false
|
||||
if network.IsDualStack != nil {
|
||||
dualvar = *network.IsDualStack
|
||||
}
|
||||
localvar := false
|
||||
if network.IsLocal != nil {
|
||||
localvar = *network.IsLocal
|
||||
}
|
||||
|
||||
return &nodepb.UpdateNodeRes{
|
||||
Node: &nodepb.Node{
|
||||
Macaddress: newnode.MacAddress,
|
||||
|
|
@ -274,8 +303,8 @@ func (s *NodeServiceServer) UpdateNode(ctx context.Context, req *nodepb.UpdateNo
|
|||
Dnsoff: servercfg.IsDNSMode(),
|
||||
Listenport: newnode.ListenPort,
|
||||
Keepalive: newnode.PersistentKeepalive,
|
||||
Islocal: *network.IsLocal,
|
||||
Isdualstack: *network.IsDualStack,
|
||||
Islocal: localvar,
|
||||
Isdualstack: dualvar,
|
||||
Localrange: network.LocalRange,
|
||||
|
||||
},
|
||||
|
|
|
|||
|
|
@ -528,11 +528,6 @@ func UniqueAddress6(networkName string) (string, error) {
|
|||
return "", nil
|
||||
}
|
||||
|
||||
if err != nil {
|
||||
fmt.Println("UniqueAddress6 encountered an error")
|
||||
return "666", err
|
||||
}
|
||||
|
||||
offset := true
|
||||
ip, ipnet, err := net.ParseCIDR(network.AddressRange6)
|
||||
if err != nil {
|
||||
|
|
@ -544,7 +539,7 @@ func UniqueAddress6(networkName string) (string, error) {
|
|||
offset = false
|
||||
continue
|
||||
}
|
||||
if IsIPUnique(networkName, ip.String()) {
|
||||
if IsIP6Unique(networkName, ip.String()) {
|
||||
return ip.String(), err
|
||||
}
|
||||
}
|
||||
|
|
@ -616,6 +611,35 @@ func IsIPUnique(network string, ip string) bool {
|
|||
return isunique
|
||||
}
|
||||
|
||||
//checks if IP is unique in the address range
|
||||
//used by UniqueAddress
|
||||
func IsIP6Unique(network string, ip string) bool {
|
||||
|
||||
var node models.Node
|
||||
|
||||
isunique := true
|
||||
|
||||
collection := mongoconn.Client.Database("netmaker").Collection("nodes")
|
||||
ctx, cancel := context.WithTimeout(context.Background(), 10*time.Second)
|
||||
|
||||
filter := bson.M{"address6": ip, "network": network}
|
||||
|
||||
err := collection.FindOne(ctx, filter).Decode(&node)
|
||||
|
||||
defer cancel()
|
||||
|
||||
if err != nil {
|
||||
fmt.Println(err)
|
||||
return isunique
|
||||
}
|
||||
|
||||
if node.Address6 == ip {
|
||||
isunique = false
|
||||
}
|
||||
return isunique
|
||||
}
|
||||
|
||||
|
||||
//called once key has been used by createNode
|
||||
//reduces value by one and deletes if necessary
|
||||
func DecrimentKey(networkName string, keyvalue string) {
|
||||
|
|
|
|||
Loading…
Reference in a new issue