Update README.md with local run example #1119
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
README.md
Outdated
| To run the app locally, configure the `.env` file with the correct values, and configure the extra setting `AUTH_ENABLED=false` for testing without the Application Authentication enabled. You can then run from VS Code by using <kbd>F5</kbd>. | ||
|
|
||
| If you get an error message: `Unauthorized. Access token is missing, invalid, audience is incorrect`, then run `az login` before running the App. If you still get an error after that, make sure your account has access to the Azure OpenAi instance. You can list the roll assignments and create it through: | ||
| `az role assignment create --assignee <your-user-id> --role "Cognitive Services Contributor" --scope /subscriptions/<your-subscription-id>/resourceGroups/<your-resource-group>/providers/Microsoft.CognitiveServices/accounts/<your-cognitive-services-account>` |
There was a problem hiding this comment.
I think Cognitive Services OpenAI User would be the recommended data plane role here
There was a problem hiding this comment.
I can see that. Updated the branch.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Motivation and Context
The README does not contain information on testing this app locally (e.g. in a Codespace). Running it takes a lot of trial and error figuring out what to configure. I had to find #649 before I could figure the
AUTH_ENABLEDsetting and from there could debug more.The lessons learned are in this PR.
Contribution Checklist