This section shows how to install and run Permify Service using brew.

​
Install Permify

Open terminal and run the following line,

brew install permify/tap/permify

​
Run Permify Service

To run the Permify Service, permify serve command should be run.

By default, the service is configured to listen on ports 3476 (HTTP) and 3478 (gRPC) and store the authorization data in memory rather then an actual database. You can override these by running the command with configuration flags.

​
Configure By Using Flags

See all the configuration flags by running,

permify serve --help

In addition to CLI flags, Permify also supports configuration via environment variables. You can replace any flag with an environment variable by converting dashes into underscores and prefixing with PERMIFY_ (e.g. —log-level becomes PERMIFY_LOG_LEVEL).

​
Configure With Using Config File

You can also configure Permify Service by using a configuration file.

 permify serve -c=config.yaml

or

 permify serve --config=config.yaml

​
Test your connection

You can test your connection by making an HTTP GET request,

localhost:3476/healthz

You can use our Postman Collection to work with the API. Also see the Using the API section for details of core functions.

​
Need any help ?

Our team is happy to help you get started with Permify, schedule a call with a Permify engineer.

Deploy on AWS ECS, ECR & EC2Run using Docker