Skip to content

Commit

Permalink
chore: readme and example
Browse files Browse the repository at this point in the history
  • Loading branch information
dirathea committed Oct 16, 2024
1 parent 9d28c2c commit fa2fd86
Show file tree
Hide file tree
Showing 4 changed files with 19 additions and 7 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

Pasolo is an authentication server for single users with passkeys. Pasolo runs alongside with other reverse proxy system such as Caddy, Traefik, Nginx, using `forward_auth` or `external_auth` functionality.

<div style="position: relative; padding-bottom: 64.86486486486486%; height: 0;"><iframe src="https://www.loom.com/embed/4da6df49c2af4eb6a1007b87c7e4ed9b?sid=ec0ddc44-4f87-4a41-95e1-8e0ce9c6a071" frameborder="0" webkitallowfullscreen mozallowfullscreen allowfullscreen style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;"></iframe></div>

## Why?

Inspired by a post in [r/selfhosted](https://www.reddit.com/r/selfhosted/comments/1f7fith/passkeys/) and other similar project like [Vouch Proxy](https://github.com/vouch/vouch-proxy), [oauth2-proxy](https://oauth2-proxy.github.io/oauth2-proxy/) and [Ory oathkeeper](https://www.ory.sh/docs/oathkeeper), Pasolo developed for self-hosted / home lab use cases, where the user is very limited -- in this case 1 person -- but want some degree of authentication on their setup.
Expand Down
8 changes: 6 additions & 2 deletions examples/caddy/Caddyfile
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
{
auto_https ignore_loaded_certs
}

# Serve your app
proxy.caddy.orb.local {
app.caddy.orb.local {
forward_auth / auth.caddy.orb.local {
uri /validate
copy_headers Remote-User Remote-Groups Remote-Name Remote-Email
Expand All @@ -10,5 +14,5 @@ proxy.caddy.orb.local {
}
}

reverse_proxy target:3000
reverse_proxy target:8080
}
3 changes: 3 additions & 0 deletions examples/caddy/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Pasolo with Caddy example

This is an example how to use pasolo with caddy. I am using [orbstack](https://orbstack.dev/) to simplify many things, including custom domain `orb.local` and HTTPS
13 changes: 8 additions & 5 deletions examples/caddy/docker-compose.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ services:
build:
context: ../../.
dockerfile: Dockerfile
image: pasolo:latest
image: ghcr.io/dirathea/pasolo:v0.2.0
env_file:
- .env
environment:
Expand All @@ -13,17 +13,20 @@ services:
volumes:
- secret:/secret

proxy:
app:
depends_on:
- auth
- target
image: caddy:2
ports:
- 80
- 443
volumes:
- ./Caddyfile:/etc/caddy/Caddyfile

target:
image: zefhemel/silverbullet
image: jmalloc/echo-server
expose:
- 3000
- 8080

volumes:
secret:

0 comments on commit fa2fd86

Please sign in to comment.