README

A simple php based database structure diff tool that you can self host.

Looking to build a diff tool your self? Check out db-diff-utils.

Installation

Installation can be done through either composer, or using docker.

Using Composer

You will need to install the project using a web server using php7+.

composer create-project --prefer-dist pm-connect/db-diff db-diff

Using Docker

There is an available docker image and docker file with this project that will give you a running application within seconds.

Either create a machine from the jralph/db-diff docker image, or run the Dockerfile and create your own.

Note: When using docker to run the diff application, diffs will be run using the sync queue. This means that you will only be able to run one diff at a time and may be limited to the http request duration.

Docker Hub

Config

You will need to set a database configuration to save the diff logs, this is done in a .env file, which you will need to create. An example is provided below.

Once done, you will also need to run the migrations.

php artisan migrate

You can also optionally setup a queue to enable better performance for diff running.

Example .env File

APP_ENV=local
APP_KEY=base64:1v0HsWYBr3Onmy5WNqIIs2/s3d0moHRg9IPK4ZD0/rY=
APP_DEBUG=true
APP_LOG_LEVEL=debug
APP_URL=http://db-diff.dev

DB_CONNECTION=sqlite

QUEUE_DRIVER=database

BROADCAST_DRIVER=log
CACHE_DRIVER=file
SESSION_DRIVER=file
QUEUE_DRIVER=sync

Queues

If you opt to use a queue driver that is not sync, you will need to run the build-in queue worker through the command line.

php artisan queue:listen --queue=default --timeout=120

You may also want to set the timeout to a greater value, depending on the size of the databases you are planning to diff. Generally a 60 second timeout works well in most cases.

For more information on running queue workers, please see here.

Issues

Please submit any issues using GitHubs build in issue management.