Repository files navigation

OpenFGA is an open source Fine-Grained Authorization solution based on Google's Zanzibar. It was created by the Auth0 FGA team and welcomes community contribution. OpenFGA is designed to make it easy for application builders to quickly add fine-grained authorization to their applications. It offers an HTTP API and has SDKs for programming languages includingJavaScript,GoLang and.NET. More SDKs and integrations such as Rego are planned for the future. OpenFGA is designed and optimized for reliability and low latency at a high scale.

This website is built usingDocusaurus, a modern static website generator.

Rungit clone https://github.com/openfga/openfga.dev.git to clone the repo to your machine.

• Follow the instructionshere to install git lfs on your system.
• If you haven't done so yet, rungit lfs install to set up git lfs for your account.
• Rungit lfs pull
• Rungit lfs checkout

Currentlymp4,webm andsvg files are tracked. If you need to track more media formats, run:git lfs track "*.extension"

To run the docs locally you will need to first install dependencies:

npm install

You can then run

npm run dev

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

To generate a production build

npm run build # Generated files will be in the ./build directory

To launch a server with the build files, run

npm run serve

You will then be able to browse the documentation athttp://localhost:3000/

To build in development mode

docker build --target development . -t fga-docs-dev

To run in development mode

docker run --init --rm -p 3000:3000 fga-docs-dev

The generated webpages will be available inhttp://localhost:3000.

To build in production mode

docker build . -t fga-docs

Run

docker run --init --rm -p 3000:80 fga-docs

GitHub ActionDeploy PR Preview allows previewing of proposed changes. The URL for the changes can be previewed via

https://openfga.dev/pr-preview/pr-[number]

For example, previewing changes on PR-589 for changes on docs/modeling/public-access is available via

https://openfga.dev/pr-preview/pr-589/docs/modeling/public-access

Please review theContributing Guidelines before sending a PR or opening an issue.

If you find a bug or inaccuracy in the documentation content, please report it in this repository'sissues section. Please do not report security vulnerabilities on the public GitHub issue tracker. Refer tothe security policy for disclosing security issues.

OpenFGAcontact@openfga.dev (https://openfga.dev)

Please refer tohttps://github.com/openfga/rfcs/blob/main/LICENSE for license information.