1
0
mirror of https://github.com/Unleash/unleash.git synced 2025-09-10 17:53:36 +02:00
unleash.unleash/website
Thomas Heartman 08dbf23ee7
docs: mention env var options for auth config (#3169)
## What

Adds environment variable equivalents for remaining authentication
options.

Also reformats the list silghtly.

## Why

Because the `AUTH_TYPE` and `AUTH_ENABLE_API_TOKEN` variables hadn't
been previously mentioned and we get questions about this from time to
time.

The reformat is primarily for using `monospace font` where appropriate.
2023-02-22 12:32:27 +01:00
..
.storybook
docs docs: mention env var options for auth config (#3169) 2023-02-22 12:32:27 +01:00
remote-content
src
static
.gitignore
babel.config.js
clean-generated-docs.js
docusaurus.config.js
package.json
README.md
sidebars.js
tsconfig.json
yarn.lock

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.