netmaker/README.md

73 lines
3.1 KiB
Markdown
Raw Normal View History

2021-03-26 00:17:52 +08:00
<p align="center">
2021-10-04 19:16:13 +08:00
<img src="netmaker.png" width="75%"><break/>
2021-03-26 00:17:52 +08:00
</p>
<p align="center">
2021-10-04 19:16:13 +08:00
<i>Create and control automated virtual networks.</i>
2021-03-26 00:17:52 +08:00
</p>
2021-10-07 06:24:38 +08:00
<p align="center">
<a href="https://github.com/gravitl/netmaker/releases">
<img src="https://img.shields.io/badge/Version-0.8.4-informational?style=flat-square" />
2021-10-07 06:24:38 +08:00
</a>
<a href="https://discord.gg/zRb9Vfhk8A">
<img src="https://img.shields.io/badge/community-discord-informational" />
2021-10-07 06:24:38 +08:00
</a>
<a href="https://github.com/gravitl/netmaker/graphs/contributors">
<img src="https://img.shields.io/github/commit-activity/w/gravitl/netmaker?color=blue" />
2021-10-07 06:24:38 +08:00
</a>
<a href="https://gravitl.com/resources">
<img src="https://img.shields.io/badge/learning-resources-9cf" />
</a>
<a href="https://twitter.com/intent/follow?screen_name=gravitlcorp">
<img src="https://img.shields.io/twitter/follow/gravitlcorp?style=social" />
</a>
<a href="https://www.youtube.com/channel/UCach3lJY_xBV7rGrbUSvkZQ">
<img src="https://img.shields.io/youtube/channel/views/UCach3lJY_xBV7rGrbUSvkZQ?style=social" />
</a>
</p>
2021-10-07 06:21:18 +08:00
2021-10-04 19:16:13 +08:00
# 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
2021-10-04 19:16:13 +08:00
# Get Started in 5 Minutes
2021-10-20 23:11:42 +08:00
**For production-grade installations, visit the [Install Docs](https://netmaker.readthedocs.io/en/develop/install.html).**
2021-10-20 23:06:54 +08:00
**For an HA install using helm on k8s, visit the [Helm Repo](https://github.com/gravitl/netmaker-helm/).**
2021-10-04 19:16:13 +08:00
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:
2021-10-04 04:02:31 +08:00
`sudo wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/develop/scripts/nm-quick.sh | bash`
2021-10-04 19:16:13 +08:00
<img src="./docs/images/install-server.gif" width="50%" /><img src="./docs/images/visit-website.gif" width="50%" />
2021-10-04 19:16:13 +08:00
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.
2021-10-04 19:16:13 +08:00
# Why Netmaker + WireGuard?
2021-10-04 19:16:13 +08:00
- Netmaker automates virtual networks between data centers, clouds, and edge devices, so you don't have to.
2021-10-04 19:16:13 +08:00
- Kernel WireGuard offers maximum speed, performance, and security.
2021-03-30 04:10:18 +08:00
2021-10-04 19:16:13 +08:00
- Netmaker is built to scale from the small business to the enterprise.
2021-03-26 00:17:52 +08:00
2021-10-04 19:16:13 +08:00
- Netmaker with WireGuard can be highly customized for peer-to-peer, site-to-site, Kubernetes, and more.
2021-03-26 00:17:52 +08:00
2021-10-04 19:16:13 +08:00
# Get Support
2021-03-26 00:17:52 +08:00
2021-10-04 19:16:13 +08:00
- [Community (Discord)](https://discord.gg/zRb9Vfhk8A)
2021-03-26 00:17:52 +08:00
2021-10-04 19:16:13 +08:00
- [Business (Subscription)](https://gravitl.com/plans/business)
2021-03-26 00:17:52 +08:00
2021-10-04 19:16:13 +08:00
## Disclaimer
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.
2021-03-30 05:30:52 +08:00
2021-10-04 19:16:13 +08:00
## License
2021-10-07 06:24:38 +08:00
2021-10-04 19:16:13 +08:00
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).