Merge pull request #1128 from gravitl/feature_v0.14.1_readme

updating readme
This commit is contained in:
dcarns 2022-05-24 16:06:07 -04:00 committed by GitHub
commit 1545820381
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 15 additions and 12 deletions

View file

@ -21,8 +21,8 @@ a platform for modern, blazing fast virtual networks
<a href="https://github.com/gravitl/netmaker/graphs/contributors"> <a href="https://github.com/gravitl/netmaker/graphs/contributors">
<img src="https://img.shields.io/github/commit-activity/m/gravitl/netmaker?color=blue" /> <img src="https://img.shields.io/github/commit-activity/m/gravitl/netmaker?color=blue" />
</a> </a>
<a href="https://twitter.com/intent/follow?screen_name=gravitlcorp"> <a href="https://twitter.com/intent/follow?screen_name=netmaker_io">
<img src="https://img.shields.io/twitter/follow/gravitlcorp?style=social" /> <img src="https://img.shields.io/twitter/follow/netmaker_io?style=social" />
</a> </a>
<a href="https://www.youtube.com/channel/UCach3lJY_xBV7rGrbUSvkZQ"> <a href="https://www.youtube.com/channel/UCach3lJY_xBV7rGrbUSvkZQ">
<img src="https://img.shields.io/youtube/channel/views/UCach3lJY_xBV7rGrbUSvkZQ?style=social" /> <img src="https://img.shields.io/youtube/channel/views/UCach3lJY_xBV7rGrbUSvkZQ?style=social" />
@ -48,7 +48,9 @@ a platform for modern, blazing fast virtual networks
`wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash` `wget -qO - https://raw.githubusercontent.com/gravitl/netmaker/master/scripts/nm-quick.sh | sudo bash`
<img src="./img/visit-website.gif" width="50%" /><img src="./img/graph-readme.gif" width="50%" /> <p float="left" align="middle">
<img src="./img/readme.gif" />
</p>
Upon completion, the logs will display the instructions to connect various devices. These can also be retrieved from the UI under "Access Keys." Upon completion, the logs will display the instructions to connect various devices. These can also be retrieved from the UI under "Access Keys."
@ -106,6 +108,9 @@ After installing Netmaker, check out the [Walkthrough](https://itnext.io/getting
- [Terraform Provider](https://github.com/madacluster/netmaker-terraform-provider) - [Terraform Provider](https://github.com/madacluster/netmaker-terraform-provider)
- [VyOS Integration](https://github.com/kylechase/vyos-netmaker)
- [Netmaker K3S](https://github.com/geragcp/netmaker-k3s)
## Disclaimer ## Disclaimer
[WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld. [WireGuard](https://wireguard.com/) is a registered trademark of Jason A. Donenfeld.

View file

@ -3,7 +3,7 @@ version: "3.4"
services: services:
netmaker: netmaker:
container_name: netmaker container_name: netmaker
image: gravitl/netmaker:v0.13.1 image: gravitl/netmaker:v0.14.1
volumes: volumes:
- dnsconfig:/root/config/dnsconfig - dnsconfig:/root/config/dnsconfig
- /usr/bin/wg:/usr/bin/wg - /usr/bin/wg:/usr/bin/wg
@ -38,7 +38,7 @@ services:
container_name: netmaker-ui container_name: netmaker-ui
depends_on: depends_on:
- netmaker - netmaker
image: gravitl/netmaker-ui:v0.13.1 image: gravitl/netmaker-ui:v0.14.1
links: links:
- "netmaker:api" - "netmaker:api"
ports: ports:

View file

@ -45,7 +45,7 @@ services:
container_name: netmaker-ui container_name: netmaker-ui
depends_on: depends_on:
- netmaker - netmaker
image: gravitl/netmaker-ui:v0.13.1 image: gravitl/netmaker-ui:v0.14.1
links: links:
- "netmaker:api" - "netmaker:api"
ports: ports:

View file

@ -35,11 +35,10 @@ services:
MQ_HOST: "mq" MQ_HOST: "mq"
HOST_NETWORK: "off" HOST_NETWORK: "off"
VERBOSITY: "1" VERBOSITY: "1"
PORT_FORWARD_SERVICES: "dns"
MANAGE_IPTABLES: "on" MANAGE_IPTABLES: "on"
PORT_FORWARD_SERVICES: "dns"
ports: ports:
- "51821-51830:51821-51830/udp" - "51821-51830:51821-51830/udp"
- "8081:8081"
netmaker-ui: netmaker-ui:
container_name: netmaker-ui container_name: netmaker-ui
depends_on: depends_on:
@ -47,8 +46,6 @@ services:
image: gravitl/netmaker-ui:v0.14.1 image: gravitl/netmaker-ui:v0.14.1
links: links:
- "netmaker:api" - "netmaker:api"
ports:
- "8082:80"
environment: environment:
BACKEND_URL: "https://api.NETMAKER_BASE_DOMAIN" BACKEND_URL: "https://api.NETMAKER_BASE_DOMAIN"
restart: always restart: always
@ -65,7 +62,9 @@ services:
image: caddy:latest image: caddy:latest
container_name: caddy container_name: caddy
restart: unless-stopped restart: unless-stopped
network_mode: host # Wants ports 80 and 443! ports:
- "80:80"
- "443:443"
volumes: volumes:
- /root/Caddyfile:/etc/caddy/Caddyfile - /root/Caddyfile:/etc/caddy/Caddyfile
# - $PWD/site:/srv # you could also serve a static site in site folder # - $PWD/site:/srv # you could also serve a static site in site folder
@ -78,7 +77,6 @@ services:
container_name: mq container_name: mq
restart: unless-stopped restart: unless-stopped
ports: ports:
- "127.0.0.1:1883:1883"
- "8883:8883" - "8883:8883"
volumes: volumes:
- /root/mosquitto.conf:/mosquitto/config/mosquitto.conf - /root/mosquitto.conf:/mosquitto/config/mosquitto.conf

BIN
img/readme.gif Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB