From 582830656568e6e66e8a051a7e64d4d5f3900f79 Mon Sep 17 00:00:00 2001 From: Ryan Quinn Date: Thu, 24 Oct 2024 14:02:14 -0500 Subject: [PATCH 1/2] fix/clarify_docker_in_readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c8bd9e6..8b4327d 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ 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. Instead of: `docker run -p 8080:8080 -p 8081:8081 -p 3000:3000 openfga/openfga run` From 10625d169b79fe756d918bb3a3b43116dd13ed18 Mon Sep 17 00:00:00 2001 From: Ryan Quinn Date: Thu, 24 Oct 2024 14:05:54 -0500 Subject: [PATCH 2/2] Update README.md --- README.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/README.md b/README.md index 8b4327d..fd6c194 100644 --- a/README.md +++ b/README.md @@ -76,7 +76,7 @@ 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. Instead of exposing the Playground on port 3000 we will instead use port 3001. +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` @@ -84,7 +84,6 @@ Instead of: 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.