https://github.com/alizaynoune/laravel-docker-devenv

A lightweight Dockerized environment for efficient Laravel development. This setup includes PHP, Nginx, MySQL, and Redis, all orchestrated using Docker Compose for quick and easy configuration. It supports multiple PHP versions, employs Supervisor for managing long-running processes, and is optimized for seamless local development.
https://github.com/alizaynoune/laravel-docker-devenv

docker docker-compose docker-nginx docker-nginx-php environment-setup laravel laravel-docker laravel-docker-template laravel-dockerize local-development web-development

Last synced: about 2 months ago
JSON representation

A lightweight Dockerized environment for efficient Laravel development. This setup includes PHP, Nginx, MySQL, and Redis, all orchestrated using Docker Compose for quick and easy configuration. It supports multiple PHP versions, employs Supervisor for managing long-running processes, and is optimized for seamless local development.

• Host: GitHub
• URL: https://github.com/alizaynoune/laravel-docker-devenv
• Owner: alizaynoune
• License: mit
• Created: 2024-09-16T20:57:11.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2025-01-23T12:07:13.000Z (4 months ago)
• Last Synced: 2025-02-11T08:48:46.764Z (4 months ago)
• Topics: docker, docker-compose, docker-nginx, docker-nginx-php, environment-setup, laravel, laravel-docker, laravel-docker-template, laravel-dockerize, local-development, web-development
• Language: Shell
• Homepage:
• Size: 31.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel Docker Development Environment

This project sets up a Dockerized PHP development environment with multiple PHP versions, Redis, and MySQL, all managed through docker-compose and environment variables. It's designed to streamline Laravel development by providing a flexible, scalable, and easy-to-use setup.

## Features

- **Multiple PHP Versions:** Easily switch between PHP versions for different projects.

- **MySQL and Redis:** Pre-configured services to support database and caching requirements.

- **Supervisor Support:** Automatically manage long-running processes like Laravel WebSockets.

- **SSH Access:** Secure access to containers for development and debugging.

- **Nginx Support:** Configured for serving Laravel applications.

## Services

- **PHP:** Multiple PHP versions (7.4, 8.0, 8.1) with Composer and Xdebug.

- **Nginx:** Web server for serving Laravel applications.

- **MySQL:** Database service for storing application data.

- **Redis:** In-memory data structure store for caching.

- **workspace:** Container for running Composer and Artisan commands.

## Prerequisites

- Docker

- Docker Compose

- Make

- `yq` (for parsing YAML files)

## Setup

1. **Clone the repository:**

    ```sh

    git clone https://github.com/alizaynoune/Laravel-Docker-DevEnv.git

    cd Laravel-Docker-DevEnv

    ```

2. **Create and configure the `.env` file:**

    Copy the `.env.example` to `.env` and adjust the variables as needed.

    ```sh

    cp env.example .env

    ```

3. **Add your sites to the `sitesMap.yaml` file:**

    Copy the `sitesMap.example.yaml` to `sitesMap.yaml` and adjust the entries as needed.

    ```sh

    cp sitesMap.example.yaml sitesMap.yaml

    ```

    Example entry in `sitesMap.yaml`:

    ```yaml

    - map: example.local

      to: example-app/public

      php: "8.0"

   ```

4. **Build and start the containers:**

    ```sh

    make up

    ```

## Configuration

### Environment Variables

The `.env` file contains the following variables:

- **User Configuration:**

  - `USER_NAME` (the user name for the container)

  - `USER_PASSWORD` (the user password for the container)

  - `USER_UID` (the user ID for the container)

  - `USER_GID` (the user group ID for the container)

  - `ROOT_PASSWORD`

- **MySQL Configuration:**

  - `MYSQL_ROOT_PASSWORD` (the root password for MySQL)

  - `MYSQL_DATABASE` (the default database name)

  - `MYSQL_USERNAME` (the default username)

  - `MYSQL_PASSWORD` (the default password)

- **Redis Configuration:**

  - `REDIS_ARGS` (additional arguments for the Redis service)

- **Directories:**

  - `APP_DIR` (the application directory)

  - `DESTINATION_DIR` (the destination directory in the container)

  - `REDIS_DATA_DIR` (the Redis data directory)

  - `MYSQL_DATA_DIR` (the MySQL data directory)

- **Default PHP Version:**

  - `DEFAULT_PHP` (the default PHP version for the workspace container)

### Docker Compose Files

- `docker-compose.yml`: Main Docker Compose configuration.

- `docker-compose.override.yml`: This is where the PHP services are defined. (auto-generated), do not edit this file.

### PHP Services

The PHP services are configured based on the `sitesMap.yaml` file. Each site can specify a different PHP version.

Example entry in `sitesMap.yaml`:

```yaml

- map: example.local

  to: example-app/public

  php: "8.0"

```

## Usage

- **Make Commands:**

    - `make up`: Build and start the containers.

    - `make down`: Stop and remove the containers.

    - `make restart`: Restart the containers.

    - `make logs`: Show the container logs.

    - `make exec`: Execute a command in the workspace container.

- **Workspace Container:**

    The workspace container is used for running Composer and Artisan commands.

    ```sh

    make exec workspace

    ```

   - **Run Commands:**

        ```sh

        composer install

        php artisan migrate

        php artisan db:seed

        ```

   - **Change PHP Version:**

        ```sh

        php 80 # Switch to PHP 8.0

        ```