blackbirdchess/blackbirdchess-docker-dev
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updating docs

Browse Source 
Attempting to replace some of the mark-up with more semantically correct (using ordered lists etc)

Fixed some seplling, grammar errors.
This commit is contained in:
Mike Hingley 2019-10-25 18:18:22 +01:00 committed by GitHub
parent f5c00c61be
commit 0ac954b097
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 285 additions and 398 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

669
DOCUMENTATION/content/documentation/index.md
View File

@ -217,9 +217,9 @@ The PHP-CLI extensions should be installed in `workspace/Dockerfile`.
<br> <br>
<a name="Change-the-PHP-FPM-Version"></a> <a name="Change-the-PHP-FPM-Version"></a>
## Change the (PHP-FPM) Version ## Change the (PHP-FPM) Version
By default the latest stable PHP versin is configured to run. By default, the latest stable PHP version 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. >The PHP-FPM is responsible for 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` ### A) Switch from PHP `7.2` to PHP `5.6`
@ -253,7 +253,7 @@ docker-compose build php-fpm
>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. >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: The PHP-CLI is installed in the Workspace container. To change the PHP-CLI version you need to simply change the `PHP_VERSION` in the .env file as follow:
1 - Open the `.env`. 1 - Open the `.env`.
@ -274,7 +274,7 @@ docker-compose build workspace
Change the PHP-CLI Version
<br> <br>
<a name="Install-xDebug"></a> <a name="Install-xDebug"></a>
@ -294,7 +294,7 @@ e) set it to `true`
2 - Re-build the containers `docker-compose build workspace php-fpm` 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](https://github.com/LarryEitel/laravel-laradock-phpstorm) or follow up on the next section if you use linux and PhpStorm. For information on how to configure xDebug with your IDE and work it out, check this [Repository](https://github.com/LarryEitel/laravel-laradock-phpstorm) or follow up on the next section if you use Linux and PhpStorm.
@ -426,11 +426,11 @@ docker-compose run --user=root --rm sonarqube chown sonarqube:sonarqube /opt/son
<a name="Laradock-for-Production"></a> <a name="Laradock-for-Production"></a>
## Prepare Laradock for Production ## Prepare Laradock for Production
It's recommended for production to create a custom `docker-compose.yml` file, for example `production-docker-compose.yml` It's recommended for production to create a custom `docker-compose.yml` file, for example, `production-docker-compose.yml`
In your new production `docker-compose.yml` file you should contain only the containers you are planning to run in production (usage example: `docker-compose -f production-docker-compose.yml up -d nginx mysql redis ...`). In your new production `docker-compose.yml` file, you should include only the containers you are planning to run in 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: Note: The Database (MySQL/MariaDB/...) ports should not be forwarded on production, because Docker will automatically publish the port on the host unless specifically told not to. Forwarding these ports on production is quite insecure - so make sure to remove these lines:
``` ```
ports: ports:
@ -551,7 +551,7 @@ phpunit
<a name="Run-Laravel-Queue-Worker"></a> <a name="Run-Laravel-Queue-Worker"></a>
## Run Laravel Queue Worker ## Run Laravel Queue Worker
1 - Create supervisor configuration file (for ex., named `laravel-worker.conf`) for Laravel Queue Worker in `php-worker/supervisord.d/` by simply copy from `laravel-worker.conf.example` 1 - Create a suitable configuration file (for example named `laravel-worker.conf`) for Laravel Queue Worker in `php-worker/supervisord.d/` by simply copying from `laravel-worker.conf.example`
2 - Start everything up 2 - Start everything up
@ -569,38 +569,29 @@ docker-compose up -d php-worker
## Run Laravel Scheduler ## Run Laravel Scheduler
Laradock provides 2 ways to run Laravel Scheduler Laradock provides 2 ways to run Laravel Scheduler
1 - Using cron in workspace container. Most of the time, when you start Laradock, it'll automatically start workspace container with cron inside, along with setting to run `schedule:run` command every minute. 1. Using cron in workspace container.
Most of the time, when you start Laradock, it'll automatically start workspace container with cron inside, along with setting to run `schedule:run` command every minute.
2 - Using Supervisord in php-worker to run `schedule:run`. This way is suggested when you don't want to start workspace in production environment. 2. Using Supervisord in php-worker to run `schedule:run`.
<br> This way is suggested when you don't want to start workspace in production environment.
a) Comment out cron setting in workspace container, file `workspace/crontab/laradock` * Comment out cron setting in workspace container, file `workspace/crontab/laradock`
```bash
```bash # * * * * * laradock /usr/bin/php /var/www/artisan schedule:run >> /dev/null 2>&1
# * * * * * laradock /usr/bin/php /var/www/artisan schedule:run >> /dev/null 2>&1 ```
``` * Create a suitable configuration file (for ex., named `laravel-scheduler.conf`) for Laravel Scheduler in `php-worker/supervisord.d/` by simply copying from `laravel-scheduler.conf.example`
<br>
b) Create supervisor configuration file (for ex., named `laravel-scheduler.conf`) for Laravel Scheduler in `php-worker/supervisord.d/` by simply copy from `laravel-scheduler.conf.example`
<br>
c) Start php-worker container
```bash
docker-compose up -d php-worker
```
* Start php-worker container
```bash
docker-compose up -d php-worker
```
<br> <br>
<a name="Use-Mailu"></a> <a name="Use-Mailu"></a>
## Use Mailu ## Use Mailu
1 - You need register a domain. 1. You will need a registered domain.
2 - Required RECAPTCHA for signup email [HERE](https://www.google.com/recaptcha/admin) 2. Required RECAPTCHA for signup email [HERE](https://www.google.com/recaptcha/admin)
2 - modify following environment variable in `.env` file 3. Modify following environment variable in `.env` file
``` ```
MAILU_RECAPTCHA_PUBLIC_KEY=<YOUR_RECAPTCHA_PUBLIC_KEY> MAILU_RECAPTCHA_PUBLIC_KEY=<YOUR_RECAPTCHA_PUBLIC_KEY>
@ -609,36 +600,32 @@ MAILU_DOMAIN=laradock.io
MAILU_HOSTNAMES=mail.laradock.io MAILU_HOSTNAMES=mail.laradock.io
``` ```
2 - Open your browser and visit `http://YOUR_DOMAIN`. 4. Open your browser and visit `http://YOUR_DOMAIN`.
<br> <br>
<a name="Use-NetData"></a> <a name="Use-NetData"></a>
## Use NetData ## Use NetData
1 - Run the NetData Container (`netdata`) with the `docker-compose up` command. Example: 1. Run the NetData Container (`netdata`) with the `docker-compose up` command. Example:
```bash ```bash
docker-compose up -d netdata docker-compose up -d netdata
``` ```
2 - Open your browser and visit the localhost on port **19999**: `http://localhost:19999` 2. Open your browser and visit the localhost on port **19999**: `http://localhost:19999`
<br> <br>
<a name="Use-Metabase"></a> <a name="Use-Metabase"></a>
## Use Metabase ## Use Metabase
1 - Run the Metabase Container (`metbase`) with the `docker-compose up` command. Example: 1. Run the Metabase Container (`metabase`) with the `docker-compose up` command. Example:
```bash
docker-compose up -d metabase
```
2. Open your browser and visit the localhost on port **3030**: `http://localhost:3030`
```bash 3. You can use environment to configure Metabase container. See docs in: [Running Metabase on Docker](https://www.metabase.com/docs/v0.12.0/operations-guide/running-metabase-on-docker.html)
docker-compose up -d metabase
```
2 - Open your browser and visit the localhost on port **3030**: `http://localhost:3030`
3 - You can use environment to configure Metabase container. See docs in: [Running Metabase on Docker](https://www.metabase.com/docs/v0.12.0/operations-guide/running-metabase-on-docker.html)
@ -676,52 +663,40 @@ You may wanna change the default security configuration, so go to `http://localh
<a name="Use-Redis"></a> <a name="Use-Redis"></a>
## Use Redis ## Use Redis
1 - First make sure you run the Redis Container (`redis`) with the `docker-compose up` command. 1. First make sure you run the Redis Container (`redis`) with the `docker-compose up` command.
```bash
docker-compose up -d redis
```
> To execute redis commands, enter the redis container first `docker-compose exec redis bash` then enter the `redis-cli`.
```bash 2. Open your Laravel's `.env` file and set the `REDIS_HOST` to `redis`
docker-compose up -d redis ```env
``` REDIS_HOST=redis
```
> To execute redis commands, enter the redis container first `docker-compose exec redis bash` then enter the `redis-cli`. 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:
```php
2 - Open your Laravel's `.env` file and set the `REDIS_HOST` to `redis` 'redis' => [
'cluster' => false,
```env 'default' => [
REDIS_HOST=redis 'host' => 'redis',
``` 'port' => 6379,
'database' => 0,
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: ],
```php
'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`.
```env
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
```env ```
CACHE_DRIVER=redis 4. Finally make sure you have the `predis/predis` package `(~1.0)` installed via Composer:
SESSION_DRIVER=redis ```bash
``` composer require predis/predis:^1.0
```
4 - Finally make sure you have the `predis/predis` package `(~1.0)` installed via Composer: 5. You can manually test it from Laravel with this code:
```php
```bash \Cache::store('redis')->put('Laradock', 'Awesome', 10);
composer require predis/predis:^1.0 ```
```
5 - You can manually test it from Laravel with this code:
```php
\Cache::store('redis')->put('Laradock', 'Awesome', 10);
```
@ -730,36 +705,30 @@ composer require predis/predis:^1.0
<br> <br>
<a name="Use-Redis-Cluster"></a> <a name="Use-Redis-Cluster"></a>
## Use Redis Cluster ## Use Redis Cluster
1. First make sure you run the Redis-Cluster Container (`redis-cluster`) with the `docker-compose up` command.
1 - First make sure you run the Redis-Cluster Container (`redis-cluster`) with the `docker-compose up` command. ```bash
docker-compose up -d redis-cluster
```bash ```
docker-compose up -d redis-cluster 2. Open your Laravel's `config/database.php` and set the redis cluster configuration. Below is example configuration with phpredis.
``` Read the [Laravel official documentation](https://laravel.com/docs/5.7/redis#configuration) for more details.
```php
2 - Open your Laravel's `config/database.php` and set the redis cluster configuration. Below is example configuration with phpredis. 'redis' => [
'client' => 'phpredis',
Read the [Laravel official documentation](https://laravel.com/docs/5.7/redis#configuration) for more details. 'options' => [
'cluster' => 'redis',
```php ],
'redis' => [ 'clusters' => [
'client' => 'phpredis', 'default' => [
'options' => [ [
'cluster' => 'redis', 'host' => 'redis-cluster',
], 'password' => null,
'clusters' => [ 'port' => 7000,
'default' => [ 'database' => 0,
[ ],
'host' => 'redis-cluster',
'password' => null,
'port' => 7000,
'database' => 0,
], ],
], ],
], ],
], ```
```
@ -768,71 +737,51 @@ Read the [Laravel official documentation](https://laravel.com/docs/5.7/redis#con
<br> <br>
<a name="Use-Mongo"></a> <a name="Use-Mongo"></a>
## Use Mongo ## Use Mongo
1. First install `mongo` in the Workspace and the PHP-FPM Containers:
* open the `.env` file
* search for the `WORKSPACE_INSTALL_MONGO` argument under the Workspace Container
* set it to `true`
* search for the `PHP_FPM_INSTALL_MONGO` argument under the PHP-FPM Container
* 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.
```bash
docker-compose up -d mongo
```
4. Add the MongoDB configurations to the `config/database.php` configuration file:
```php
'connections' => [
1 - First install `mongo` in the Workspace and the PHP-FPM Containers: 'mongodb' => [
<br> 'driver' => 'mongodb',
a) open the `.env` file 'host' => env('DB_HOST', 'localhost'),
<br> 'port' => env('DB_PORT', 27017),
b) search for the `WORKSPACE_INSTALL_MONGO` argument under the Workspace Container 'database' => env('DB_DATABASE', 'database'),
<br> 'username' => '',
c) set it to `true` 'password' => '',
<br> 'options' => [
d) search for the `PHP_FPM_INSTALL_MONGO` argument under the PHP-FPM Container 'database' => '',
<br> ]
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.
```bash
docker-compose up -d mongo
```
4 - Add the MongoDB configurations to the `config/database.php` configuration file:
```php
'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.
5 - Open your Laravel's `.env` file and update the following variables: ```bash
composer require jenssegers/mongodb
- set the `DB_HOST` to your `mongo`. ```
- set the `DB_PORT` to `27017`. More details about this [here](https://github.com/jenssegers/laravel-mongodb#installation).
- set the `DB_DATABASE` to `database`. 7. Test it:
- First let your Models extend from the Mongo Eloquent Model. Check the [documentation](https://github.com/jenssegers/laravel-mongodb#eloquent).
- Enter the Workspace Container.
6 - Finally make sure you have the `jenssegers/mongodb` package installed via Composer and its Service Provider is added. - Migrate the Database `php artisan migrate`.
```bash
composer require jenssegers/mongodb
```
More details about this [here](https://github.com/jenssegers/laravel-mongodb#installation).
7 - Test it:
- First let your Models extend from the Mongo Eloquent Model. Check the [documentation](https://github.com/jenssegers/laravel-mongodb#eloquent).
- Enter the Workspace Container.
- Migrate the Database `php artisan migrate`.
@ -842,20 +791,16 @@ More details about this [here](https://github.com/jenssegers/laravel-mongodb#ins
<br> <br>
<a name="Use-phpMyAdmin"></a> <a name="Use-phpMyAdmin"></a>
## Use PhpMyAdmin ## Use PhpMyAdmin
1. Run the phpMyAdmin Container (`phpmyadmin`) with the `docker-compose up` command.
```bash
# use with mysql
docker-compose up -d mysql phpmyadmin
1 - Run the phpMyAdmin Container (`phpmyadmin`) with the `docker-compose up` command. Example: # use with mariadb
docker-compose up -d mariadb phpmyadmin
```bash ```
# use with mysql *Note: To use with MariaDB, open `.env` and set `PMA_DB_ENGINE=mysql` to `PMA_DB_ENGINE=mariadb`.*
docker-compose up -d mysql phpmyadmin 2. Open your browser and visit the localhost on port **8080**: `http://localhost:8080`
# 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`
@ -865,15 +810,11 @@ docker-compose up -d mariadb phpmyadmin
<br> <br>
<a name="Use-Gitlab"></a> <a name="Use-Gitlab"></a>
## Use Gitlab ## Use Gitlab
1. Run the Gitlab Container (`gitlab`) with the `docker-compose up` command. Example:
1 - Run the Gitlab Container (`gitlab`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d gitlab
```bash ```
docker-compose up -d gitlab 2. Open your browser and visit the localhost on port **8989**: `http://localhost:8989`
```
2 - Open your browser and visit the localhost on port **8989**: `http://localhost:8989`
<br>
*Note: You may change GITLAB_DOMAIN_NAME to your own domain name like `http://gitlab.example.com` default is `http://localhost`* *Note: You may change GITLAB_DOMAIN_NAME to your own domain name like `http://gitlab.example.com` default is `http://localhost`*
@ -884,58 +825,48 @@ docker-compose up -d gitlab
<br> <br>
<a name="Use-Gitlab-Runner"></a> <a name="Use-Gitlab-Runner"></a>
## Use Gitlab Runner ## Use Gitlab Runner
1. Retrieve the registration token in your gitlab project (Settings > CI / CD > Runners > Set up a specific Runner manually)
2. Open the `.env` file and set the following changes:
```
# so that gitlab container will pass the correct domain to gitlab-runner container
GITLAB_DOMAIN_NAME=http://gitlab
1 - Retrieve the registration token in your gitlab project (Settings > CI / CD > Runners > Set up a specific Runner manually) GITLAB_RUNNER_REGISTRATION_TOKEN=<value-in-step-1>
2 - Open the `.env` file and set the following changes: # so that gitlab-runner container will send POST request for registration to correct domain
``` GITLAB_CI_SERVER_URL=http://gitlab
# so that gitlab container will pass the correct domain to gitlab-runner container ```
GITLAB_DOMAIN_NAME=http://gitlab 3. Open the `docker-compose.yml` file and add the following changes:
```yml
gitlab-runner:
environment: # these values will be used during `gitlab-runner register`
- RUNNER_EXECUTOR=docker # change from shell (default)
- DOCKER_IMAGE=alpine
- DOCKER_NETWORK_MODE=laradock_backend
networks:
- backend # connect to network where gitlab service is connected
```
4. Run the Gitlab-Runner Container (`gitlab-runner`) with the `docker-compose up` command. Example:
```bash
docker-compose up -d gitlab-runner
```
5. Register the gitlab-runner to the gitlab container
```bash
docker-compose exec gitlab-runner bash
gitlab-runner register
```
GITLAB_RUNNER_REGISTRATION_TOKEN=<value-in-step-1> 6. Create a `.gitlab-ci.yml` file for your pipeline
```yml
before_script:
- echo Hello!
# so that gitlab-runner container will send POST request for registration to correct domain job1:
GITLAB_CI_SERVER_URL=http://gitlab scripts:
``` - echo job1
```
3 - Open the `docker-compose.yml` file and add the following changes: 7. Push changes to gitlab
```yml 8. Verify that pipeline is run successful
gitlab-runner:
environment: # these values will be used during `gitlab-runner register`
- RUNNER_EXECUTOR=docker # change from shell (default)
- DOCKER_IMAGE=alpine
- DOCKER_NETWORK_MODE=laradock_backend
networks:
- backend # connect to network where gitlab service is connected
```
4 - Run the Gitlab-Runner Container (`gitlab-runner`) with the `docker-compose up` command. Example:
```bash
docker-compose up -d gitlab-runner
```
5 - Register the gitlab-runner to the gitlab container
```bash
docker-compose exec gitlab-runner bash
gitlab-runner register
```
6 - Create a `.gitlab-ci.yml` file for your pipeline
```yml
before_script:
- echo Hello!
job1:
scripts:
- echo job1
```
7 - Push changes to gitlab
8 - Verify that pipeline is run successful
@ -945,14 +876,11 @@ job1:
<br> <br>
<a name="Use-Adminer"></a> <a name="Use-Adminer"></a>
## Use Adminer ## Use Adminer
1. Run the Adminer Container (`adminer`) with the `docker-compose up` command. Example:
1 - Run the Adminer Container (`adminer`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d adminer
```bash ```
docker-compose up -d adminer 2. Open your browser and visit the localhost on port **8080**: `http://localhost:8080`
```
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](https://sourceforge.net/p/adminer/bugs-and-features/548/) 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](https://github.com/laradock/laradock/blob/master/adminer/Dockerfile#L1): `FROM adminer:latest` **Note:** We've locked Adminer to version 4.3.0 as at the time of writing [it contained a major bug](https://sourceforge.net/p/adminer/bugs-and-features/548/) 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](https://github.com/laradock/laradock/blob/master/adminer/Dockerfile#L1): `FROM adminer:latest`
@ -964,14 +892,11 @@ docker-compose up -d adminer
<br> <br>
<a name="Use-Portainer"></a> <a name="Use-Portainer"></a>
## Use Portainer ## Use Portainer
1. Run the Portainer Container (`portainer`) with the `docker-compose up` command. Example:
1 - Run the Portainer Container (`portainer`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d portainer
```bash ```
docker-compose up -d portainer 2. Open your browser and visit the localhost on port **9010**: `http://localhost:9010`
```
2 - Open your browser and visit the localhost on port **9010**: `http://localhost:9010`
@ -981,21 +906,14 @@ docker-compose up -d portainer
<br> <br>
<a name="Use-pgAdmin"></a> <a name="Use-pgAdmin"></a>
## Use PgAdmin ## Use PgAdmin
1. Run the pgAdmin Container (`pgadmin`) with the `docker-compose up` command. Example:
1 - Run the pgAdmin Container (`pgadmin`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d postgres pgadmin
```bash ```
docker-compose up -d postgres pgadmin 2. Open your browser and visit the localhost on port **5050**: `http://localhost:5050`
``` 3. At login page use default credentials:
Username : pgadmin4@pgadmin.org
2 - Open your browser and visit the localhost on port **5050**: `http://localhost:5050` Password : admin
3 - At login page use default credentials:
Username : pgadmin4@pgadmin.org
Password : admin
@ -1004,53 +922,38 @@ Password : admin
<br> <br>
<a name="Use-Beanstalkd"></a> <a name="Use-Beanstalkd"></a>
## Use Beanstalkd ## Use Beanstalkd
1. Run the Beanstalkd Container:
```bash
docker-compose up -d beanstalkd
```
2. Configure Laravel to connect to that container by editing the `config/queue.php` config file.
* first set `beanstalkd` as default queue driver
* set the queue host to beanstalkd : `QUEUE_HOST=beanstalkd`
*beanstalkd is now available on default port `11300`.*
3. Require the dependency package [pda/pheanstalk](https://github.com/pda/pheanstalk) using composer.
Optionally you can use the Beanstalkd Console Container to manage your Queues from a web interface.
* Run the Beanstalkd Console Container:
```bash
docker-compose up -d beanstalkd-console
```
* 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*._
1 - Run the Beanstalkd Container: * Add the server
- Host: beanstalkd
- Port: 11300
4. Done
```bash
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](https://github.com/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:
```bash
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.
<br> <br>
<a name="Use-Confluence"></a> <a name="Use-Confluence"></a>
## Use Confluence ## Use Confluence
1. Run the Confluence Container (`confluence`) with the `docker-compose up` command. Example:
1 - Run the Confluence Container (`confluence`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d confluence
```bash ```
docker-compose up -d confluence
```
2 - Open your browser and visit the localhost on port **8090**: `http://localhost:8090` 2 - Open your browser and visit the localhost on port **8090**: `http://localhost:8090`
@ -1073,18 +976,14 @@ docker-compose up -d elasticsearch
> The default username is `elastic` and the default password is `changeme`. > The default username is `elastic` and the default password is `changeme`.
### Install ElasticSearch Plugin ### Install ElasticSearch Plugin
1. Install an ElasticSearch plugin.
1 - Install an ElasticSearch plugin. ```bash
docker-compose exec elasticsearch /usr/share/elasticsearch/bin/plugin install {plugin-name}
```bash ```
docker-compose exec elasticsearch /usr/share/elasticsearch/bin/plugin install {plugin-name} 2. Restart elasticsearch container
``` ```bash
docker-compose restart elasticsearch
2 - Restart elasticsearch container ```
```bash
docker-compose restart elasticsearch
```
@ -1094,14 +993,11 @@ docker-compose restart elasticsearch
<br> <br>
<a name="Use-Selenium"></a> <a name="Use-Selenium"></a>
## Use Selenium ## Use Selenium
1. Run the Selenium Container (`selenium`) with the `docker-compose up` command. Example:
1 - Run the Selenium Container (`selenium`) with the `docker-compose up` command. Example: ```bash
docker-compose up -d selenium
```bash ```
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`
```
2 - Open your browser and visit the localhost on port **4444** at the following URL: `http://localhost:4444/wd/hub`
@ -1115,38 +1011,35 @@ docker-compose up -d selenium
The RethinkDB is an open-source Database for Real-time Web ([RethinkDB](https://rethinkdb.com/)). The RethinkDB is an open-source Database for Real-time Web ([RethinkDB](https://rethinkdb.com/)).
A package ([Laravel RethinkDB](https://github.com/duxet/laravel-rethinkdb)) is being developed and was released a version for Laravel 5.2 (experimental). A package ([Laravel RethinkDB](https://github.com/duxet/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. 1. Run the RethinkDB Container (`rethinkdb`) with the `docker-compose up` command.
```bash
docker-compose up -d rethinkdb
```
```bash 2. Access the RethinkDB Administration Console [http://localhost:8090/#tables](http://localhost:8090/#tables) for create a database called `database`.
docker-compose up -d rethinkdb
```
2 - Access the RethinkDB Administration Console [http://localhost:8090/#tables](http://localhost:8090/#tables) for create a database called `database`. 3. Add the RethinkDB configurations to the `config/database.php` configuration file:
```php
'connections' => [
3 - Add the RethinkDB configurations to the `config/database.php` configuration file: 'rethinkdb' => [
'name' => 'rethinkdb',
'driver' => 'rethinkdb',
'host' => env('DB_HOST', 'rethinkdb'),
'port' => env('DB_PORT', 28015),
'database' => env('DB_DATABASE', 'test'),
]
```php // ...
'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`.
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`.
#### Additional Notes #### Additional Notes
@ -1157,32 +1050,26 @@ docker-compose up -d rethinkdb
<br> <br>
<a name="Use-Minio"></a> <a name="Use-Minio"></a>
## Use Minio ## Use Minio
1. Configure Minio:
1 - Configure Minio: - On the workspace container, change `INSTALL_MC` to true to get the client
- 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
- 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:
```bash
2 - Run the Minio Container (`minio`) with the `docker-compose up` command. Example: docker-compose up -d minio
```
```bash 3. Open your browser and visit the localhost on port **9000** at the following URL: `http://localhost:9000`
docker-compose up -d minio 4. Create a bucket either through the webui or using the mc client:
``` ```bash
mc mb minio/bucket
3 - Open your browser and visit the localhost on port **9000** at the following URL: `http://localhost:9000` ```
5. When configuring your other clients use the following details:
4 - Create a bucket either through the webui or using the mc client: ```
```bash S3_HOST=http://minio
mc mb minio/bucket S3_KEY=access
``` S3_SECRET=secretkey
S3_REGION=us-east-1
5 - When configuring your other clients use the following details: S3_BUCKET=bucket
``` ```
S3_HOST=http://minio
S3_KEY=access
S3_SECRET=secretkey
S3_REGION=us-east-1
S3_BUCKET=bucket
```