From b9328c41454339dafddbad713a0dd014a4f7841d Mon Sep 17 00:00:00 2001 From: Jamil Date: Thu, 12 Jan 2023 23:12:11 -0800 Subject: [PATCH] Add note on generating API token (#1294) --- docs/docs/administer/upgrade.mdx | 15 ++++++++++----- docs/docs/reference/api/README.md | 4 ---- docs/docs/reference/api/README.mdx | 21 +++++++++++++++++++++ 3 files changed, 31 insertions(+), 9 deletions(-) delete mode 100644 docs/docs/reference/api/README.md create mode 100644 docs/docs/reference/api/README.mdx diff --git a/docs/docs/administer/upgrade.mdx b/docs/docs/administer/upgrade.mdx index 3c4cd748b..6acb08ad0 100644 --- a/docs/docs/administer/upgrade.mdx +++ b/docs/docs/administer/upgrade.mdx @@ -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). - + +**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 diff --git a/docs/docs/reference/api/README.md b/docs/docs/reference/api/README.md deleted file mode 100644 index 5a0b03a6f..000000000 --- a/docs/docs/reference/api/README.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: REST API -sidebar_position: 10 ---- diff --git a/docs/docs/reference/api/README.mdx b/docs/docs/reference/api/README.mdx new file mode 100644 index 000000000..563416db9 --- /dev/null +++ b/docs/docs/reference/api/README.mdx @@ -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'; + + +```