Skip to content

Latest commit

 

History

History
124 lines (79 loc) · 3.94 KB

README.md

File metadata and controls

124 lines (79 loc) · 3.94 KB
Raw

OpenFGA Documentation

FOSSA Status

About OpenFGA

OpenFGA is an open source Fine-Grained Authorization solution based on Google's Zanzibar. It was created by the Okta 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 including JavaScript, 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.

About OpenFGA docs

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

Getting Started

Setup and Installation

Clone the repo locally

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

Setup Git LFS (Large File Storage)

  • Follow the instructions here to install git lfs on your system.
  • If you haven't done so yet, run git lfs install to set up git lfs for your account.
  • Run git lfs pull
  • Run git lfs checkout

Currently mp4, webm and svg files are tracked. If you need to track more media formats, run: git lfs track "*.extension"

Install Dependencies

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

npm install

Running in Development

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.

Building for Production

To generate a production build

NPM

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 at http://localhost:3000/

Docker

Build

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 in http://localhost:3000.

Production

To build in production mode

docker build . -t fga-docs

Run

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

PR Preview

GitHub Action Deploy 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

Contributing

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

Issue Reporting

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

Author

OpenFGA contact@openfga.dev (https://openfga.dev)

License

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