From df1a586d3819863a226a415e86f939a09ed4d606 Mon Sep 17 00:00:00 2001 From: William Petit Date: Tue, 27 Feb 2024 15:15:25 +0100 Subject: [PATCH] doc: add quickstart to readme --- Makefile | 6 ++++++ README.md | 18 ++++++++++++++++-- 2 files changed, 22 insertions(+), 2 deletions(-) diff --git a/Makefile b/Makefile index cce127f..d523831 100644 --- a/Makefile +++ b/Makefile @@ -15,6 +15,12 @@ OPENWRT_DEVICE ?= 192.168.1.1 watch: deps ## Watching updated files - live reload ( set -o allexport && source .env && set +o allexport && go run -mod=readonly github.com/cortesi/modd/cmd/modd@latest ) +clean: + rm -f .emissary-* + rm -f emissary.sqlite* + rm -f server-key.json + rm -f agent-key.json + .PHONY: test test: test-go ## Executing tests diff --git a/README.md b/README.md index 0f6acd8..913cff7 100644 --- a/README.md +++ b/README.md @@ -16,14 +16,28 @@ Control plane for "edge" (and OpenWRT-based) devices. # Start server and a local agent make watch -# In a second terminal, create a api token, an admin token and a tenant +# In an other terminal + +# Create an admin token +make .emissary-admin-token + +# Create a new tenant +make .emissary-tenant + +# Create a new writer token for this tenant make .emissary-token # Claim the agent for your newly created tenant make claim-agent -# Query you agents +# Query your agents ./bin/server client agent query + +# Load sample specs for your agent +make load-sample-specs + +## Optional: reset your workspace +make clean ``` ## Install