---
title: "Overview | DRAWBRIDGE docs"
description: "An overview of Drawbridge, the sign-in gateway for the apps on Citadel and the one way in that comes down only for people who signed in."
url: https://drawbridge.apps.wayne.edu/docs/
llms: https://drawbridge.apps.wayne.edu/llms.txt
generator: Squire agent-ready
---

# Overview [#](https://drawbridge.apps.wayne.edu/docs/#overview)

This page summarizes what Drawbridge is, where it fits in the stack, and which page to go to next.

![Drawbridge's front page: the headline Drawbridge in stencil capitals, 'Comes down for signed-in people.', and an architect's section A-A through a gatehouse with the Drawbridge mark in a detail callout.](https://drawbridge.apps.wayne.edu/docs/readme/hero.jpg)

## What it is [#](https://drawbridge.apps.wayne.edu/docs/#what-it-is)

Drawbridge is the sign-in gateway for the apps on Citadel, Wayne State's container platform. It is Apache with mod_auth_openidc, set up as one OpenID Connect client for Microsoft Entra ID. It is not live yet: its home will be `auth.apps.wayne.edu`, in front of every app on the platform, once the Citadel routing for it exists. The latest release, 0.6.2, is tagged; it builds the gateway image for amd64, the architecture Citadel runs, and the image will run as a service on Citadel. As a reverse proxy it checks that the visitor has a session, drops any identity header the visitor sent, and passes the app a short-lived signed assertion that SESAME's `gateway` driver verifies. Which paths need a login, and which need an Entra authentication context on top, is declared per app in a config file. Nothing else decides it.

Why a moat and not a lock on every door: each app doing its own OpenID Connect is another chance to get a nonce, a state check or a token signature wrong. We'd rather get that right once, in a maintained module (mod_auth_openidc). Each app then checks one small signed token.

At a glance, from the badges:

- PHP ^8.3
- MIT license
- ES256 assertion, 60 seconds

Version 0.6.2. Status: built and tested, not live yet; the gateway image will run as a service on Citadel.

## Where it fits in the stack [#](https://drawbridge.apps.wayne.edu/docs/#where-it-fits-in-the-stack)

Drawbridge is one part of the Wayne State application stack: one contract, several paths that agree, accessibility as a gate, and decisions written down. WELD is the Laravel starter app with the rest of it already set up.

| Part | Job |
| --- | --- |
| WayneUI | the interface layer (project 0 of the stack) |
| CREED | the shared rules and policy format |
| PROCTOR | checks an app against the version policy |
| SESAME | sign-in inside the app; its `gateway` driver verifies what Drawbridge signs |
| HELMET | security headers and CSP reporting |
| Sourdough | the starter that keeps the stack fed |
| Squire | the Citadel deploy kit; the layer that serves this repo's front page is one |
| Parity | Citadel on your computer: its PHP image, its proxy and MySQL 5.6, so an app that works here works on Citadel |
| Preflight | the shared CI components |
| Pinstripe | the coding standard presets (Pint, PHPStan, ESLint, Rector) |
| Booster | upgrades an app's PHP, Laravel and front end, one hop at a time |
| Rollcall | the fleet census: which apps run what, and how close each is to end of life |
| **Drawbridge** | **the one OpenID Connect front door for the Citadel** |
| ADVISOR | the read-only MCP server that answers a coding agent's stack questions |
| WELD | the Laravel starter app with the rest of the stack already set up |

## Install and run [#](https://drawbridge.apps.wayne.edu/docs/#install-and-run)

Five lines, Linux and macOS spelling; [Install](https://drawbridge.apps.wayne.edu/docs/install.html) has the Windows (PowerShell) variants and the published image route:

```sh
git clone https://git.wayne.edu/enterprise-apps/drawbridge.git && cd drawbridge
docker run --rm -v "$PWD:/app" -w /app composer:2.11.1@sha256:8de2184c6de224f4689e8f80ed5f5edaf0030b6b8b7839a22a2bcb6722ac87d0 composer install --no-interaction
cp .env.example .env && cp config/drawbridge.example.yaml config/drawbridge.yaml
docker build -f docker/gateway/Dockerfile -t drawbridge-gateway .
docker run --rm -p 8080:8080 --env-file .env -v "$PWD/config/drawbridge.yaml:/etc/drawbridge/drawbridge.yaml:ro" -v "$PWD/secrets:/run/drawbridge:ro" drawbridge-gateway
```

## Pick your path [#](https://drawbridge.apps.wayne.edu/docs/#pick-your-path)

- [Quick start](https://drawbridge.apps.wayne.edu/docs/guides/quick-start.html): copy the example config and environment file, validate them, build the image and run the rig.
- [Install](https://drawbridge.apps.wayne.edu/docs/install.html): requirements, the full install for each OS, and getting the published image.
- [Configuration](https://drawbridge.apps.wayne.edu/docs/reference/configuration.html): the per-app config file, the `oidc` block and the path rules.
- [Commands](https://drawbridge.apps.wayne.edu/docs/reference/commands.html): every `drawbridge` command and what it does.
- [First deployment](https://drawbridge.apps.wayne.edu/docs/deploying/first-deployment.html): the trial kit in `trial/` on a pre-production host, a throwaway app behind the gateway, then `drawbridge smoke`, the logs, a rollback and the teardown.

An agent-ready file for this site: [llms.txt](https://drawbridge.apps.wayne.edu/llms.txt).

## Related [#](https://drawbridge.apps.wayne.edu/docs/#related)

- [Install](https://drawbridge.apps.wayne.edu/docs/install.html)
- [Quick start](https://drawbridge.apps.wayne.edu/docs/guides/quick-start.html)
- [How it works](https://drawbridge.apps.wayne.edu/docs/guides/how-it-works.html)
- [Getting the image](https://drawbridge.apps.wayne.edu/docs/deploying/getting-the-image.html)
- [First deployment](https://drawbridge.apps.wayne.edu/docs/deploying/first-deployment.html)
- [Changelog](https://drawbridge.apps.wayne.edu/docs/changelog.html)
