Repository navigation
Passky Server 9.0.0
Passky Server has been rewritten in TypeScript and now runs on Bun. The API is unchanged, so existing Passky clients keep working without an update.
Upgrading
Back up your database first, then run the usual commands:
docker compose pull
docker compose down
docker compose up -d
Your existing .env and docker-compose.yml keep working. If your compose file still mounts the database at /var/www/html/databases, Passky finds it there and keeps using it.
All users will need to sign in again once after the upgrade.
Read the upgrade guide before upgrading. To stay on the PHP version for now, use the image rabbitcompany/passky-server:8.1.8.
Highlights
- One lightweight Bun process replaces Nginx, PHP-FPM, cron, and the bundled Redis.
- PostgreSQL is now supported alongside SQLite, MySQL, and MariaDB.
- Account passwords are now hashed with Argon2id. Existing bcrypt hashes are upgraded automatically at each user's next sign-in.
- The administrator interface has been redesigned. It adds searchable, paginated accounts and licenses, a registration report, and health checks.
New features
DATABASE_URLsetting for SQLite, MySQL, MariaDB, and PostgreSQL connections.- BurrowGate support. Set
BURROWGATE_ORIGIN_SECRETto accept only requests signed by BurrowGate. - Optionally show Passky usernames in BurrowGate's traffic log with
BURROWGATE_REPORT_USERNAMES. Only usernames verified by a password, token, or administrator session are reported. TRUSTED_PROXIESsetting that controls which reverse proxies may report a client's IP address.- Redis is optional. Use
REDIS_URL, or the existingREDIS_*settings, to keep sign-ins across restarts. - OpenMetrics endpoint at
/metrics, with optional bearer token protection. - Optional log export to Grafana Loki.
- Health endpoint at
/health, used by the Docker health check. - Adjustable Argon2id cost with
ARGON2_MEMORY_COSTandARGON2_TIME_COST. Accounts are rehashed with new values at their next sign-in. MYSQL_CACHE_MODEcaches user and password counts, which reduces load on databases billed by rows read.
Security
- Deleting an account now signs it out on every device.
- The password is checked before two-factor authentication, so the API no longer reveals whether an account uses 2FA.
- YubiKey codes are validated more strictly, and the response from the validation server is fully verified.
- Administrator sign-in is limited to five attempts per IP address every fifteen minutes.
- Administrator actions require a CSRF token, and session cookies are
HttpOnly,SameSite=Strict, andSecureover HTTPS. - A license key can no longer be redeemed twice by simultaneous requests.
- Password edits and deletions are checked against the owner directly in the database.
- Forwarded client IP headers are only accepted from trusted proxies.
- Request sizes are limited, and metrics cannot be inflated by random URLs.
Behavior changes
getReportis disabled by default and returns error32. SetREPORTS_ENABLED=trueto make it public again. Administrators always see the report in the administrator interface.getStatsis disabled by default and returns error33. SetSTATS_ENABLED=trueto make it public again. Administrators always see CPU, memory, and disk usage in the administrator interface.- A wrong password returns error
2, even when two-factor authentication is enabled. getInfonow reportshashingAlgorithmandhashingMemoryCost.hashingCostnow holds the Argon2id time cost.- Daily maintenance runs inside the server. The
/cron.phpendpoint has been removed and external cron jobs are no longer needed. REDIS_LOCAL_HOST,REDIS_LOCAL_PORT, andREDIS_LOCAL_PASSWORDare no longer used.
Removed
- The PHP implementation.
- Shared hosting installation. Passky Server now needs a process that keeps running, such as Docker or a VPS.
License
Passky Server is now licensed under the European Union Public Licence v. 1.2. Releases up to and including 8.1.8 remain available under GPL-3.0.