You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/content/getting-started/setup-openfga/configure-openfga.mdx
+11-45Lines changed: 11 additions & 45 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,51 +17,11 @@ Refer to the [OpenFGA Getting Started](https://github.com/openfga/openfga?tab=re
17
17
18
18
The instructions below assume OpenFGA is installed and that you have the `openfga` binary in your PATH. If you have built `openfga` as a binary, but not in your path, you can refer to it directly (e.g. replace `openfga` in the instructions below with `./openfga` or `/path/to/openfga`).
19
19
20
-
You can configure the OpenFGA server in three ways:
20
+
For a list of all the configuration options that the latest release of OpenFGA supports, see [Configuration Options](./configuration.mdx), or you can run `openfga --help` to see the ones specific to your version.
21
21
22
-
- Using a configuration file.
23
-
- Using environment variables.
24
-
- Using command line parameters.
25
-
26
-
If the same option is configured in multiple ways the command line parameters will take precedence over environment variables, which will take precedence over the configuration file.
27
-
28
-
The configuration options and their default values are shown via `openfga run --help`, and defined in [config-schema.json](https://github.com/openfga/openfga/blob/main/.config-schema.json).
29
-
30
-
## Using a configuration file
31
-
32
-
You can configure the OpenFGA server with a `config.yaml` file, which can be specified in either:
33
-
-`/etc/openfga`
34
-
-`$HOME/.openfga`
35
-
-`.` (i.e., the current working directory).
36
-
37
-
The OpenFGA server will search for the configuration file in the above order.
38
-
39
-
Here is a sample configuration to run OpenFGA with a Postgres database and using a preshared key for authentication:
The instructions below are for configuring the standalone OpenFGA server. If you are using OpenFGA as a library, you can refer to the [GoDoc](https://pkg.go.dev/github.com/openfga/openfga) for more information.
Various releases of OpenFGA may have experimental features that can be enabled by providing the `--experimentals` flag or the `experimentals` config.
237
+
Various releases of OpenFGA may have experimental features that can be enabled by providing the [`--experimentals`](./configuration.mdx#OPENFGA_EXPERIMENTALS) flag or the `experimentals` config.
278
238
279
239
```
280
240
openfga run --experimentals="feature1, feature2"
@@ -356,6 +316,12 @@ It is highly recommended to enable logging in production environments. Disabling
356
316
<RelatedSection
357
317
description="Check the following sections for more on how to use OpenFGA."
358
318
relatedLinks={[
319
+
{
320
+
title: 'Configuration Options',
321
+
description: 'Find out all the different flags and options that OpenFGA accepts',
322
+
link: './configuration',
323
+
id: './configuration',
324
+
},
359
325
{
360
326
title: 'Production Best Practices',
361
327
description: 'Learn the best practices of running OpenFGA in a production environment',
0 commit comments