initial commit

2025-12-11 07:42:58 +03:00 · 2024-08-12 11:00:25 +02:00
commit eaff977b22
241 changed files with 14378 additions and 0 deletions
--- a/README.md
+++ b/README.md
@@ -0,0 +1,139 @@
+# <div align="center"><img  src="https://github.com/user-attachments/assets/03307a88-c35a-4bd9-bf93-e4287c2cdaad" width="100"/> </br>Pocket ID</div>
+
+Pocket ID is a simple OIDC provider that allows users to authenticate with their passkeys to your services.
+
+<img src="https://github.com/user-attachments/assets/e0bdc1e3-854c-479c-8c3d-6c1aa4f712f4" 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.
+
+## Setup
+
+> [!WARNING]  
+> Pocket ID is in its early stages and may contain bugs.
+
+### Installation with Docker (recommended)
+
+1. Download the `docker-compose.yml` and `.env` file:
+
+   ```bash
+    curl -O https://raw.githubusercontent.com/stonith404/pocket-id/main/docker-compose.yml
+
+    curl -o .env https://raw.githubusercontent.com/stonith404/pocket-id/main/.env.example
+   ```
+
+2. Edit the `.env` file so that it fits your needs. See the [environment variables](#environment-variables) section for more information.
+3. Run `docker compose up -d`
+
+You can now sign in with the admin account on `http://localhost/login/setup`.
+
+### Stand-alone Installation
+
+Required tools:
+
+- [Node.js](https://nodejs.org/en/download/) >= 20
+- [Go](https://golang.org/doc/install) >= 1.22
+- [Git](https://git-scm.com/downloads)
+- [PM2](https://pm2.keymetrics.io/)
+- [Caddy](https://caddyserver.com/docs/install) (optional)
+
+1. Copy the `.env.example` file in the `frontend` and `backend` folder to `.env` and change it so that it fits your needs.
+   
+   ```bash
+   cp frontend/.env.example frontend/.env
+   cp backend/.env.example backend/.env
+   ```
+2. Run the following commands:
+
+    ```bash
+    git clone https://github.com/stonith404/pocket-id
+    cd pocket-id
+
+    # Checkout the latest version
+    git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+
+    # Start the backend
+    cd backend/cmd
+    go build -o ../pocket-id-backend
+    cd ..
+    pm2 start pocket-id-backend --name pocket-id-backend
+
+    # Start the frontend
+    cd ../frontend
+    npm install
+    npm run build
+    pm2 start --name pocket-id-frontend --node-args="--env-file .env" build/index.js
+
+    # Optional: Start Caddy (You can use any other reverse proxy)
+    cd ..
+    pm2 start --name pocket-id-caddy caddy -- run --config Caddyfile
+    ```
+
+You can now sign in with the admin account on `http://localhost/login/setup`.
+
+### Add Pocket ID as an OIDC provider
+
+You can add a new OIDC client on `https://<your-domain>/settings/admin/oidc-clients`
+
+After you have added the client, you can obtain the client ID and client secret.
+
+You may need the following information:
+
+- **Authorization URL**: `https://<your-domain>/authorize`
+- **Token URL**: `https://<your-domain>/api/oidc/token`
+- **Certificate URL**: `https://<your-domain>/.well-known/jwks.json`
+- **OIDC Discovery URL**: `https://<your-domain>/.well-known/openid-configuration`
+- **PKCE**: `false` as this is not supported yet.
+
+### Update
+
+#### Docker
+
+```bash
+docker compose pull
+docker compose up -d
+```
+
+#### Stand-alone
+
+1. Stop the running services:
+   ```bash
+   pm2 delete pocket-id-backend pocket-id-frontend pocket-id-caddy
+   ```
+2. Run the following commands:
+
+   ```bash
+   cd pocket-id
+
+   # Checkout the latest version
+   git fetch --tags && git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+
+   # Start the backend
+   cd backend/cmd
+   go build -o ../pocket-id-backend
+   cd ..
+   pm2 start pocket-id-backend --name pocket-id-backend
+
+   # Start the frontend
+   cd ../frontend
+   npm install
+   npm run build
+   pm2 start build/index.js --name pocket-id-frontend
+
+   # Optional: Start Caddy (You can use any other reverse proxy)
+   cd ..
+   pm2 start caddy --name pocket-id-caddy -- run --config Caddyfile
+   ```
+
+### Environment variables
+
+| Variable         | Default Value       | Recommended to change | Description                                   |
+| ---------------- | ------------------- | --------------------- | --------------------------------------------- |
+| `PUBLIC_APP_URL` | `http://localhost`  | yes                   | The URL where you will access the app.        |
+| `DB_PATH`        | `data/pocket-id.db` | no                    | The path to the SQLite database.              |
+| `UPLOAD_PATH`    | `data/uploads`      | no                    | The path where the uploaded files are stored. |
+| `PORT`           | `3000`              | no                    | The port on which the frontend should listen. |
+| `BACKEND_PORT`   | `8080`              | no                    | The port on which the backend should listen.  |
+
+## Contribute
+
+You're very welcome to contribute to Pocket ID! Please follow the [contribution guide](/CONTRIBUTING.md) to get started.