-
Notifications
You must be signed in to change notification settings - Fork 8
docs: How to run local auth stack #1384
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
Open
dan-fernandes
wants to merge
9
commits into
main
Choose a base branch
from
add-docs-for-self-hosting-auth
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
d6445a4
Add docs/tutorials/local-auth.md
dan-fernandes 5ec0588
Merge branch 'main' into add-docs-for-self-hosting-auth
dan-fernandes f52f096
Merge branch 'main' into add-docs-for-self-hosting-auth
dan-fernandes 5206567
Use route to compose file in compose up
dan-fernandes 081dad3
Add running env file to launching stack
dan-fernandes 7c77375
Typo
dan-fernandes 2919a54
Remove config param frm login
dan-fernandes 19c362e
Merge branch 'main' into add-docs-for-self-hosting-auth
dan-fernandes 6c9687a
Add note on addresses of blueapi and tiled
dan-fernandes File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| # Run Auth Locally | ||
|
|
||
| BlueAPI can be secured using OIDC authenticaiton. For development it can be useful to run a containerised version of the OIDC stack, to serve a local instance of BlueAPI. | ||
|
|
||
| To run the stack: | ||
|
|
||
| 1. In the root directory run `git submodule update --init --recursive` to initialise the example-services repo | ||
| 2. Run `docker compose -f tests/system_tests/compose.yaml up -d` to launch an instance of NumTracker, RabbitMQ, Keycloak, Tiled, OPA and a number of IOCs, in detached mode | ||
| 3. Run `source tests/system_tests/.env` which will set required EPICS environmental variables | ||
| 4. Run `blueapi -c tests/system_tests/config.yaml serve` to launch BlueAPI configured to use the launched stack. This may take a while, as BlueAPI will attempt to connect to a number of devices via Channel Access | ||
|
|
||
| To log in through the BlueAPI CLI: | ||
|
|
||
| 1. Run `blueapi login` (if you want to run a plan with stomp config, add the `-c tests/system_tests/config.yaml` parameter) | ||
| 2. Follow the login prompted to Keycloak, then log in with the username `admin` and password `admin` | ||
| 3. When promped by Keycloak, grant BlueAPI access to the listed privileges | ||
| 4. Run `blueapi controller plans` to check that the log in has succeeded | ||
|
|
||
| By default the BlueAPI instance will be available via the OAuth2 proxy at `localhost:4180`, and Tiled through its OAuth2 proxy at `localhost:4181`. | ||
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.
Uh oh!
There was an error while loading. Please reload this page.