dl

README

Deploy Local — site deployment assistant locally.

A convenient wrapper over docker-compose, which simplifies the local deployment of the project.

Deploy Local — is a command line interface designed to help developers quickly deploy projects to their local machine.
DL is a wrapper on top of Docker and docker-compose, in basic use no additional software or libraries are required to be installed.

Documentation local-deploy.github.io

Supported

Supported OS: Linux, macOS, Windows (via WSL2)
Supported architectures: x64, arm64
Supported frameworks and CMS: Bitrix, Laravel, WordPress

Features

• Support for PHP versions (apache and php-fpm) 7.3, 7.4, 8.0, 8.1, 8.2
• Support for MySQL versions 5.7, 8.0
• Downloading the database and files from the production server
• Redis
• Memcached
• Nginx
• Cross-platform
• Interception of mail sent via php
• Portainer - docker container management system
• Does not require root access (when installing the executable file in the user's directory)
• Accessing sites from the browser via .localhost or .nip.io
• Ability to add custom docker-compose.yaml files to DL configuration

Dependencies

• docker (more than v22)
• docker-compose v2

The docker compose (as plugin) supported

Install

Choose the installation method that suits you:

• Installing the deb-package
• Installation in the user's home directory
• Manual installation

See all available installation methods https://local-deploy.github.io/getting-started/install

Upgrading from version 0.* to version 1.*

Just reinstall the application using one of the above methods. Updating using the built-in commands is not possible.

Usage

1. Start service containers (traefik, mailhog, portainer) with the command (at the first start):

   dl service up
   

2. Create .env file in the root directory of your project with the command:

   dl env
   

3. Set the required variables in the .env file

4. Run the command if you need to download the database and/or files from the production-server:

   dl deploy
   

5. Run local project with command:

   dl up
   

See quick reference for available commands.

---

Remember that dl is meant for development purposes, not production.