Skip to content

docs: How to run local auth stack#1384

Open
dan-fernandes wants to merge 2 commits intomainfrom
add-docs-for-self-hosting-auth
Open

docs: How to run local auth stack#1384
dan-fernandes wants to merge 2 commits intomainfrom
add-docs-for-self-hosting-auth

Conversation

@dan-fernandes
Copy link
Contributor

Add tutorial on running local auth stack for debugging / developing auth stuff

@dan-fernandes dan-fernandes requested a review from a team as a code owner February 12, 2026 13:50
@codecov
Copy link

codecov bot commented Feb 12, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.03%. Comparing base (23e780d) to head (5ec0588).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1384   +/-   ##
=======================================
  Coverage   95.03%   95.03%           
=======================================
  Files          43       43           
  Lines        2780     2780           
=======================================
  Hits         2642     2642           
  Misses        138      138           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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 up -d` to launch an instance of NumTracker, RabbitMQ, Keycloak, Tiled, OPA and a number of IOCs, in detached mode
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this work from the root of the repo? I think you either need to run from the system_tests directory or pass the file directly.

docker compose -f tests/system_tests/compose.yaml up -d


1. In the root directory run `git submodule update --init --recursive` to initialise the example-services repo
2. Run `docker compose up -d` to launch an instance of NumTracker, RabbitMQ, Keycloak, Tiled, OPA and a number of IOCs, in detached mode
3. 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you run source tests/system_tests/.env first, the devices will connect and it'll be a fair bit quicker.


1. Run `blueapi -c tests/system_tests/config.yaml login`
2. Follow the login prompt to Keycloak, then log in with the username `admin` and password `admin`
3. When promped by Keycloak, grant BlueAPI access to the listed privileges
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
3. When promped by Keycloak, grant BlueAPI access to the listed privileges
3. When prompted by Keycloak, grant BlueAPI access to the listed privileges


To log in through the BlueAPI CLI:

1. Run `blueapi -c tests/system_tests/config.yaml login`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think login requires the config file as the server is on the default host and port but worth adding a comment that it's needed if you want to run a plan with stomp config.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants