From ab9439ecfed5be0a308695079e988ab03c1570f9 Mon Sep 17 00:00:00 2001 From: Johan Siebens Date: Sat, 15 Oct 2022 08:27:43 +0200 Subject: [PATCH] chore(docs): update readme --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index ae687ea..d77dc00 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ # ionscale > **Note**: -> ionscale is currently alpha quality, actively being developed and so subject to changes \ No newline at end of file +> ionscale is currently beta quality, actively being developed and so subject to changes + +**What is Tailscale?** + +[Tailscale](https://tailscale.com) is a VPN service that makes the devices and applications you own accessible anywhere in the world, securely and effortlessly. +It enables encrypted point-to-point connections using the open source [WireGuard](https://www.wireguard.com/) protocol, which means only devices on your private network can communicate with each other. + +**What is ionscale?** + +While the Tailscale software running on each node is open source, their centralized "coordination server" which act as a shared drop box for public keys is not. + +_ionscale_ aims to implement such lightweight, open source alternative Tailscale control server. + +## Features + +- multi [tailnet](https://tailscale.com/kb/1136/tailnet/) support +- multi user support +- OIDC integration (not required, although recommended) +- [Auth keys](https://tailscale.com/kb/1085/auth-keys/) +- [Access control list](https://tailscale.com/kb/1018/acls/) +- [DNS](https://tailscale.com/kb/1054/dns/) + - nameservers + - Split DNS + - MagicDNS +- [HTTPS Certs](https://tailscale.com/kb/1153/enabling-https/) +- [Tailscale SSH](https://tailscale.com/kb/1193/tailscale-ssh/) +- [Service collection](https://tailscale.com/kb/1100/services/) +- [Taildrop](https://tailscale.com/kb/1106/taildrop/) + +## Disclaimer + +This is not an official Tailscale or Tailscale Inc. project. \ No newline at end of file