Configuring a project to use Docksal
With Docksal you can initialize a basic LAMP stack with no configuration.
In this case a default configuration will be used to provision containers and set up a virtual host.
Initial configuration is done once per project (e.g., by a team lead) and committed to the project repo.
Presence of the
.docksal folder in the project directory is a good indication the project is using Docksal.
Project directory structure
Create a project directory structure:
mkdir ~/projects/myproject mkdir ~/projects/myproject/docroot mkdir ~/projects/myproject/.docksal
docroot directory is mounted as the web server document root.
.docksal directory is where all Docksal configurations and commands for the project are stored.
Git does not commit empty directories. To commit the
.docksal directory into your Git repo create an empty
.gitkeep file inside it ( or some other file of your choosing.)
Is your Project Root the same as your Document Root? If so, you can accomplish this by running
fin config set DOCROOT=. which sets the value in the
cd ~/projects/myproject fin project start
You will see output similar to the following:
Starting services... Creating network "myproject_default" with the default driver Creating volume "myproject_project_root" with local driver Creating myproject_cli_1 Creating myproject_db_1 Creating myproject_web_1 Connected vhost-proxy to "myproject_default" network.
SSH key passphrase
Note: SSH key passphrase
If you are being asked for an SSH key passphrase for
remember, that these are your keys loaded from your
~/.ssh folder into the
That's why their paths look like
/root/.ssh/.... That is the path inside the ssh-agent container.
Provide password(s) if you want to use git or drush commands, that require ssh access within Docksal (e.g., often a project init script or a composer script contains a repository checkout, which would require an ssh key for access).
Your project is ready
Your project stack is now running. Access it in your browser:
VIRTUAL HOST name
By default the virtual host name is equal to the project's folder name sans spaces and dashes,
.docksal domain appended to it.
myproject => myproject.docksal