Installation Guide

Check the System requirements first. The xBit installer is a command-line tool that downloads the xBit container images and starts xBit in Docker.


Before you start

  • TeelToken (installer key), from your Welcome Email.
  • TeelKey license file (License.teelkey), from the xBit Customer Portal or xBit Support.
  • The installer, xbit_installer-4.1.latest.zip. The same file covers Windows and Linux.
  • Docker:
System Install
Windows Docker Desktop
Linux Docker Engine and the Docker Compose plugin


Install on Windows

  1. Start Docker Desktop and wait until it is running.
  2. Create C:\teel_tech\installer, copy the zip there and extract it.
  3. Open PowerShell and allow scripts for this session. Answer Y when asked.

    Set-ExecutionPolicy -Scope Process -ExecutionPolicy Bypass
    
  4. Run the installer:

    cd C:\teel_tech\installer\xbit_installer-4.1.latest\xbit_installer\windows\
    .\installer.ps1
    
  5. At Enter your TeelToken, paste your TeelToken.

  6. At Enter language code, type en_US (English) or es_ES (Spanish), or press Enter for English.
  7. Wait for Installation Successful! and copy the addresses it lists:
    ###########################
    Installation Successful!
    ###########################
    
    The xBit application has been installed successfully!
    
    You can access the application at:
    
    http://192.0.2.10:17543/
    

The message is also saved as endpoint.txt in the installer's windows folder. xBit is installed in C:\teel_tech\apps\xbit.

Install to another drive or folder

Before step 4, open xbit_installer\windows\conf\xbit_config.ps1 in Notepad and change these lines:

$APP_DIRECTORY = "D:\teel_tech\apps\xbit"
$BACKUP_PATH   = "D:\teel_tech\backups\xbit_backups\automated"


Install on Linux

  1. Make sure Docker is running.
  2. Create $HOME/teel_tech/installer, copy the zip there and extract it.
  3. Open a terminal and run the installer:

    cd $HOME/teel_tech/installer/xbit_installer-4.1.latest/xbit_installer/linux
    sudo ./install.sh
    
  4. At Enter your TeelToken then hit [ENTER], paste your TeelToken.

  5. At Enter language code, type en_US (English) or es_ES (Spanish), or press Enter for English.
  6. Wait for Installation completed successfully! and copy the addresses it lists:
    ###########################
    ✓ Installation completed successfully!
    
    You can access the application at:
      • http://192.0.2.10:17543
    

xBit is installed under the home directory used by the installer, in teel_tech/apps/xbit. With sudo, this may be /root; check the installer output for the actual path. To use another folder, change APP_DIRECTORY and BACKUP_DIR in xbit_installer/linux/conf/xbit_config before step 3.


Installation secrets

Since 4.1.9, xBit has no built-in fallback for these two settings. Each installation needs its own random value.

Variable Protects If it is empty
TwoFA_SECRET Two-factor recovery codes, authenticator secrets and the "don't ask again on this computer" cookie Two-factor sign-in fails.
PASSWORD_RECOVERY_SECRET Password-reset links, together with a secret xBit generates for itself Password recovery stops.
  • The installer generates both and writes them to docker-compose.yml in the xBit folder, under application > environment.
  • Keep a secure copy of that file. Never reuse a value from another installation or from any published example.

⚠️ Note: Changing TwoFA_SECRET makes existing two-factor setups unreadable, so those users can't sign in with their authenticator app or recovery codes. Contact xBit Support before you change it.

Set a value yourself

  1. Generate a random value. On Linux or macOS, run openssl rand -hex 32. In Windows PowerShell, run:

    $b = New-Object byte[] 32; [Security.Cryptography.RandomNumberGenerator]::Create().GetBytes($b); -join ($b | % { $_.ToString('x2') })
    
  2. In docker-compose.yml, set the values under application > environment. Use a different value for each:

    TwoFA_SECRET: "<your-random-value>"
    PASSWORD_RECOVERY_SECRET: "<another-random-value>"
    
  3. In the xBit folder, apply the change:

    docker compose up -d
    
  4. Check the Health tab (below). If it still flags the variable, the application's own config/.env file also sets it and takes precedence. Contact xBit Support.

See Container operations for more commands.

Check the secrets in xBit

Go to Admin > About / Settings and open the Health tab.

Health tab of About / Settings, listing environment variables and their status

  1. Health tab. It is marked when something needs attention.
  2. Status: every variable with Required set to Yes should show Set. Values are never shown.
    • MISSING - required and not set: add the variable.
    • Still the value published with xBit - change it: replace it with your own random value.

Password-reset and notification emails don't take their links from the incoming request. They use SMTP SYSTEM URL on the E-MAIL / SMTP tab if it is set, otherwise the address staff last signed in from.

  • Set SMTP SYSTEM URL if users reach xBit at more than one address.


Support