https://github.com/rinminase/laravel-docker-template
📦🐞 An extremely simple and lightweight Laravel Docker Template
https://github.com/rinminase/laravel-docker-template
alpine-linux docker laravel nginx postgresql template
Last synced: 3 months ago
JSON representation
📦🐞 An extremely simple and lightweight Laravel Docker Template
- Host: GitHub
- URL: https://github.com/rinminase/laravel-docker-template
- Owner: RinMinase
- Created: 2023-05-25T12:52:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2026-03-25T10:30:09.000Z (3 months ago)
- Last Synced: 2026-03-26T13:14:55.283Z (3 months ago)
- Topics: alpine-linux, docker, laravel, nginx, postgresql, template
- Language: Blade
- Homepage:
- Size: 353 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Introduction / Motivation of this project
I'm sick of other extremely complicated and lengthy guides and tutorials on how to create a Dockerized Laravel (see [here](https://www.cloudsigma.com/deploying-laravel-nginx-and-mysql-with-docker-compose/), [here](https://www.digitalocean.com/community/tutorials/how-to-install-and-set-up-laravel-with-docker-compose-on-ubuntu-22-04), [here](https://blog.logrocket.com/how-to-run-laravel-docker-compose-ubuntu-v22-04/) and [here](https://www.twilio.com/blog/get-started-docker-laravel)), so I created one myself. Using this is as simple as cloning or downloading the whole template then running `docker-compose up -d`, setup can be finished in more-or-less 5-10 minutes.
## Using the template
### Using Git template
1. Click `Use this template` then `Create a new repository`
2. Clone your newly created repository
3. Copy the env file by running `cp .env.example .env`
4. Create and run the docker containers by `docker-compose up -d`
5. Navigate in the created container `docker exec -it php sh`
6. Run the commands below to start your Laravel application
```
composer install
php artisan key:generate
php artisan migrate:fresh --seed
```
### Using Git clone
1. Clone the repository by running `git clone git@github.com:RinMinase/laravel-docker-template.git`
2. Remove instances of the original repository on your project
- Open your terminal and run these commands below:
- `git remote remove origin`
- `rm -rf .git/`
- `git init`
3. Copy the env file by running `cp .env.example .env`
4. Create and run the docker containers by `docker-compose up -d`
5. Navigate in the created container `docker exec -it php sh`
6. Run the commands below to start your Laravel application
```
composer install
php artisan key:generate
php artisan migrate:fresh --seed
```
### Downloading the repository
1. Download the repository as a zip file
2. Copy the env file by running `cp .env.example .env`
3. Create and run the docker containers by `docker-compose up -d`
5. Navigate in the created container `docker exec -it php sh`
6. Run the commands below to start your Laravel application
```
composer install
php artisan key:generate
php artisan migrate:fresh --seed
```
## Default Values
This project contains 3 docker containers, all of which uses the official docker images in Alpine linux
- `php` (which houses your source code)
- container name: `php`
- `nginx` (which houses the webserver that runs your code in a browser)
- container name: `webserver`
- `db` (which contains the database of your project)
- container name: `database`
- by default this uses [PostgreSQL](https://www.postgresql.org/), but feel free to change it to your desired database
The database by default uses these default parameters to let you get started without even touching any configuration settings
- `DB_DATABASE` or your default database name: `laravel`
- `DB_USERNAME` or your default database username: `postgres`
- `DB_PASSWORD` or your default database password: `postgres`
### Job / Commands / Schedule updates and restarting the supervisor
[Return to the table of contents](#table-of-contents)
In cases there are any updates to:
- Jobs (found on `app/Jobs`)
- Commands (found on `app/Commands`)
- Schedules (found on `bootstrap/app.php` under `withSchedule`)
Please run the following:
1. Navigate inside the `php` docker container [[how]](#re-running-the-project)
2. Run the command to restart the group (`queue-worker` and `schedule-worker`)
```bash
supervisorctl restart worker:
```
### Managing the supervisor
[Return to the table of contents](#table-of-contents)
This application runs supervisor on the `php` container. Supervisor runs these tasks:
| Task Name | Group | Command | Description |
| --------------- | ------- | --------------------------- | ------------------------------ |
| php-fpm | - | `php-fpm` | Runs FastCGI Process Manager |
| queue-worker | worker | `php artisan queue:work` | Runs Laravel's Queue worker |
| schedule-worker | worker | `php artisan schedule:work` | Runs Laravel's Schedule worker |
To manage the supervisor the commands below can be used:
| Command | Description |
| --------------------------------- | ---------------------------------------------- |
| supervisorctl reread | Re-reads changes in supervisor config files |
| supervisorctl update | Updates supervisor with changes after `reread` |
| supervisorctl status | Check status of all running tasks |
| supervisorctl start | Starts the task |
| supervisorctl stop | Stops the task |
| supervisorctl restart | Restarts the task |
**Please note:** Supervisor logs are kept in `./docker/logs/supervisor.log`
## FAQ
### How to update PHP / caddy / PostgreSQL?
- Updating `PHP`
- Modify the version text under `docker-compose.yml` under `services : php : build : args`, `PHP_VERSION`
- Example here: https://github.com/RinMinase/laravel-docker-template/blob/15c9c74cb13e085fd0db2efa83bf9986fded29c5/docker-compose.yml#L15
- You can find the php versions possible [here](https://hub.docker.com/_/php/tags?page=1&name=fpm-alpine)
- Updating `caddy`
- Modify the version text under `docker-compose.yml` under `services : caddy : image`, and change the version of the image name
- Example here: https://github.com/RinMinase/laravel-docker-template/blob/15c9c74cb13e085fd0db2efa83bf9986fded29c5/docker-compose.yml#L328
- You can find the caddy versions possible [here](https://hub.docker.com/_/caddy/tags?name=alpine)
- Updating `db`
- Modify the version text under `docker-compose.yml` under `services : db : image`, and change the version of the image name
- Example here: https://github.com/RinMinase/laravel-docker-template/blob/15c9c74cb13e085fd0db2efa83bf9986fded29c5/docker-compose.yml#L65
- You can find the postgres versions possible [here](https://hub.docker.com/_/postgres/tags?page=1&name=-alpine)
### Why use official images?
Other tutorials or guides uses customized images (see [here for the guide](https://www.digitalocean.com/community/tutorials/how-to-install-and-set-up-laravel-with-docker-compose-on-ubuntu-22-04) -- actual [line of code](https://github.com/do-community/travellist-laravel-demo/blob/cb9abd07cb6e8fb46d12c0f9cd650f3a6b976307/docker-compose.yml#L10)), these images are so hard to update manually compared to just editing a value then rebuilding the whole container again, see the question above on how to update each docker container.
### Why use alpine linux?
Alpine linux is very lightweight and secure enough. Since the image used is lightweight, you can quickly download it compared to fully-fledged linux distros such as Ubuntu. (Some references for these: [here](https://nickjanetakis.com/blog/the-3-biggest-wins-when-using-alpine-as-a-base-docker-image) and [here](https://sysdig.com/learn-cloud-native/container-security/what-is-docker-alpine/)).
Nonetheless, it also has its downsides, (references [here](https://dev.to/kakisoft/dockeralpine-why-you-should-avoid-alpine-linux-44he) and [here](https://www.linkedin.com/pulse/musl-libc-alpines-greatest-weakness-rogan-lynch)) I've even encountered a few of them, these are:
- using other package managers aside from `apk`
- some libraries which you may possibly use are not present such as `glibc` since alpine uses `musl-libc` and requires a [sad and annoying workaround](https://stackoverflow.com/a/37835009) for it to work
### Why use (or migrated) to caddy instead of nginx?
Caddy is often preferred over Nginx for its simplicity and modern design. Unlike Nginx, Caddy automatically handles HTTPS with free TLS certificates via Let’s Encrypt, removing the need for manual certificate setup or cron jobs (although this is not used in this repository as it was deemed unnecessary).
Additionally, its configuration syntax is way cleaner and extremely easier to understand, making it ideal for quick deployments and maintainable setups.
Regardless, if you do prefer nginx, please refer to the previous setup under this commit:
- https://github.com/RinMinase/laravel-docker-template/tree/258923b0dc2e5fef9f6337954fcebafb59661d2c
The files needed for it is likewise under `./docker/nginx-backup/*` for the time being. The docker-compose setup is likewise commented as well for now.
### Why use static versions for docker containers?
Why not? A variable version might mean that it works on my machine but not on yours because yours has a different (possibly newer) version than mine (references [here](https://nickjanetakis.com/blog/docker-tip-18-please-pin-your-docker-image-versions) and [here](https://docs.gradle.org/current/userguide/dependency_locking.html)).