nikdoof/pocket-id
1
0
Fork 0
mirror of https://github.com/nikdoof/pocket-id.git synced 2025-12-14 15:22:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add note that https is required

Browse Source
This commit is contained in:
Elias Schneider
2024-08-17 00:51:29 +02:00
parent b49063d692
commit 74f4c22800
1 changed files with 29 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -4,13 +4,19 @@ Pocket ID is a simple OIDC provider that allows users to authenticate with their
<img src="https://github.com/user-attachments/assets/953c534c-b667-44e5-b976-a59142f1efb8" width="1200"/> <img src="https://github.com/user-attachments/assets/953c534c-b667-44e5-b976-a59142f1efb8" width="1200"/>
The goal of Pocket ID is to be a simple and easy-to-use. There are other self-hosted OIDC providers like [Keycloak](https://www.keycloak.org/) or [ORY Hydra](https://www.ory.sh/hydra/) but they are often too complex for simple use cases. Additionally, Pocket ID only support passkey authentication which is a passwordless authentication method. The goal of Pocket ID is to be a simple and easy-to-use. There are other self-hosted OIDC providers like [Keycloak](https://www.keycloak.org/) or [ORY Hydra](https://www.ory.sh/hydra/) but they are often too complex for simple use cases.
Additionally, what makes Pocket ID special is that it only supports [passkey](https://www.passkeys.io/) authentication, which means you don’t need a password. Some people might not like this idea at first, but I believe passkeys are the future, and once you try them, you’ll love them. For example, you can now use a physical Yubikey to sign in to all your self-hosted services easily and securely.
## Setup ## Setup
> [!WARNING] > [!WARNING]
> Pocket ID is in its early stages and may contain bugs. > Pocket ID is in its early stages and may contain bugs.
### Before you start
Pocket ID requires a [secure context](https://developer.mozilla.org/en-US/docs/Web/Security/Secure_Contexts), meaning it must be served over HTTPS. This is necessary because Pocket ID uses the [WebAuthn API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Authentication_API) which requires a secure context.
### Installation with Docker (recommended) ### Installation with Docker (recommended)
1. Download the `docker-compose.yml` and `.env` file: 1. Download the `docker-compose.yml` and `.env` file:
@@ -27,6 +33,7 @@ The goal of Pocket ID is to be a simple and easy-to-use. There are other self-ho
You can now sign in with the admin account on `http://localhost/login/setup`. You can now sign in with the admin account on `http://localhost/login/setup`.
### Unraid ### Unraid
Pocket ID is available as a template on the Community Apps store. Pocket ID is available as a template on the Community Apps store.
### Stand-alone Installation ### Stand-alone Installation
@@ -45,6 +52,7 @@ Required tools:
cp frontend/.env.example frontend/.env cp frontend/.env.example frontend/.env
cp backend/.env.example backend/.env cp backend/.env.example backend/.env
``` ```
2. Run the following commands: 2. Run the following commands:
```bash ```bash