Add note on generating API token (#1294)

This commit is contained in:
Jamil
2023-01-12 23:12:11 -08:00
committed by GitHub
parent 51a0cf251e
commit b9328c4145
3 changed files with 31 additions and 9 deletions

View File

@@ -47,16 +47,21 @@ docker compose up -d
If you hit any issues, please let us know by [filing an
issue](https://github.com/firezone/firezone/issues/new/choose).
<!--
## Upgrading to 0.7.x
Firezone 0.7.0 introduces a new REST API that replaces many of the legacy environment
variables.
Firezone 0.7.0 introduces a new [REST API](/references/api/) that allows administrators
to automate much of the day to day configuration of Firezone.
Due to this, If you're running Firezone &lt; 0.6, we recommend updating to the latest
The REST API `/v0/configuration` endpoint supersedes some of the previous environment
variables used for WireGuard server configuration.
If you're running Firezone &lt; 0.6, we recommend updating to the latest
0.6.x release **before** upgrading to 0.7. This will ensure any environment variables
are properly parsed and migrated into the DB as runtime `configurations`.
-->
**Note**: Omnibus deployments are deprecated in 0.7.x and will be removed in Firezone
0.8 and above. We recommend [migrating your installation](/administer/migrate/) to
Docker if you haven't done so already.
## Upgrading to >= 0.6.12

View File

@@ -1,4 +0,0 @@
---
title: REST API
sidebar_position: 10
---

View File

@@ -0,0 +1,21 @@
---
title: REST API
sidebar_position: 10
---
Welcome to Firezone REST API v0 documentation.
## Getting started
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.
```mdx-code-block
import DocCardList from '@theme/DocCardList';
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
<DocCardList items={useCurrentSidebarCategory().items}/>
```