Skip to content

Use sudo explicitly for caddy commands. #86

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.

Sign up for GitHub

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
rowan-m wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Use sudo explicitly for caddy commands. #86

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c6af47f
Use sudo explicitly for caddy commands.
rowan-m Mar 11, 2026
f43fc99
Update caddy instructions and clean up README
rowan-m Apr 1, 2026
a33b8dc
Document optional Chrome flags
rowan-m Apr 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 18 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ limitations under the License.

# Project Sesame

Project Sesame is an open-source demo web application built with node.js,
Project Sesame is an open-source demo web application built with Node.js,
designed to provide a hands-on environment for web developers to explore,
experiment and learn a wide range of identity and authentication features and
patterns.
Expand All @@ -35,23 +35,36 @@ patterns.
npm ci
```

### Bulid
### Build

```shell
npm run build
```

### Run

This command will run emulator, RP and IdP projects, and Caddy proxy:
This command will run the emulator, RP and IdP projects, and Caddy proxy:

```shell
sudo npm run dev:local
npm run dev:local
```

Caddy should proxy from [https://rp.localhost](https://rp.localhost) to `localhost:8080` and [https://idp.localhost](https://idp.localhost) to `localhost:8000`,
Caddy should proxy from https://rp.localhost to `localhost:8080` and https://idp.localhost to `localhost:8000`,
or other ports that you specify in the `rp-localhost.config.json` and `idp-localhost.config.json` config files.

> [!NOTE]
> `sudo` is required to run the Caddy scripts. You may need to enter your password during the command.

### Useful Chrome flags (optional)

For local testing, you can configure Chrome to ignore warnings and errors related to certificates.

* Launch Chrome with the `--ignore-certificate-errors` command line flag
* Enable `chrome://flags/#unsafely-treat-insecure-origin-as-secure` and set its contents to:
```text
https://localhost,wss://localhost:3000,https://rp.localhost,wss://rp.localhost,wss://rp.localhost:3000,https://idp.localhost
```

## Adding a new sign-in flow

You can use this code base to try and experiment with new ideas. To add a new
Expand Down
4 changes: 2 additions & 2 deletions caddy.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ LOG_FILE="caddy.log"

# --- Startup and Cleanup ---
echo "Attempting to stop any running Caddy instances..."
npx caddy stop > /dev/null 2>&1 || sudo killall caddy > /dev/null 2>&1 || true
sudo ./node_modules/.bin/caddy stop > /dev/null 2>&1 || sudo killall caddy > /dev/null 2>&1 || true

# --- Get Ports ---
RP_PORT=$(node -p "require('./rp-localhost.config.json').port" | sed 's/\x1b\[[0-9;]*m//g')
Expand All @@ -34,7 +34,7 @@ echo "To monitor logs, run: tail -f ${LOG_FILE}"
# Run Caddy, redirecting all output, and provide a custom failure message.
# The parentheses group the command and its redirections.
(
RP_PORT=${RP_PORT} IDP_PORT=${IDP_PORT} npx caddy run --config Caddyfile > "${LOG_FILE}" 2>&1
sudo -E env RP_PORT=${RP_PORT} IDP_PORT=${IDP_PORT} ./node_modules/.bin/caddy run --config Caddyfile > "${LOG_FILE}" 2>&1
) || {
# This code runs ONLY if the Caddy process exits with a non-zero status (an error).
echo "Caddy process failed. See ${LOG_FILE} for details." >&2
Expand Down