mirror of https://github.com/nikdoof/pocket-id.git synced 2025-12-14 07:12:19 +00:00

Files

Kyle Mendell 5afd651434 docs: add helper scripts install for proxmox (#197 )

Co-authored-by: Elias Schneider <login@eliasschneider.com>

2025-02-02 18:59:04 +01:00

2.5 KiB

Raw Blame History

id
installation

Installation

Before you start

Pocket ID requires a secure context, meaning it must be served over HTTPS. This is necessary because Pocket ID uses the WebAuthn API.

Installation with Docker (recommended)

Download the docker-compose.yml and .env file:

 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

Edit the .env file so that it fits your needs. See the environment variables section for more information.
Run docker compose up -d

You can now sign in with the admin account on http://localhost/login/setup.

Proxmox

Run the helper script as root in your Proxmox shell.

Configuration Paths

/opt/pocket-id/backend/.env
/opt/pocket-id/frontend/.env

bash -c "$(wget -qLO - https://github.com/community-scripts/ProxmoxVE/raw/main/ct/pocketid.sh)"

Unraid

Pocket ID is available as a template on the Community Apps store.

Stand-alone Installation

Required tools:

Node.js >= 22
Go >= 1.23
Git
PM2
Caddy (optional)

Copy the .env.example file in the frontend and backend folder to .env and change it so that it fits your needs.
```
cp frontend/.env.example frontend/.env
cp backend/.env.example backend/.env
```

Run the following commands:

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 reverse-proxy/Caddyfile