diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..406ce47 --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,8 @@ +The MIT License (MIT) +Copyright © 2020 + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index e69de29..4bd0711 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,22 @@ +# Nebula Manager + +[Nebula](https://github.com/slackhq/nebula) is a mesh overlay network project open sourced by Slack. The purpose of the project is to provide a way to run a NAT punching peer to peer UDP mesh overlay network. This design allows for a limited number of public servers to facilitate networking for clients and nodes behind NAT, and when failing to provide a direct connection fallback to proxying those network requests. It is similar in purpose to [ZeroTier](https://www.zerotier.com), but this project is open source. + +## Purpose + +Provide tooling to manage the root CA, configuration, and provisioning of nodes and clients. This tool does not deploy or manage a network deployment, for that purpose look into []() with Ansible. + +## Usage + +``` +``` + +## Contributing + +See CONTRIBUTING.md + +## Acknowledgements + +## License + +See LICENSE.txt diff --git a/config.yaml.j2 b/config.yaml.j2 new file mode 100644 index 0000000..e69de29