20 lines
1.6 KiB
Markdown
20 lines
1.6 KiB
Markdown
|
# Introduction
|
||
|
|
|
||
|
|
**trifid** is a complete open-source reimplementation of the [Defined Networking](https://defined.net) management protocol for [Nebula](https://github.com/slackhq/nebula) networks.
|
||
|
|
|
||
|
|
It makes it easy to run a completley self-hosted mesh VPN with very little effort.
|
||
|
|
|
||
|
|
In addition to the API server reimplementation and custom client, we include a command-line tool for interacting with the [Management API](https://docs.defined.net), fully compatible with the upstream API or any custom API server like trifid.
|
||
|
|
|
||
|
|
We also include a Rust library for interacting with keys and certificates in the Nebula PKI. Find it on crates.rs as trifid-pki. This library is an implementation of the Nebula PKI system that is mostly feature-complete, with the exception of non-Curve25519 cryptography, which is currently unsupported.
|
||
|
|
|
||
|
|
This set of pages contains complete documentation on how to use the various parts of the trifid project, with the exception of the library crates, `dnapi-rs` and `trifid-pki`, as those are self-documented Rust libraries with good documentation available through docs.rs.
|
||
|
|
|
||
|
|
If you are looking for documentation on **tfclient**, the trifid implementation of dnclient, see [it's documentation index](./tfclient/index.md).
|
||
|
|
|
||
|
|
If you are a *user* on a trifid-api instance (you are part of an organization on the instance), see [the trifid-api user guide](./trifid-api/users/index.md).
|
||
|
|
|
||
|
|
If you are an administrator on a trifid-api instance or are looking to set one up, see [the trifid-api administrator guide](./trifid-api/index.md).
|
||
|
|
|
||
|
|
If you are looking for documentation on **tfcli**, the management CLI, see [it's documentation index](./tfcli/index.md).
|