44 lines
937 B
Markdown
44 lines
937 B
Markdown
<p align="center">
|
|
<img width="400" src="./misc/resources/logo.svg" />
|
|
</p>
|
|
|
|
Control plane for "edge" (and OpenWRT-based) devices.
|
|
|
|
> ⚠ Emissary is currently in a very alpha stage ! Expect breaking changes...
|
|
|
|
## Quickstart
|
|
|
|
**Dependencies**
|
|
- [Go >= 1.21](https://go.dev/)
|
|
- `GNU Make`
|
|
|
|
```shell
|
|
# Start server and a local agent
|
|
make watch
|
|
|
|
# In a second terminal, create a api token, an admin token and a tenant
|
|
make .emissary-token
|
|
|
|
# Claim the agent for your newly created tenant
|
|
make claim-agent
|
|
|
|
# Query you agents
|
|
./bin/server client agent query
|
|
```
|
|
|
|
## Install
|
|
|
|
### Manually
|
|
|
|
Download the pre-compiled binaries from the [releases page](https://forge.cadoles.com/arcad/emissary/releases) and copy them to the desired location.
|
|
|
|
## Documentation
|
|
|
|
See [`doc`](./doc/README.md)
|
|
|
|
## Licence & mentions
|
|
|
|
[AGPL-3.0](https://www.gnu.org/licenses/agpl-3.0.html#license-text)
|
|
|
|
Logo by [@aardouin](https://forge.cadoles.com/aardouin)
|