mirror of
https://github.com/outbackdingo/firezone.git
synced 2026-01-27 10:18:54 +00:00
Update default REST API docs path; Note on stdout api tokens (#1306)
This commit is contained in:
@@ -3,7 +3,7 @@ Mox.defmock(OpenIDConnect.Mock, for: OpenIDConnect.MockBehaviour)
|
||||
|
||||
Bureaucrat.start(
|
||||
writer: Firezone.DocusaurusWriter,
|
||||
default_path: "../../docs/docs/reference/api"
|
||||
default_path: "../../docs/docs/reference/rest-api"
|
||||
)
|
||||
|
||||
ExUnit.start(formatters: [ExUnit.CLIFormatter, Bureaucrat.Formatter])
|
||||
|
||||
@@ -49,7 +49,7 @@ issue](https://github.com/firezone/firezone/issues/new/choose).
|
||||
|
||||
## Upgrading to 0.7.x
|
||||
|
||||
Firezone 0.7.0 introduces a new [REST API](/reference/api/) that allows administrators
|
||||
Firezone 0.7.0 introduces a new [REST API](/reference/rest-api/) that allows administrators
|
||||
to automate much of the day to day configuration of Firezone.
|
||||
|
||||
The REST API `/v0/configuration` endpoint supersedes some of the previous environment
|
||||
|
||||
@@ -9,9 +9,22 @@ Welcome to Firezone REST API v0 documentation.
|
||||
|
||||
To get started with the REST API, you'll first need an API token.
|
||||
This can be generated in the UI at `/settings/account` or via the CLI
|
||||
with `docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token`
|
||||
on your live Firezone instance.
|
||||
with:
|
||||
|
||||
```shell
|
||||
docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token
|
||||
```
|
||||
|
||||
**Note**: The token is written to `STDOUT` by default. You may wish to redirect its output
|
||||
to a file instead:
|
||||
|
||||
```shell
|
||||
docker compose -f $HOME/.firezone/docker-compose.yml exec firezone bin/create-api-token > fz_token
|
||||
```
|
||||
|
||||
:::caution
|
||||
API tokens generated from the CLI are owned by the primary administrator.
|
||||
:::
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
Reference in New Issue
Block a user