---
title: "Installation"
manual: "Passkeys Backend Authentication"
version: "1.0"
permalink: "https://docs.typo3.org/permalink/netresearch/nr-passkeys-be:installation@1.0"
source: "Installation/Index.rst"
rendered: "2026-09-20T16:07:13+00:00"
---

# Installation {#installation}

## Prerequisites {#prerequisites}

-   TYPO3 12.4 LTS, TYPO3 13.4 LTS, or TYPO3 14.x
-   PHP 8.2, 8.3, 8.4, or 8.5
-   HTTPS is **required** for WebAuthn (except for `localhost` during
    development)
-   A configured TYPO3 encryption key
    (`$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey']`,
    minimum 32 characters)

## Installation via Composer {#installation-via-composer}

This is the recommended way to install the extension:

**Install via Composer**

```bash
composer require netresearch/nr-passkeys-be
```

## Activate the extension {#activate-the-extension}

After installation, activate the extension in the TYPO3 backend:

1.  Go to **Admin Tools > Extensions**
1.  Search for "Passkeys Backend Authentication"
1.  Click the activate button

Or use the CLI:

**Activate via CLI**

```bash
vendor/bin/typo3 extension:activate nr_passkeys_be
```

## Database schema update {#database-schema-update}

The extension adds a `tx_nrpasskeysbe_credential` table. After
activation, run the database schema update:

1.  Go to **Admin Tools > Maintenance > Analyze Database
    Structure**
1.  Apply the suggested changes

Or use the CLI:

**Update database schema via CLI**

```bash
vendor/bin/typo3 database:updateschema
```

## Verify the installation {#verify-the-installation}

After activation:

1.  The TYPO3 backend login page should show a
    **Sign in with a passkey** button below the Login button.

    ![TYPO3 login form with the passkey button visible](../Images/Login/LoginPageWithPasskey.png)
1.  In **User Settings**, a "Passkeys" section should appear
    where authenticated users can register their first passkey.

> [!NOTE]
> HTTPS is mandatory for WebAuthn to function. The only exception is
> `localhost` for local development. If you are running TYPO3
> behind a reverse proxy, ensure that the `TYPO3_SSL` environment
> variable or the `[SYS][reverseProxySSL]` configuration is set
> correctly.