From 2a984eeaf1ee169f9f4987acde0e79660d2b6781 Mon Sep 17 00:00:00 2001 From: Elias Schneider Date: Mon, 13 Jan 2025 15:13:56 +0100 Subject: [PATCH] docs: add account recovery to README --- README.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) diff --git a/README.md b/README.md index fd4f7fe..6eed3d0 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,24 @@ The goal of Pocket ID is to be a simple and easy-to-use. There are other self-ho 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. +## Table of Contents + +- [ Pocket ID](#-pocket-id) + - [Table of Contents](#table-of-contents) + - [Setup](#setup) + - [Before you start](#before-you-start) + - [Installation with Docker (recommended)](#installation-with-docker-recommended) + - [Unraid](#unraid) + - [Stand-alone Installation](#stand-alone-installation) + - [Nginx Reverse Proxy](#nginx-reverse-proxy) + - [Proxy Services with Pocket ID](#proxy-services-with-pocket-id) + - [Update](#update) + - [Docker](#docker) + - [Stand-alone](#stand-alone) + - [Environment variables](#environment-variables) + - [Account recovery](#account-recovery) + - [Contribute](#contribute) + ## Setup > [!WARNING] @@ -157,6 +175,16 @@ docker compose up -d | `PORT` | `3000` | no | The port on which the frontend should listen. | | `BACKEND_PORT` | `8080` | no | The port on which the backend should listen. | +## Account recovery + +There are two ways to create a one-time access link for a user: + +1. **UI**: An admin can create a one-time access link for the user in the admin panel under the "Users" tab by clicking on the three dots next to the user's name and selecting "One-time link". +2. **Terminal**: You can create a one-time access link for a user by running the `scripts/create-one-time-access-token.sh` script. To execute this script with Docker you have to run the following command: + ```bash + docker compose exec pocket-id sh "sh scripts/create-one-time-access-token.sh " + ``` + ## Contribute You're very welcome to contribute to Pocket ID! Please follow the [contribution guide](/CONTRIBUTING.md) to get started.