Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix/clarify_docker_in_readme #2

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,15 +76,14 @@ Due to limitations using SQLAlchemy in asynchronous functions this app uses Open
If you are using an existing OpenFGA server instance or SaaS service you can skip this step. Using Docker locally is recommended as the simplest self-hosted option to get started with this project. Follow the instructions found in [this guide](https://openfga.dev/docs/getting-started/setup-openfga/docker) to run OpenFGA in Docker.

### Note
Because the OpenFGA Playground uses the same default port as Python-Flask you will need to modify the docker run command provided in the documentation
Because the OpenFGA Playground uses the same default port as Python-Flask you will need to modify the docker run command provided in the documentation. Instead of exposing the Playground on port 3000 we will instead use port 3001 to prevent a conflict.

Instead of:
`docker run -p 8080:8080 -p 8081:8081 -p 3000:3000 openfga/openfga run`

You will use:
`docker run -p 8080:8080 -p 8081:8081 -p 3001:3000 openfga/openfga run`

This will expose the playground service on port 3001 instead of 3000 to prevent a conflict.

## Set up your Store and Model
Before you can use this app you will need to create a store in your OpenFGA instance and create the model used by this app.
Expand Down