diff --git a/README.md b/README.md index 9ddd4a2..e71f0ef 100644 --- a/README.md +++ b/README.md @@ -19,7 +19,7 @@ fedimint-clientd \ --mode="default" ENV USAGE: -FM_DB_PATH=/absolute/path/to/dir/to/store/database +FEDIMINT_CLIENTD_DB_PATH=/absolute/path/to/dir/to/store/database FEDIMINT_CLIENTD_PASSWORD="some-secure-password-that-becomes-the-bearer-token" FEDIMINT_CLIENTD_ADDR="127.0.0.1:8080" FEDIMINT_CLIENTD_MODE="default" @@ -27,7 +27,11 @@ FEDIMINT_CLIENTD_MODE="default" ## Fedimint Clientd Endpoints -`fedimint-clientd` supports the following endpoints (and has naive websocket support at `/fedimint/v2/ws`, see code for details until I improve the interface. PRs welcome!) +`fedimint-clientd` supports the following endpoints (and has naive websocket support at `/fedimint/v2/ws`, see code for details until I improve the interface. PRs welcome!). All the endpoints are authed with a Bearer token from the password (from CLI or env). You can hit the endpoints as such with curl, or use the python/typescript/golang wrappers: + +``` +curl http://localhost:3333/fedimint/v2/admin/info -H 'Authorization: Bearer some-secure-password-that-becomes-the-bearer-token' +``` ### Admin related commands: diff --git a/example.env b/example.env index 939ace4..49bc932 100644 --- a/example.env +++ b/example.env @@ -1,5 +1,4 @@ -FEDERATION_INVITE_CODE = 'fed1-invite-code' -FM_DB_PATH = '/absolute/path/to/fm_db_dir' -PASSWORD = 'password' -DOMAIN = 'localhost' -PORT = 3333 +FEDIMINT_CLIENTD_INVITE_CODE = 'fed1...' +FEDIMINT_CLIENTD_DB_PATH = '/absolute/path/to/fm_db_dir' +FEDIMINT_CLIENTD_PASSWORD = 'some-secure-password-that-becomes-the-bearer-token' +FEDIMINT_CLIENTD_ADDR = '127.0.0.1:3333'