# Self-hosted server

You can deploy 2FAuth on your own web server, whether on your local computer or a web host. The following guide describes how to proceed and gives basic configurations for both NGINX and Apache2 web servers.

# Requirements

# HTTP server

Apache and NGINX are the most popular web servers. If you rent a server or web hosting, you probably already have one of them installed. If you plan to use your own machine and need help installing and configuring a web server, please consider searching the Web, as there are many tutorials to guide you through.


  • PHP >= 8.0
  • BCMath PHP Extension
  • Ctype PHP Extension
  • Fileinfo PHP Extension
  • JSON PHP Extension
  • Mbstring PHP Extension
  • OpenSSL PHP Extension
  • PDO PHP Extension
  • Tokenizer PHP Extension
  • XML PHP Extension

Depending on the chosen database (see below), don't forget to install the corresponding PHP extension (i.e php8.0-sqlite3 or php8.0-mysql)

# Database

You need a database to run 2FAuth. Supported databases are the ones supported by Laravel.

  • MariaDB 10.2+
  • MySQL 5.7+
  • PostgreSQL 9.6+
  • SQLite 3.8.8+
  • SQL Server 2017+

# Composer

You need Composer to install all PHP dependencies of 2FAuth. As the installation process of Composer may change depending on your operating system, please follow the instructions provided on the official website:

Install Composer

You can test your installation by running php composer.phar -v in a terminal (or just composer -v if composer has been installed in a directory that is part of your system PATH)

# Server configuration

Set your NGINX configuration in /etc/nginx/nginx.conf as :

events {}
http {
  include mime.types;

  access_log /dev/stdout;
  error_log /dev/stderr;

  server {
      listen 80;
      server_name 2fAuth;
      root /var/www/2fauth/public;

      index index.php;

      charset utf-8;

      location / {
          try_files $uri $uri/ /index.php?$query_string;

      location = /favicon.ico { access_log off; log_not_found off; }
      location = /robots.txt  { access_log off; log_not_found off; }

      error_page 404 /index.php;

      location ~ \.php$ {
          fastcgi_pass unix:/var/run/php/php8.0-fpm.sock;
          fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
          include fastcgi_params;

      location ~ /\.(?!well-known).* {
          deny all;

You can verify the Nginx configuration is valid with:

nginx -t

Add a new virtual host:

cd /etc/apache2/sites-available
sudo nano 2fauth.conf

Add the following to the newly created file:

<VirtualHost *:80>
    ServerName example.com
    ServerAdmin webmaster@example.com
    DocumentRoot /var/www/2fauth/public

    <Directory /var/www/2fauth/public>
        Options Indexes MultiViews
        AllowOverride None
        Require all granted

    ErrorLog ${APACHE_LOG_DIR}/error.log
    CustomLog ${APACHE_LOG_DIR}/access.log combined

Save and close the file, then enable the new VHost and restart Apache2:

# Assuming 000-default.conf is your current enabled v-host
# Disable the current v-host
sudo a2dissite 000-default.conf

# Enable the 2fauth v-host
sudo a2ensite 2fauth

# Restart apache2
sudo systemctl restart apache2

# Set up 2FAuth

# Get the source code

As a reminder, the installation path for this guide is /var/www/2fauth. The given commands should be modified if you are using another path.

mkdir -p /var/www/2fauth
curl https://api.github.com/repos/Bubka/2FAuth/tags | grep "tarball_url" | \
    grep -Eo 'https://[^\"]*' | sed -n '1p' | xargs wget -O - | tar -xz --strip-components=1 -C /var/www/2fauth
mkdir -p /var/www/2fauth
# list existing 2FAuth versions
curl https://api.github.com/repos/Bubka/2FAuth/releases | grep "\"name\"" | grep -Eo 'v[^\"]*'
# Replace 3.0.0 with the version of your choice
wget -qO- "https://github.com/Bubka/2FAuth/archive/refs/tags/${VERSION}.tar.gz" | \
    tar -xz --strip-components=1 -C /var/www/2fauth
git clone https://github.com/bubka/2fauth.git /var/www/2fauth
cd /var/www/2fauth
curl https://api.github.com/repos/Bubka/2FAuth/releases/latest | grep "\"name\"" | grep -Eo 'v[^\"]*' | xargs git checkout
git clone https://github.com/bubka/2fauth.git /var/www/2fauth
cd /var/www/2fauth
# list existing 2FAuth versions
git tag
# Replace 3.0.0 with the version of your choice
git checkout v3.0.0
  1. Download the source code of the latest 2FAuth release
  2. Extract the archive to a temp folder
  3. Open the top folder named temp/2fauth-x.y.z
  4. Move its content to /var/www/2fauth

# Install composer dependencies

From the /var/www/2fauth/ directory:

composer install --prefer-dist --no-scripts --no-dev

Or if you didn't add composer to your system PATH:

php composer.phar install --prefer-dist --no-scripts --no-dev

# Create the database

Use the CLI of the chosen database to create a new database with one of the following commands:

sqlite> .open /var/www/2fauth/database/database.sqlite
sqlite> .quit


Command Line Shell For SQLite

mysql> CREATE DATABASE 2fauth;


Creating database with MySQL
Creating database with MariaDB



Creating database with MariaDB

If you are not comfortable with the command line, you may use a db management tool like Adminer to ease this step.

Get Adminer

# Set the .env file

Run the following command from the /var/www/2fauth directory to create a fresh .env file from the .env.example template:

mv .env.example .env

Open the .env file with a text editor, you will find all environment variables that could be customized.
You won't have to set/change all, most of them have a default value that will probably fit your needs. But the database and email parts have to be reviewed.

# Database

Set the path to your SQLite database file:


Uncomment the dedicated lines (and comment the SQLite ones) and replace values with yours:


Uncomment the dedicated lines (and comment the SQLite ones) and replace values with yours:


# Email

Email configuration depends on your email provider. You should refer to its documentation to find the relevant values.
As an example, here is the configuration for an OVH hosting:


# Run Artisan commands

Run the following Artisan commands from the /var/www/2fauth/ directory to set up the Laravel part:

php artisan migrate:refresh
php artisan passport:install
php artisan storage:link
php artisan config:cache

# Set ownership and permissions

From the /var/www/ directory :

sudo chown -R www-data:www-data 2fauth
sudo chmod -R 775 2fauth