mirror of
https://github.com/gravitl/netmaker.git
synced 2024-09-21 07:46:04 +08:00
Merge pull request #313 from gravitl/hotfix_v0.8.1_netclient
Hotfix v0.8.1 netclient
This commit is contained in:
commit
db462578cb
84
README.md
84
README.md
|
@ -1,79 +1,53 @@
|
|||
|
||||
<p align="center">
|
||||
<img src="netmaker.png"><break/>
|
||||
<img src="netmaker.png" width="75%"><break/>
|
||||
</p>
|
||||
<p align="center">
|
||||
<i>Connect any computers together over a secure, fast, private network, and manage multiple networks from a central server.</i>
|
||||
<i>Create and control automated virtual networks.</i>
|
||||
</p>
|
||||
|
||||
## Documentation
|
||||
# WireGuard® Automation from Homelab to Enterprise
|
||||
- [x] Peer-to-Peer Mesh Networks
|
||||
- [x] Site-to-Site Gateways
|
||||
- [x] Private DNS
|
||||
- [x] Kubernetes Multi-Cloud
|
||||
- [x] Linux, Mac, Windows, iPhone, and Android
|
||||
|
||||
### Netmaker's documentation can be found at:
|
||||
### [docs.netmaker.org](https://docs.netmaker.org)
|
||||
### [netmaker.readthedocs.io](https://netmaker.readthedocs.io)
|
||||
# Get Started in 5 Minutes
|
||||
|
||||
## 3 Minute PoC Install
|
||||
|
||||
Looking to test out Netmaker as quickly as possible? You'll need:
|
||||
|
||||
1. A cloud VM running Ubuntu 20.04 with a public IP
|
||||
- DigitalOcean, Linode, AWS, GCP, etc.
|
||||
2. Open firewall ports 443 and 51821/udp-51830/udp
|
||||
- If running behind security groups (AWS, GCP, etc.) make sure they're open there too.
|
||||
3. Docker, docker-compose, and wireguard installed
|
||||
- apt -y install wireguard docker docker-compose
|
||||
|
||||
Once this is done, simply run the below command:
|
||||
1. Get a cloud VM with Ubuntu 20.04 and a public IP.
|
||||
2. Open ports 443, 53, and 51821-51830/udp on the VM firewall and in cloud security settings.
|
||||
3. Run the script:
|
||||
|
||||
`sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash`
|
||||
|
||||
![animation](docs/images/install-server.gif)
|
||||
![animation](docs/images/visit-website.gif)
|
||||
<img src="./docs/images/install-server.gif" width="50%" /><img src="./docs/images/visit-website.gif" width="50%" />
|
||||
|
||||
If this script is not working for you, or you are looking for a more complete, production-ready installation, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html).
|
||||
(For a more customized install, including using your own domain, head over to [the quick start guide](https://docs.netmaker.org/quick-start.html).)
|
||||
|
||||
After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting-started-with-netmaker-a-wireguard-virtual-networking-platform-3d563fbd87f0) and [Getting Started](https://netmaker.readthedocs.io/en/master/getting-started.html) guide to begin setting up networks. Or, check out some of our other [Tutorials](https://gravitl.com/resources) for different use cases, including Kubernetes.
|
||||
|
||||
# Why Netmaker + WireGuard?
|
||||
|
||||
- Netmaker automates virtual networks between data centers, clouds, and edge devices, so you don't have to.
|
||||
|
||||
## What is Netmaker?
|
||||
Netmaker is a platform for creating and managing networks that are:
|
||||
- Kernel WireGuard offers maximum speed, performance, and security.
|
||||
|
||||
- Fast
|
||||
- Secure
|
||||
- Dynamic
|
||||
- Virtual
|
||||
- Zero-Trust
|
||||
- WireGuard-based
|
||||
- Netmaker is built to scale from the small business to the enterprise.
|
||||
|
||||
Netmaker manages networks between computers that span data centers, clouds, and edge devices. Networking between environments can be a challenge, so Netmaker is designed to allow developers, DevOps engineers, SRE's, and others to manage virtual networks with as little pain as possible. You create a network with a few clicks, and add machines to that network with a single command.
|
||||
- Netmaker with WireGuard can be highly customized for peer-to-peer, site-to-site, Kubernetes, and more.
|
||||
|
||||
## Why Netmaker?
|
||||
1. Create a flat, secure network between multiple/hybrid cloud environments
|
||||
2. Integrate central and edge services
|
||||
3. Secure a home or office network while providing remote connectivity
|
||||
4. Provide an additional layer of security on an existing network
|
||||
5. Encrypt Kubernetes inter-node communications
|
||||
6. Secure site-to-site connections
|
||||
7. Connect to IoT devices
|
||||
8. Manage an existing WireGuard setup with less manual configuration
|
||||
# Get Support
|
||||
|
||||
<p align="center">
|
||||
<img src="mesh-diagram.png">
|
||||
</p>
|
||||
- [Community (Discord)](https://discord.gg/zRb9Vfhk8A)
|
||||
|
||||
- [Business (Subscription)](https://gravitl.com/plans/business)
|
||||
|
||||
#### LICENSE
|
||||
- [Email](mailto:info@gravitl.com)
|
||||
|
||||
## Disclaimer
|
||||
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
|
||||
|
||||
## License
|
||||
|
||||
Netmaker's source code and all artifacts in this repository are freely available. All versions are published under the Server Side Public License (SSPL), version 1, which can be found here: [LICENSE.txt](./LICENSE.txt).
|
||||
|
||||
#### CONTACT
|
||||
|
||||
Email: info@gravitl.com
|
||||
Discord: https://discord.gg/zRb9Vfhk8A
|
||||
|
||||
#### Business Support
|
||||
|
||||
https://gravitl.com/plans/business
|
||||
|
||||
### Disclaimer
|
||||
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
|
BIN
docs/_build/doctrees/environment.pickle
vendored
BIN
docs/_build/doctrees/environment.pickle
vendored
Binary file not shown.
BIN
docs/_build/doctrees/quick-start.doctree
vendored
BIN
docs/_build/doctrees/quick-start.doctree
vendored
Binary file not shown.
|
@ -122,7 +122,7 @@ Prepare Caddy
|
|||
|
||||
.. code-block::
|
||||
|
||||
wget -O /root/Caddyfile https://github.com/gravitl/netmaker/develop/docker/Caddyfile
|
||||
wget -O /root/Caddyfile https://raw.githubusercontent.com/gravitl/netmaker/develop/docker/Caddyfile
|
||||
|
||||
sed -i 's/NETMAKER_BASE_DOMAIN/<your base domain>/g' /root/Caddyfile
|
||||
sed -i 's/YOUR_EMAIL/<your email>/g' /root/Caddyfile
|
||||
|
|
2
docs/_build/html/quick-start.html
vendored
2
docs/_build/html/quick-start.html
vendored
|
@ -902,7 +902,7 @@
|
|||
|
||||
|
||||
<h3 id="prepare-caddy">Prepare Caddy<a class="headerlink" href="#prepare-caddy" title="Permalink to this headline">¶</a></h3>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="o">-</span><span class="n">O</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">Caddyfile</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">gravitl</span><span class="o">/</span><span class="n">netmaker</span><span class="o">/</span><span class="n">develop</span><span class="o">/</span><span class="n">docker</span><span class="o">/</span><span class="n">Caddyfile</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">wget</span> <span class="o">-</span><span class="n">O</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">Caddyfile</span> <span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">raw</span><span class="o">.</span><span class="n">githubusercontent</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">gravitl</span><span class="o">/</span><span class="n">netmaker</span><span class="o">/</span><span class="n">develop</span><span class="o">/</span><span class="n">docker</span><span class="o">/</span><span class="n">Caddyfile</span>
|
||||
|
||||
<span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="s1">'s/NETMAKER_BASE_DOMAIN/<your base domain>/g'</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">Caddyfile</span>
|
||||
<span class="n">sed</span> <span class="o">-</span><span class="n">i</span> <span class="s1">'s/YOUR_EMAIL/<your email>/g'</span> <span class="o">/</span><span class="n">root</span><span class="o">/</span><span class="n">Caddyfile</span>
|
||||
|
|
|
@ -161,7 +161,7 @@ Start Netmaker
|
|||
|
||||
``sudo docker-compose -f docker-compose.yml up -d``
|
||||
|
||||
navigate to dashboard.<your base domain> to see your nginx instance.
|
||||
navigate to dashboard.<your base domain> to log into the UI.
|
||||
|
||||
To troubleshoot issues, start with:
|
||||
|
||||
|
|
|
@ -122,7 +122,7 @@ Prepare Caddy
|
|||
|
||||
.. code-block::
|
||||
|
||||
wget -O /root/Caddyfile https://github.com/gravitl/netmaker/develop/docker/Caddyfile
|
||||
wget -O /root/Caddyfile https://raw.githubusercontent.com/gravitl/netmaker/develop/docker/Caddyfile
|
||||
|
||||
sed -i 's/NETMAKER_BASE_DOMAIN/<your base domain>/g' /root/Caddyfile
|
||||
sed -i 's/YOUR_EMAIL/<your email>/g' /root/Caddyfile
|
||||
|
@ -132,7 +132,7 @@ Start Netmaker
|
|||
|
||||
``sudo docker-compose up -d``
|
||||
|
||||
navigate to dashboard.<your base domain> to see your nginx instance.
|
||||
navigate to dashboard.<your base domain> to begin using Netmaker.
|
||||
|
||||
To troubleshoot issues, start with:
|
||||
|
||||
|
|
Loading…
Reference in a new issue