Self-host 2FAuth on a VPS

A web app to manage your two-factor authentication accounts and generate one-time codes.

levelrail-cli templates deploy 2fauth --name my-2fauth

Specification

Status
Verified on arm64 with image tag 8.0.2
Category
Security
Services
2fauth
Ports
8000
Volumes
1
Memory
about 128 MiB
arm64
tested
amd64
image published
Settings to fill in
none

About 2FAuth

A web app to manage your two-factor authentication accounts and generate one-time codes. Runs as a single container from the 2fauth image, listening on port 8000 and keeps its data in named volumes.

What it deploys

2FAuth runs as one service in a single Compose app, listening on port 8000, with 1 named volume mount.

ServiceImageTagPortsVolumes
2fauth 2fauth/2fauth 8.0.2 8000 twofauth_data -> /2fauth

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Verified. Verified on arm64 with image tag 8.0.2. Verified means our CI ran this exact image version and it answered on its health path. Evidence
  • Host ports. It publishes port 8000 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
2fauthAPP_KEYGenerated at deploy
2fauthAPP_URLPreset by the template
2fauthDB_CONNECTIONPreset by the template
2fauthSITE_OWNERPreset by the template

Install 2FAuth on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get 2fauth
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

    levelrail-cli templates deploy 2fauth --name my-2fauth

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then 2FAuth.

More in Security

All Security templates