https://github.com/msutkowski/fga-elixir-sdk
An elixir client for OpenFGA
https://github.com/msutkowski/fga-elixir-sdk
Last synced: about 1 year ago
JSON representation
An elixir client for OpenFGA
- Host: GitHub
- URL: https://github.com/msutkowski/fga-elixir-sdk
- Owner: msutkowski
- License: apache-2.0
- Created: 2022-12-01T22:59:04.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-12-01T23:08:56.000Z (over 3 years ago)
- Last Synced: 2025-03-25T04:04:17.096Z (over 1 year ago)
- Language: Elixir
- Size: 27.3 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# OpenFGA
A high performance and flexible authorization/permission engine built for developers and inspired by Google Zanzibar.
## Building
To install the required dependencies and to build the elixir project, run:
```console
mix local.hex --force
mix do deps.get, compile
```
## Installation
If [available in Hex][], the package can be installed by adding `openfga_elixir` to
your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:openfga_elixir, "~> 0.1"}]
end
```
Documentation can be generated with [ExDoc][] and published on [HexDocs][]. Once published, the docs can be found at
[https://hexdocs.pm/openfga_elixir][docs].
## Configuration
You can override the URL of your server (e.g. if you have a separate development and production server in your
configuration files).
```elixir
config :openfga_elixir, base_url: "http://localhost"
```
Multiple clients for the same API with different URLs can be created passing different `base_url`s when calling
`OpenFGA.Connection.new/1`:
```elixir
client = OpenFGA.Connection.new(base_url: "http://localhost")
```
[exdoc]: https://github.com/elixir-lang/ex_doc
[hexdocs]: https://hexdocs.pm
[available in hex]: https://hex.pm/docs/publish
[docs]: https://hexdocs.pm/openfga_elixir