ubuntu/openfga repository overview

ubuntu/openfga is a rock for openfga maintained by Canonical⁠.

A high-performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar. OpenFGA is designed to make it easy for developers to model their application permissions and add and integrate fine-grained authorization into their applications. It allows in-memory data storage for quick development, as well as pluggable database modules.

[Learn more about openfga⁠]

⁠Tags and Architectures

NOTE: These tags follow a specific naming convention that respects the concept of channels⁠.

⁠Get started

This rock's entrypoint is Pebble, a container-optimized init process that enables the orchestration of a collection of local service processes as an organized set.

[Learn more about Pebble⁠]

⁠Inspect

To view the Pebble services⁠ and checks⁠ defined in this rock:

docker run --rm ubuntu/openfga:1-22.04_stable plan

⁠Run

To run this rock, use any of the usual container runtimes, for example, docker:

docker run --name openfga-container \
    -p 8080:8080  -p 8081:8081 -p 3000:3000 -p 2112:2112 \
    ubuntu/openfga:1-22.04_stable

Access the API either on http via http://localhost:8080 or grpc on localhost:8081, UI playground on http://localhost:3000. Prometheus metrics are available at http://localhost:2112/metrics.

⁠Get logs

To view the logs of the running container, run:

docker exec openfga-container pebble logs

Or, for a specific service:

docker exec openfga-container pebble logs <service>

⁠Monitor health checks

Rocks may have predefined health checks that you can list by running:

docker exec openfga-container pebble checks

The overall health of your container can be inspected via:

docker exec openfga-container pebble health

⁠Configuration

⁠Environment variables

⁠Ports

⁠Application parameters

[Report a bug⁠] [Contribute⁠]

Canonical is the provider of this container image. It is the user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within, as well as with Canonical’s IP Policy⁠.