Docker and Docker Compose based environments for web development.

Docksal is still under active development. Breaking changes and outdated docs are very possible.
Please help us by testing, submitting issues and PRs. Thanks!

Running a complete LAMP stack with Drupal, WordPress or a pure HTML/PHP base website is two commands away!^*

git clone <sample-project-repo>
fin init

Try one of the preconfigured projects:

• Drupal 7 sample project
• Drupal 8 sample project
• WordPress sample project

^*Once you are done with a one-time Docksal environment setup

Please review system requirements before proceeding with the setup.

1. Install required software

2. Create a Docksal powered project

Docksal Fin is a command line tool to control Docksal's stack. fin runs natively on Mac and Linux and requires Babun Shell on Windows.

Each project contains at least 3 services:

• web - holds your webserver (nginx/apache/etc.)
• db - holds database server (MySQL)
• cli - container that is meant to serve as a single console access point to all necessary command line tools. You can access it with fin bash. For the list of tools available inside cli check CLI image docs

Docksal Stack documentation

fin update

How to update from Drude to Docksal

• Running multiple projects
• Drupal settings (database, file permissions)
• MySQL DB access for external tools
• Overriding default PHP/MySQL/etc. settings
• Drush aliases
• Automatic database import
• DB sandbox mode
• Extending fin with custom commands
• Increasing vm memory (RAM)
• Exposing any Docker container's port
• Using Docker for Mac/Win
• Customize project configuration or switch PHP/MySQL version

• Debugging with Xdebug and PhpStorm
• Using custom ssh keys (with or without passwords) via ssh-agent
• Sending and capturing e-mail
• SASS/Compass
• PHP Code Sniffer (phpcs, phpcbf)
• Varnish
• Memcached
• Apache Solr
• Blackfire profiler
• Behat
• Public access via ngrok

Try these steps in the order listed below. Check if the issue has cleared out after each step.

• Check troubleshooting document for rare problems that might occur
• Update Docksal to the latest version. See updates section.
• (Mac and Windows) Restart the Docksal VM: fin vm restart
• Reset Docksal system services with fin reset system and restart projects containers with fin up
• Reboot the host (your computer or remote server)
• (Mac and Windows) Re-create Docksal VM: fin vm remove then fin vm start (WARNING: backup your DB data before doing this)

If quick fixes above did not help, try:

• searching the GitHub issue queue. Others may have experienced same or a similar issue and have already found a solution or a workaround.
• asking community for support in our Gitter room

Create a new issue if your problem is still not resolved.

The steps below will remove the Docksal VM and cleanup Docksal stuff.

fin vm remove
rm -rf ~/.docksal
rm -f /usr/local/bin/fin

Docker for Mac/Windows and VirtualBox are not automatically removed. You can remove them manually on Mac or use uninstaller on Windows.

To remove Docker on Ubuntu Linux you need to:

1. Follow Docker Uninstallation instruction
2. Cleanup tools:

sudo rm /usr/local/bin/docker-compose
sudo rm /usr/local/bin/docker-machine