Options #

There are several ways you can configure how DockR runs your project.

Configuration #

Whenever you start a project, Asset containers (Proxy, MySQL, Postgres and Redis) will run along with your project container.
Many of you might not use mysql, postgres or redis in your day-to-day workflow (including me). And that consumes your system memory.
You might also terminate the unnecessary containers after you start the project. But we don't want you to do that.
So, We have added an option to enable or disable any of them so that you don't have to run unnecessary containers. By disabling the asset containers, they won't start when you run dockr up command to start your project.

Available configuration commands are :

dockr config enable <asset>     # Enable the specified Asst container
dockr config disable <asset>    # Disable the specified Asset container
dockr config get <asset>        # Get the status of the specified Asset container.
dockr config list               # List all the configurations values.

Example :

dockr config enable mysql
dockr config disable postgres
dockr config get redis
dockr config list

Available ENV variables #

Detailed Explanation #

DOCKR_SITE #

This will be used to proxy the incoming request to the project container.
The proxy container redirects all the incoming traffic with the specified site to the project container.

This value is required. If it wasn't specified, DockR will throw an error and stops execution.

Example :

DOCKR_SITE=dockr.test
DOCKR_SITE=*.dockr.test

DOCKR_PHP_VERSION #

Specify the PHP Version that should be used for your project.
This variable is optional. If no value is specified for this variable, It will default to version 8.0.

Example :

DOCKR_PHP_VERSION=8.0
DOCKR_PHP_VERSION=7.4

DOCKR_DOCKER_IMAGE #

You can choose which container to run for your project.
For Example: You might need some extensions that may not be available in our Docker Image. In that case, you can build an of your own choice and use them with DockR.

Example :

DOCKR_DOCKER_IMAGE=dockr-project:testing

You can use both images from local and images from remote repository. This will be handled as per the Docker image search feature.

DOCKR_CONTAINER_NAME #

Used to specify a custom name for the container used for the project.
By default, Project's directory name will be used as the container name.

You can also use your own custom name for the container.

Example :

DOCKR_CONTAINER_NAME=dockr_container

DOCKR_SKIP_DB_CHECK #

Whenever you start your project, DockR Starts the Asset containers(Proxy, 'MySQL, Postgres and Redis) based on your configuration, and then checks for the database existence in the respective Database Connection.

If you don't want DockR to check and create a DB (if it doesn't exist), then You will have to specify this variable. This will prevent the DockR to check and create the Database.

Example :

DOCKR_SKIP_DB_CHECK=0
DOCKR_SKIP_DB_CHECK=1

DOCKR_SKIP_ASSET #

During the up command, DockR will check and starts the Asset containers such as Proxy, MySQL, Postgres and Redis.
There might be projects where you don't need to start any of the asset containers. In that case, You simply use this variable to disable the starting of the asset containers.

When you are skipping the Asset containers, then there will be no containers to check and create Database.
So, when you are using DOCKR_SKIP_ASSET, DOCKR_SKIP_DB_CHECK will also be set automatically.

Example :

DOCKR_SKIP_ASSET=0
DOCKR_SKIP_ASSET=1

DOCKR_WORKER #

If you are working with Queues, Schedules and Jobs, then you might need a worker to test the changes on the go.

So, we have added a worker to the project. When using DOCKR_WORKER, DockR will create another container (worker) within the same group as the project container.

The Worker container will run the following commands with a typical worker configurations.

php artisan schedule:run

php artisan queue:listen

Example :

DOCKR_WORKER=0
DOCKR_WORKER=1

DOCKR_COMPOSER_VERSION #

There may always be a situation where we may work on old projects, Old projects might use different Composer version which may break when used with the latest composer version.

To overcome this, We have added an option to use composer with older versions.

When the value isn't set, then 2.2.0 will be used. When used with 1 as the value, Composer with version 1.8.6 will be used.
Only these versions are available currently.

Example :

DOCKR_COMPOSER_VERSION=1
DOCKR_COMPOSER_VERSION=2

DOCKR_OVERRIDE_ASSET_CONFIG #

We have given an option to set the default behaviour of the asset containers whether to start or not to at the time of project starting-up.
When you have set postgres to disabled state and one project has to run the same, you can simply override the asset config values set.

Or, you may need to start multiple asset containers which aren't set to start in config, In that case, you will just need to provide all the asset containers that are need to be started with the project seperated by comma(,).

Example :

DOCKR_OVERRIDE_ASSET_CONFIG=postgres
DOCKR_OVERRIDE_ASSET_CONFIG=mysql,postgres,redis

DOCKR_ADD_COMPOSE_FILE (Experimental) #

We have provided an option to combine additional dockr-compose file with the default one.

Example :

version: "3.7"
services:
  web:
    volumes:
      - ~/Downloads/dockr-test:/var/www/test
    environment:
      - TEST_VARIABLE_1=test_value_1
      - TEST_VARIABLE_2=test_value_2
    labels:
      - TESTING=true
      - PRODUCTION=false