This repository has been archived on 2024-05-31. You can view files and clone it, but cannot push or open issues or pull requests.
authentik/website
Felix Eckhofer 923fbac5b0
website/docs: Fix docker-compose example (#1395)
`docker-compose exec` by default allocates a tty and does not support `-it`.

See https://docs.docker.com/compose/reference/exec/
2021-09-14 16:35:01 +02:00
..
developer-docs api: add v3 2021-09-02 17:40:02 +02:00
docs website/docs: Fix docker-compose example (#1395) 2021-09-14 16:35:01 +02:00
help root: fix linting errors 2021-07-18 20:54:34 +02:00
src website: add sentry 2021-07-19 21:50:56 +02:00
static website/docs: make it clearer to use context[] 2021-08-28 12:53:57 +02:00
.gitignore root: build bundled docs into helo dir to fix path issue with packaged static files 2021-07-13 19:09:16 +02:00
.prettierignore Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
.prettierrc.json Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
babel.config.js Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
docusaurus.config.js website: prepare go vanity URL 2021-09-10 17:18:15 +02:00
docusaurus.docs-only.js root: add bundled docs 2021-07-13 11:06:51 +02:00
package-lock.json build(deps-dev): bump prettier from 2.3.2 to 2.4.0 in /website (#1372) 2021-09-10 08:41:38 +02:00
package.json build(deps-dev): bump prettier from 2.3.2 to 2.4.0 in /website (#1372) 2021-09-10 08:41:38 +02:00
README.md Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
sidebars.js website/docs: add embedded outpost docs 2021-08-29 14:43:13 +02:00
sidebarsDev.js website/docs: add docs for websocket connections 2021-08-29 19:49:18 +02:00
static.go root: build bundled docs into helo dir to fix path issue with packaged static files 2021-07-13 19:09:16 +02:00

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 open 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.