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
Neriderc cc42830e23
website/integrations: add Paperless-ng instructions (#2225)
* Update instructions

I've updated the steps to provide some clarity around certain areas that tripped me up as a newcomer to authentik trying to follow these instructions.

* Added Paperless

Added authentik instructions for Paperless-ng

* Moved to paperless-ng directory

* Minor update to remove redundant part

Removed example authentik.company as these instructions do not require referencing authentik host name directly.

* Added Paperless-ng

* Typo fix

* Formatting changes

Updated changes based on feedback
2022-02-10 09:45:22 +01:00
..
developer-docs website/docs: add rough documentation style guide 2022-01-29 23:52:03 +01:00
docs Merge branch 'version-2022.1' 2022-02-09 22:45:26 +01:00
help root: fix linting errors 2021-07-18 20:54:34 +02:00
integrations website/integrations: add Paperless-ng instructions (#2225) 2022-02-10 09:45:22 +01:00
netlify/functions website: remove .git suffix for go import 2021-10-18 17:48:13 +02:00
src website: remove remaining /index URLs 2021-12-13 19:01:16 +01:00
static website: remove static service account, use helm chart instead 2021-11-03 00:14:01 +01: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/docs: add proxy custom header docs 2021-11-30 11:12:34 +01:00
docusaurus.docs-only.js website: fix build for docs-only target 2021-11-22 12:11:24 +01:00
netlify.toml website: add initial redirect (#1918) 2021-12-13 20:42:31 +00:00
package-lock.json build(deps): bump postcss from 8.4.5 to 8.4.6 in /website (#2207) 2022-02-02 09:41:37 +01:00
package.json build(deps): bump postcss from 8.4.5 to 8.4.6 in /website (#2207) 2022-02-02 09:41:37 +01:00
README.md Migrate to Docusaurus (#329) 2020-11-15 22:42:02 +01:00
sidebars.js *: remove deprecated backup (#2129) 2022-02-05 18:54:15 +01:00
sidebarsDev.js website/docs: add rough documentation style guide 2022-01-29 23:52:03 +01:00
sidebarsIntegrations.js website/integrations: add Paperless-ng instructions (#2225) 2022-02-10 09:45:22 +01: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.