Tabby - A friendly tool to manage debt

Credits

All credits to Tabby goes to the devs at https://github.com/bertvandepoel/tabby.

Table of Contents

• Goals
• Requirements
• Quick Start
• Advanced Configuration
  • Environment Variables
  • Docker CLI
  • Docker Compose
• Build
  • Basic Build
  • Advanced Build
    • Clone Repo
    • Building the Container
      • Build Arguments
• License

Goals

• Rebase the image from ubuntu to alpine to support more architectures
• Switch to NGINX as the webserver
• Add PUID and PGID environment variables

Requirements

• Docker
• An internet connection
• Optional:
  • Docker Compose

Quick Start

This is the fastest way to get the service up and running, it will take you through a semi interactive startup to initialize the environment with a database. It will also give you some steps to connect tabby to the database. Use the code below to deploy tabby on your system, for production envrionments I recommend using docker compose.

# Copy the startup script to your computer and make executable
wget https://raw.githubusercontent.com/parksauce/tabby/main/startup.sh && chmod +x startup.sh

# Run the script and follow the prompts
./startup.sh

Now you can access the container from http://HOST_IP:8010

Advanced Configuration

This section covers a more in-depth guide on deploying Tabby on your server.

Environment Variables

Variable	Description	Default	Optional
TZ	Set this to your timezone. Example: America/New_York	UTC	✓
TABBY_SMTP_HOST	Set this to your mail server host. Example: mail.example.com
TABBY_SMTP_PORT	Set this to the port of your mail server. This will typically be 465 or 587	465	✓
TABBY_SMTP_USER	Set this to your SMTP user, this is used to authenticate with your SMTP server. Example: user@example.com
TABBY_SMTP_PASS	Set this to your SMTP users password, this is used to authenticate with your SMTP server. Example: MyPassword
TABBY_SMTP_AUTH_METHOD	Set this to the authentication method you use for your SMTP server. Some options are PLAIN, LOGIN, and CRAM-MD5, theres more but those ones have logic built in so you can input plain text and it will create the hash for you. The rest you will need to manually create the hash for.	LOGIN	✓
TABBY_SMTP_USE_TLS	Set this to Yes to use TLS otherwise you can set it to No.	Yes	✓
TABBY_SMTP_USE_STARTTLS	Set this to Yes or No to use STARTTLS	No	✓

Docker CLI

First create a network to connect both of the services to.

docker network create tabby-backend

Run the following command to start Tabby

docker run -d \
  --name=tabby \
  --network=tabby-backend \
  -p 8010:80 \
  -e TZ=America/New_York \
  -e TABBY_SMTP_USER=user@example.com \
  -e TABBY_SMTP_PASS=MyPassword \
  -e TABBY_SMTP_HOST=mail.example.com \
  -e TABBY_SMTP_PORT=465 \
  -e TABBY_SMTP_AUTH_METHOD=LOGIN \ 
  -e TABBY_SMTP_USE_TLS=Yes \ 
  -e TABBY_SMTP_USE_STARTTLS=No \ 
  -v path_to_data:/config \
  --restart unless-stopped \
  parksauce/tabby

Then run this command to start the database

docker run -d \
  --name=mariadb \
  --network=tabby-backend \
  -e PUID=1000 \ # Run 'id' in your terminal to get this value
  -e PGID=1000 \ # Run 'id' in your terminal to get this value
  -e MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD \
  -e TZ=America/New_York \
  -e MYSQL_DATABASE=tabby \
  -e MYSQL_USER=tabby \
  -e MYSQL_PASSWORD=tabby \
  -v path_to_data:/config \
  --restart unless-stopped \
  linuxserver/mariadb

Docker Compose

Create a file named docker-compose.yml and then run docker-compose pull && docker-compose up -d

version: '3'
services:

  tabby:
    image: parksauce/tabby
    container_name: tabby
    ports:
      - 8010:80
    environment:
      - TZ=America/New_York
      # Mail server configuration
      - TABBY_SMTP_USER=user@example.com
      - TABBY_SMTP_PASS=MyPassword
      - TABBY_SMTP_HOST=mail.example.com
      - TABBY_SMTP_PORT=465 # Optional | Default: 465 | Typically 465 or 587
      - TABBY_SMTP_AUTH_METHOD=LOGIN # Optional | Default: LOGIN | LOGIN, PLAIN, CRAM-MD5
      - TABBY_SMTP_USE_TLS=Yes # Optional | Default: Yes | Yes, No
      - TABBY_SMTP_USE_STARTTLS=No # Optional | Default: No | Yes, No
    volumes:
      - ./tabby:/config
    restart: unless-stopped
    
  db:
    image: linuxserver/mariadb
    container_name: tabby-db
    environment:
      - PUID=1000 # Run 'id' in your terminal to get this value
      - PGID=1000 # Run 'id' in your terminal to get this value
      - MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORD
      - TZ=America/New_York
      - MYSQL_DATABASE=tabby
      - MYSQL_USER=tabby
      - MYSQL_PASSWORD=tabby
    volumes:
      - ./db:/config
    restart: unless-stopped
    
  #db:
  #  image: postgres
  #  container_name: tabby-db
  #  networks:
  #    - backend
  #  environment:
  #    - POSTGRES_DB=tabby
  #    - POSTGRES_USER=tabby
  #    - POSTGRES_PASSWORD=tabby
  #  volumes:
  #    - ./db:/var/lib/postgresql/data
  #  restart: unless-stopped

Build

This section covers building the container.

Basic Build

This will clone the repo to your environment, then it will move to the tabby directory and build the container and name it tabby. By default the container uses Tabby version 1.2.2 which may become out of date at some point. Look into the Advanced Build to change the version of Tabby while building the container.

git clone https://github.com/parksauce/tabby.git
cd tabby && docker build -t tabby .

Advanced Build

When building the container you are capable of using a few different build parameters to change the version of both Tabby and PHP in the container. You can use the below command as a template for whatever builds you want.

Clone Repo

First clone the repo and move to the tabby directory

git clone https://github.com/parksauce/tabby.git && cd tabby 

Building the Container

We support a few different build arguments when building the container. Check build arguments for more information. Below is an example to build the container for Tabby version 1.2.2 using the latest version of PHP.

docker build --build-arg TABBY_VERSION=1.2.2 -t tabby .

Build Arguments

The table below shows the different arguments we support

Argument	Function
TABBY_VERSION	Changes the version of Tabby
PHP_VERSION	Change the version of PHP

License

This project is licensed under the AGPL license - see the LICENSE file for details.