laradock/index.md at 2f996450e5d9a1b893be809ecd94132d77cc7e08

42 KiB

Raw Blame History

title	type	weight
Documentation	index	3

List current running Containers

docker ps

You can also use the following command if you want to see only this project containers:

docker-compose ps

## Close all running Containers ```bash docker-compose stop ```

To stop single container do:

docker-compose stop {container-name}

## Delete all existing Containers ```bash docker-compose down ```
## Enter a Container (run commands in a running Container)

1 - First list the current running containers with docker ps

2 - Enter any container using:

docker-compose exec {container-name} bash

Example: enter MySQL container

docker-compose exec mysql bash

Example: enter to MySQL prompt within MySQL container

docker-compose exec mysql mysql -u homestead -psecret

3 - To exit a container, type exit.

## Edit default container configuration Open the `docker-compose.yml` and change anything you want.

Examples:

Change MySQL Database Name:

    environment:
        MYSQL_DATABASE: laradock
    ...

Change Redis default port to 1111:

    ports:
        - "1111:6379"
    ...

## Edit a Docker Image

1 - Find the Dockerfile of the image you want to edit,
example for mysql it will be mysql/Dockerfile.

2 - Edit the file the way you want.

3 - Re-build the container:

docker-compose build mysql

More info on Containers rebuilding here.

## Build/Re-build Containers

If you do any change to any Dockerfile make sure you run this command, for the changes to take effect:

docker-compose build

Optionally you can specify which container to rebuild (instead of rebuilding all the containers):

docker-compose build {container-name}

You might use the --no-cache option if you want full rebuilding (docker-compose build --no-cache {container-name}).

## Add more Software (Docker Images)

To add an image (software), just edit the docker-compose.yml and add your container details, to do so you need to be familiar with the docker compose file syntax.

## View the Log files The NGINX Log file is stored in the `logs/nginx` directory.

However to view the logs of all the other containers (MySQL, PHP-FPM,...) you can run this:

docker-compose logs {container-name}

docker-compose logs -f {container-name}

More options

Install PHP Extensions

Before installing PHP extensions, you have to decide first whether you need FPM or CLI, because each of them has it's own different container, if you need it for both, you have to edit both containers.

The PHP-FPM extensions should be installed in php-fpm/Dockerfile-XX. (replace XX with your default PHP version number).
The PHP-CLI extensions should be installed in workspace/Dockerfile.

## Change the (PHP-FPM) Version By default the latest stable PHP versin is configured to run.

The PHP-FPM is responsible of serving your application code, you don't have to change the PHP-CLI version if you are planning to run your application on different PHP-FPM version.

A) Switch from PHP `7.2` to PHP `5.6`

1 - Open the .env.

2 - Search for PHP_VERSION.

3 - Set the desired version number:

PHP_VERSION=5.6

4 - Finally rebuild the image

docker-compose build php-fpm

For more details about the PHP base image, visit the official PHP docker images.

## Change the PHP-CLI Version By default **PHP-CLI 7.0** is running.

Note: it's not very essential to edit the PHP-CLI version. The PHP-CLI is only used for the Artisan Commands & Composer. It doesn't serve your Application code, this is the PHP-FPM job.

The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to simply change the PHP_VERSION in te .env file as follow:

1 - Open the .env.

2 - Search for PHP_VERSION.

3 - Set the desired version number:

PHP_VERSION=7.2

4 - Finally rebuild the image

docker-compose build workspace

## Install xDebug

1 - First install xDebug in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_XDEBUG argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_XDEBUG argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

For information on how to configure xDebug with your IDE and work it out, check this Repository or follow up on the next section if you use linux and PhpStorm.

## Install phpdbg

Install phpdbg in the Workspace and the PHP-FPM Containers:

1 - Open the `.env`.

2 - Search for WORKSPACE_INSTALL_PHPDBG.

3 - Set value to true

4 - Do the same for PHP_FPM_INSTALL_PHPDBG

WORKSPACE_INSTALL_PHPDBG=true

PHP_FPM_INSTALL_PHPDBG=true

Setup remote debugging for PhpStorm on Linux

Make sure you have followed the steps above in the Install Xdebug section.
Make sure Xdebug accepts connections and listens on port 9000. (Should be default configuration).

Create a server with name laradock (matches PHP_IDE_CONFIG key in environment file) and make sure to map project root path with server correctly.

Start listening for debug connections, place a breakpoint and you are good to go !

## Start/Stop xDebug:

By installing xDebug, you are enabling it to run on startup by default.

To control the behavior of xDebug (in the php-fpm Container), you can run the following commands from the Laradock root folder, (at the same prompt where you run docker-compose):

Stop xDebug from running by default: .php-fpm/xdebug stop.
Start xDebug by default: .php-fpm/xdebug start.
See the status: .php-fpm/xdebug status.

Note: If .php-fpm/xdebug doesn't execute and gives Permission Denied error the problem can be that file xdebug doesn't have execution access. This can be fixed by running chmod command with desired access permissions.

## Install Deployer (Deployment tool for PHP)

1 - Open the .env file
2 - Search for the WORKSPACE_INSTALL_DEPLOYER argument under the Workspace Container
3 - Set it to true

4 - Re-build the containers docker-compose build workspace

Deployer Documentation Here

## Prepare Laradock for Production

It's recommended for production to create a custom docker-compose.yml file. For that reason, Laradock is shipped with production-docker-compose.yml which should contain only the containers you are planning to run on production (usage example: docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...).

Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host, which is quite insecure, unless specifically told not to. So make sure to remove these lines:

ports:
    - "3306:3306"

To learn more about how Docker publishes ports, please read this excellent post on the subject.

## Setup Laravel and Docker on Digital Ocean

Full Guide Here

Install Laravel from a Docker Container

1 - First you need to enter the Workspace Container.

2 - Install Laravel.

Example using Composer

composer create-project laravel/laravel my-cool-app "5.2.*"

We recommend using composer create-project instead of the Laravel installer, to install Laravel.

For more about the Laravel installation click here.

3 - Edit .env to Map the new application path:

By default, Laradock assumes the Laravel application is living in the parent directory of the laradock folder.

Since the new Laravel application is in the my-cool-app folder, we need to replace ../:/var/www with ../my-cool-app/:/var/www, as follow:

  APP_CODE_PATH_HOST=../my-cool-app/

4 - Go to that folder and start working..

cd my-cool-app

5 - Go back to the Laradock installation steps to see how to edit the .env file.

## Run Artisan Commands

You can run artisan commands and many other Terminal commands from the Workspace container.

1 - Make sure you have the workspace container running.

docker-compose up -d workspace // ..and all your other containers

2 - Find the Workspace container name:

docker-compose ps

3 - Enter the Workspace container:

docker-compose exec workspace bash

Add --user=laradock (example docker-compose exec --user=laradock workspace bash) to have files created as your host's user.

4 - Run anything you want :)

php artisan

Composer update

phpunit

## Run Laravel Queue Worker

1 - First add php-worker container. It will be similar as like PHP-FPM Container.
a) open the docker-compose.yml file
b) add a new service container by simply copy-paste this section below PHP-FPM container

    php-worker:
      build:
        context: ./php-worker
        args:
          - INSTALL_PGSQL=${PHP_WORKER_INSTALL_PGSQL} #Optionally install PGSQL PHP drivers
      volumes_from:
        - applications
      depends_on:
        - workspace
      extra_hosts:
        - "dockerhost:${DOCKER_HOST_IP}"
      networks:
        - backend

2 - Start everything up

docker-compose up -d php-worker

## Use NetData

1 - Run the NetData Container (netdata) with the docker-compose up command. Example:

docker-compose up -d netdata

2 - Open your browser and visit the localhost on port 19999: http://localhost:19999

## Use Jenkins

Boot the container docker-compose up -d jenkins. To enter the container type docker-compose exec jenkins bash.
Go to http://localhost:8090/ (if you didn't chanhed your default port mapping)
Authenticate from the web app.

Default username is admin.
Default password is docker-compose exec jenkins cat /var/jenkins_home/secrets/initialAdminPassword.

(To enter container as root type docker-compose exec --user root jenkins bash).

Install some plugins.
Create your first Admin user, or continue as Admin.

Note: to add user go to http://localhost:8090/securityRealm/addUser and to restart it from the web app visit http://localhost:8090/restart.

You may wanna change the default security configuration, so go to http://localhost:8090/configureSecurity/ under Authorization and choosing "Anyone can do anything" or "Project-based Matrix Authorization Strategy" or anything else.

## Use Redis

1 - First make sure you run the Redis Container (redis) with the docker-compose up command.

docker-compose up -d redis

To execute redis commands, enter the redis container first docker-compose exec redis bash then enter the redis-cli.

2 - Open your Laravel's .env file and set the REDIS_HOST to redis

REDIS_HOST=redis

If you're using Laravel, and you don't find the REDIS_HOST variable in your .env file. Go to the database configuration file config/database.php and replace the default 127.0.0.1 IP with redis for Redis like this:

'redis' => [
    'cluster' => false,
    'default' => [
        'host'     => 'redis',
        'port'     => 6379,
        'database' => 0,
    ],
],

3 - To enable Redis Caching and/or for Sessions Management. Also from the .env file set CACHE_DRIVER and SESSION_DRIVER to redis instead of the default file.

CACHE_DRIVER=redis
SESSION_DRIVER=redis

4 - Finally make sure you have the predis/predis package (~1.0) installed via Composer:

composer require predis/predis:^1.0

5 - You can manually test it from Laravel with this code:

\Cache::store('redis')->put('Laradock', 'Awesome', 10);

## Use Mongo

1 - First install mongo in the Workspace and the PHP-FPM Containers:
a) open the .env file
b) search for the WORKSPACE_INSTALL_MONGO argument under the Workspace Container
c) set it to true
d) search for the PHP_FPM_INSTALL_MONGO argument under the PHP-FPM Container
e) set it to true

2 - Re-build the containers docker-compose build workspace php-fpm

3 - Run the MongoDB Container (mongo) with the docker-compose up command.

docker-compose up -d mongo

4 - Add the MongoDB configurations to the config/database.php configuration file:

'connections' => [

    'mongodb' => [
        'driver'   => 'mongodb',
        'host'     => env('DB_HOST', 'localhost'),
        'port'     => env('DB_PORT', 27017),
        'database' => env('DB_DATABASE', 'database'),
        'username' => '',
        'password' => '',
        'options'  => [
            'database' => '',
        ]
    ],

	// ...

],

5 - Open your Laravel's .env file and update the following variables:

set the DB_HOST to your mongo.
set the DB_PORT to 27017.
set the DB_DATABASE to database.

6 - Finally make sure you have the jenssegers/mongodb package installed via Composer and its Service Provider is added.

composer require jenssegers/mongodb

More details about this here.

7 - Test it:

First let your Models extend from the Mongo Eloquent Model. Check the documentation.
Enter the Workspace Container.
Migrate the Database php artisan migrate.

## Use PhpMyAdmin

1 - Run the phpMyAdmin Container (phpmyadmin) with the docker-compose up command. Example:

# use with mysql
docker-compose up -d mysql phpmyadmin

# use with mariadb
docker-compose up -d mariadb phpmyadmin

Note: To use with MariaDB, open .env and set PMA_DB_ENGINE=mysql to PMA_DB_ENGINE=mariadb.

2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

## Use Adminer

1 - Run the Adminer Container (adminer) with the docker-compose up command. Example:

docker-compose up -d adminer

2 - Open your browser and visit the localhost on port 8080: http://localhost:8080

Note: We've locked Adminer to version 4.3.0 as at the time of writing it contained a major bug preventing PostgreSQL users from logging in. If that bug is fixed (or if you're not using PostgreSQL) feel free to set Adminer to the latest version within the Dockerfile: FROM adminer:latest

## Use Portainer

1 - Run the Portainer Container (portainer) with the docker-compose up command. Example:

docker-compose up -d portainer

2 - Open your browser and visit the localhost on port 9010: http://localhost:9010

## Use PgAdmin

1 - Run the pgAdmin Container (pgadmin) with the docker-compose up command. Example:

docker-compose up -d postgres pgadmin

2 - Open your browser and visit the localhost on port 5050: http://localhost:5050

## Use Beanstalkd

1 - Run the Beanstalkd Container:

docker-compose up -d beanstalkd

2 - Configure Laravel to connect to that container by editing the config/queue.php config file.

a. first set beanstalkd as default queue driver b. set the queue host to beanstalkd : QUEUE_HOST=beanstalkd

beanstalkd is now available on default port 11300.

3 - Require the dependency package pda/pheanstalk using composer.

Optionally you can use the Beanstalkd Console Container to manage your Queues from a web interface.

1 - Run the Beanstalkd Console Container:

docker-compose up -d beanstalkd-console

2 - Open your browser and visit http://localhost:2080/

Note: You can customize the port on which beanstalkd console is listening by changing BEANSTALKD_CONSOLE_HOST_PORT in .env. The default value is 2080.

3 - Add the server

Host: beanstalkd
Port: 11300

4 - Done.

## Use ElasticSearch

1 - Run the ElasticSearch Container (elasticsearch) with the docker-compose up command:

docker-compose up -d elasticsearch

2 - Open your browser and visit the localhost on port 9200: http://localhost:9200

The default username is elastic and the default password is changeme.

Install ElasticSearch Plugin

1 - Install an ElasticSearch plugin.

docker-compose exec elasticsearch /usr/share/elasticsearch/bin/plugin install {plugin-name}

2 - Restart elasticsearch container

docker-compose restart elasticsearch

## Use Selenium

1 - Run the Selenium Container (selenium) with the docker-compose up command. Example:

docker-compose up -d selenium

2 - Open your browser and visit the localhost on port 4444 at the following URL: http://localhost:4444/wd/hub

## Use RethinkDB

The RethinkDB is an open-source Database for Real-time Web (RethinkDB). A package (Laravel RethinkDB) is being developed and was released a version for Laravel 5.2 (experimental).

1 - Run the RethinkDB Container (rethinkdb) with the docker-compose up command.

docker-compose up -d rethinkdb

2 - Access the RethinkDB Administration Console http://localhost:8090/#tables for create a database called database.

3 - Add the RethinkDB configurations to the config/database.php configuration file:

'connections' => [

	'rethinkdb' => [
		'name'      => 'rethinkdb',
		'driver'    => 'rethinkdb',
		'host'      => env('DB_HOST', 'rethinkdb'),
		'port'      => env('DB_PORT', 28015),
		'database'  => env('DB_DATABASE', 'test'),
	]

	// ...

],

4 - Open your Laravel's .env file and update the following variables:

set the DB_CONNECTION to your rethinkdb.
set the DB_HOST to rethinkdb.
set the DB_PORT to 28015.
set the DB_DATABASE to database.

## Use Minio

1 - Configure Minio:

On the workspace container, change INSTALL_MC to true to get the client
Set MINIO_ACCESS_KEY and MINIO_ACCESS_SECRET if you wish to set proper keys

2 - Run the Minio Container (minio) with the docker-compose up command. Example:

docker-compose up -d minio

3 - Open your browser and visit the localhost on port 9000 at the following URL: http://localhost:9000

4 - Create a bucket either through the webui or using the mc client:

mc mb minio/bucket

5 - When configuring your other clients use the following details:

S3_HOST=http://minio
S3_KEY=access
S3_SECRET=secretkey
S3_REGION=us-east-1
S3_BUCKET=bucket

## Use AWS

1 - Configure AWS:

make sure to add your SSH keys in aws/ssh_keys folder

2 - Run the Aws Container (aws) with the docker-compose up command. Example:

docker-compose up -d aws

3 - Access the aws container with docker-compose exec aws bash

4 - To start using eb cli inside the container, initialize your project first by doing 'eb init'. Read the aws eb cli docs for more details.

## Use Grafana

1 - Configure Grafana: Change Port using GRAFANA_PORT if you wish to. Default is port 3000.

2 - Run the Grafana Container (grafana) with the docker-compose upcommand:

docker-compose up -d grafana

3 - Open your browser and visit the localhost on port 3000 at the following URL: http://localhost:3000

4 - Login using the credentials User = admin, Password = admin. Change the password in the web interface if you want to.

## Install CodeIgniter

To install CodeIgniter 3 on Laradock all you have to do is the following simple steps:

1 - Open the docker-compose.yml file.

2 - Change CODEIGNITER=false to CODEIGNITER=true.

3 - Re-build your PHP-FPM Container docker-compose build php-fpm.

## Install Symfony

1 - Open the .env file and set WORKSPACE_INSTALL_SYMFONY to true.

2 - Run docker-compose build workspace, after the step above.

3 - The NGINX sites include a default config file for your Symfony project symfony.conf.example, so edit it and make sure the root is pointing to your project web directory.

4 - Run docker-compose restart if the container was already running, before the step above.

5 - Visit symfony.test

## Miscellaneous
## Change the timezone

To change the timezone for the workspace container, modify the TZ build argument in the Docker Compose file to one in the TZ database.

For example, if I want the timezone to be New York:

    workspace:
        build:
            context: ./workspace
            args:
                - TZ=America/New_York
    ...

We also recommend setting the timezone in Laravel.

## Adding cron jobs

You can add your cron jobs to workspace/crontab/root after the php artisan line.

* * * * * php /var/www/artisan schedule:run >> /dev/null 2>&1

# Custom cron
* * * * * root echo "Every Minute" > /var/log/cron.log 2>&1

Make sure you change the timezone if you don't want to use the default (UTC).

If you are on Windows, verify that the line endings for this file are LF only, otherwise the cron jobs will silently fail.

## Access workspace via ssh

You can access the workspace container through localhost:2222 by setting the INSTALL_WORKSPACE_SSH build argument to true.

To change the default forwarded port for ssh:

    workspace:
		ports:
			- "2222:22" # Edit this line
    ...

Then login using:

ssh -o PasswordAuthentication=no    \
    -o StrictHostKeyChecking=no     \
    -o UserKnownHostsFile=/dev/null \
    -p 2222                         \
    -i workspace/insecure_id_rsa    \
    laradock@localhost

To login as root, replace laradock@locahost with root@localhost.

## Change the (MySQL) Version By default **MySQL 8.0** is running.

MySQL 8.0 is a development release. You may prefer to use the latest stable version, or an even older release. If you wish, you can change the MySQL image that is used.

Open up your .env file and set the MYSQL_VERSION variable to the version you would like to install.

MYSQL_VERSION=5.7

Available versions are: 5.5, 5.6, 5.7, 8.0, or latest. See https://store.docker.com/images/mysql for more information.

## MySQL access from host

You can forward the MySQL/MariaDB port to your host by making sure these lines are added to the mysql or mariadb section of the docker-compose.yml or in your environment specific Compose file.

ports:
    - "3306:3306"

## MySQL root access

The default username and password for the root MySQL user are root and root .

1 - Enter the MySQL container: docker-compose exec mysql bash.

2 - Enter mysql: mysql -uroot -proot for non root access use mysql -uhomestead -psecret.

3 - See all users: SELECT User FROM mysql.user;

4 - Run any commands show databases, show tables, select * from......

## Create Multiple Databases (MySQL)

Create createdb.sql from mysql/docker-entrypoint-initdb.d/createdb.sql.example in mysql/docker-entrypoint-initdb.d/* and add your SQL syntax as follow:

CREATE DATABASE IF NOT EXISTS `your_db_1` COLLATE 'utf8_general_ci' ;
GRANT ALL ON `your_db_1`.* TO 'mysql_user'@'%' ;

## Change MySQL port

Modify the mysql/my.cnf file to set your port number, 1234 is used as an example.

[mysqld]
port=1234

If you need MySQL access from your host, do not forget to change the internal port number ("3306:3306" -> "3306:1234") in the docker-compose configuration file.

## Use custom Domain (instead of the Docker IP)

Assuming your custom domain is laravel.test

1 - Open your /etc/hosts file and map your localhost address 127.0.0.1 to the laravel.test domain, by adding the following:

127.0.0.1    laravel.test

2 - Open your browser and visit {http://laravel.test}

Optionally you can define the server name in the NGINX configuration file, like this:

server_name laravel.test;

## Enable Global Composer Build Install

Enabling Global Composer Install during the build for the container allows you to get your composer requirements installed and available in the container after the build is done.

1 - Open the .env file

2 - Search for the WORKSPACE_COMPOSER_GLOBAL_INSTALL argument under the Workspace Container and set it to true

3 - Now add your dependencies to workspace/composer.json

4 - Re-build the Workspace Container docker-compose build workspace

## Install Prestissimo

Prestissimo is a plugin for composer which enables parallel install functionality.

1 - Enable Running Global Composer Install during the Build:

Click on this Enable Global Composer Build Install and do steps 1 and 2 only then continue here.

2 - Add prestissimo as requirement in Composer:

a - Now open the workspace/composer.json file

b - Add "hirak/prestissimo": "^0.3" as requirement

c - Re-build the Workspace Container docker-compose build workspace

## Install Node + NVM

To install NVM and NodeJS in the Workspace container

1 - Open the .env file

2 - Search for the WORKSPACE_INSTALL_NODE argument under the Workspace Container and set it to true