Compare commits

...

2 Commits

Author SHA1 Message Date
16e98b5663 feat: add db recreation target and update Laravel setup docs 2025-12-14 23:17:23 +03:00
2c86eda6be refactor: restructure environment 2025-12-14 23:14:28 +03:00
12 changed files with 252 additions and 151 deletions

View File

@@ -1,3 +1,3 @@
* *
!docker/docker-entrypoint.sh !docker/entrypoint.sh
!docker/php-fpm.conf !docker/php-fpm.conf

21
.editorconfig Normal file
View File

@@ -0,0 +1,21 @@
root = true
[*]
charset = utf-8
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true
[*.md]
trim_trailing_whitespace = false
[*.{yml,yaml}]
indent_size = 2
[*.sh]
indent_size = 2
[Makefile]
indent_style = tab

View File

@@ -6,10 +6,5 @@ DB_USERNAME=laravel
DB_PASSWORD=secret DB_PASSWORD=secret
DB_ROOT_PASSWORD=secret DB_ROOT_PASSWORD=secret
# Docker
PHP_VERSION=8.3-fpm
IMAGE_NAME=dev-pj1-laravel
IMAGE_TAG=${PHP_VERSION}
APP_UID=1000 APP_UID=1000
APP_GID=1000 APP_GID=1000

46
.gitignore vendored
View File

@@ -1,4 +1,47 @@
# Environment files
.env
.env.backup
.env.production
auth.json
Homestead.yaml
Homestead.json
# Vendor / dependencies
/vendor
/composer/
.composer-hash
# Laravel storage and cache
/storage/*.key
/storage/pail
/storage/framework/*
!/storage/framework/.gitignore
/storage/logs/*
!/storage/logs/.gitignore
/public/storage
# Build artifacts
/public/build
/public/hot
/bootstrap/cache/*
!/bootstrap/cache/.gitignore
# Testing / cache
.phpunit.result.cache
/.phpunit.cache /.phpunit.cache
# Editor / IDE
/.idea
/.vscode
.phpactor.json
.scribe/
.scribe-hash
# System / logs
*.log
.DS_Store
Thumbs.db
.bash_history
/bootstrap/ssr /bootstrap/ssr
/node_modules /node_modules
/public/build /public/build
@@ -26,3 +69,6 @@ yarn-error.log
/.nova /.nova
/.vscode /.vscode
/.zed /.zed
.composer-hash
.scribe-hash

61
Makefile Normal file
View File

@@ -0,0 +1,61 @@
-include .env
APP_UID ?= 1000
APP_GID ?= 1000
IMAGE_NAME := laravel-setup-php-fpm
IMAGE_TAG := latest
IMAGE := $(IMAGE_NAME):$(IMAGE_TAG)
TAR_FILE := $(IMAGE_NAME)_$(IMAGE_TAG).tar.gz
.PHONY: help build load shell docs db
help:
@echo "Usage:"
@echo " make <target> [SOURCE=...]"
@echo ""
@echo "Targets:"
@echo " build Build Docker image and save to archive"
@echo " load Load Docker image from archive, URL, or build if missing"
@echo " Optional: SOURCE=url_or_file"
@echo " shell Enter php-fpm container as www"
@echo " docs Regenerate API documentation"
@echo " db Recreate DB"
build:
@echo "Building image..."
docker build -f docker/Dockerfile --build-arg UID=$(APP_UID) --build-arg GID=$(APP_GID) -t $(IMAGE) .
@echo "Saving image to $(TAR_FILE)..."
docker save $(IMAGE) | gzip > $(TAR_FILE)
load:
ifdef SOURCE
@if echo "$(SOURCE)" | grep -qE '^https?://'; then \
echo "Downloading and loading image from $(SOURCE)..."; \
curl -L "$(SOURCE)" -o $(TAR_FILE); \
docker load < $(TAR_FILE); \
else \
echo "Loading image from file $(SOURCE)..."; \
docker load < $(SOURCE); \
fi
else
@if [ -f "$(TAR_FILE)" ]; then \
echo "Loading image from archive $(TAR_FILE)..."; \
docker load < $(TAR_FILE); \
else \
echo "No archive found; building image..."; \
docker build -f docker/Dockerfile --build-arg UID=$(APP_UID) --build-arg GID=$(APP_GID) -t $(IMAGE) .; \
fi
endif
shell:
@echo "Entering php-fpm container as www..."
docker compose exec --user www php-fpm bash
docs:
@echo "Regenerating API documentation..."
docker compose exec --user www php-fpm php artisan scribe:generate
db:
@echo "Recreate DB..."
docker compose exec --user www php-fpm bash -c "php artisan migrate:fresh && php artisan db:seed"

View File

@@ -1,24 +1,47 @@
# Laravel Docker Setup # Laravel Docker Setup
- NGINX, MySQL, phpMyAdmin - PHP-FPM, NGINX, MySQL, phpMyAdmin (in `compose.yaml`)
## Создание проекта: ## Create a project:
```bash ```bash
cp .env.example .env cp .env.example .env
# !change .env for yourself # !change .env for yourself
./run.sh build
docker compose up -d php-fpm docker compose up -d php-fpm
docker compose exec php-fpm bash docker compose exec php-fpm bash
# or `make shell`
``` ```
```bash **_Rewrite below for yourself:_**
composer global require laravel/installer
*RECOMENDED:*
**The latest version** via [laravel/installer package](https://packagist.org/packages/laravel/installer)
```bash
composer global require laravel/installer && \
export PATH="$HOME/.composer/vendor/bin:$PATH" export PATH="$HOME/.composer/vendor/bin:$PATH"
# Check options via `laravel new -h`
laravel new example-app laravel new example-app
mv example-app/* example-app/.* ./ mv example-app/* example-app/.* ./
rmdir example-app rmdir example-app
``` ```
*OR:*
**The specific version** via composer
```bash
composer create-project --prefer-dist laravel/laravel example-app ^11.0
mv example-app/* example-app/.* ./
rmdir example-app
```
## Quick Actions
```bash
make help
```

View File

@@ -1,3 +1,5 @@
name: laravel-setup
services: services:
web: web:
image: nginx:latest image: nginx:latest
@@ -13,15 +15,17 @@ services:
condition: service_started condition: service_started
php-fpm: php-fpm:
image: "${IMAGE_NAME}:${IMAGE_TAG}" build:
user: "${APP_UID}:${APP_GID}" context: .
dockerfile: docker/Dockerfile
args:
UID: ${APP_UID}
GID: ${APP_GID}
env_file: env_file:
- .env - .env
volumes: volumes:
- ./:/var/www - ./:/var/www
depends_on:
mysql:
condition: service_started
mysql: mysql:
image: mysql:8.0 image: mysql:8.0
@@ -33,7 +37,8 @@ services:
- MYSQL_PASSWORD=${DB_PASSWORD} - MYSQL_PASSWORD=${DB_PASSWORD}
- MYSQL_ROOT_PASSWORD=${DB_ROOT_PASSWORD} - MYSQL_ROOT_PASSWORD=${DB_ROOT_PASSWORD}
volumes: volumes:
- mysql-data:/var/lib/mysql - mysql-data-development:/var/lib/mysql
phpmyadmin: phpmyadmin:
image: phpmyadmin:latest image: phpmyadmin:latest
@@ -49,4 +54,4 @@ services:
condition: service_started condition: service_started
volumes: volumes:
mysql-data: mysql-data-development:

View File

@@ -1,23 +1,35 @@
ARG PHP_VERSION=8.3-fpm FROM php:8.3-fpm
FROM php:${PHP_VERSION}
RUN apt-get update && apt-get install -y --no-install-recommends \ RUN apt-get update && apt-get install -y --no-install-recommends \
libpng-dev libonig-dev libxml2-dev libzip-dev \ libpng-dev libonig-dev libxml2-dev libzip-dev \
zip unzip git \ zip unzip git gosu \
netcat-traditional \ netcat-traditional \
&& docker-php-ext-install pdo_mysql mbstring exif pcntl bcmath gd zip \ && docker-php-ext-install pdo_mysql mbstring exif pcntl bcmath gd zip \
&& apt-get clean && rm -rf /var/lib/apt/lists/* && apt-get clean && rm -rf /var/lib/apt/lists/*
COPY --from=composer:latest /usr/bin/composer /usr/bin/composer COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
COPY --chown=www-data:www-data ./docker/docker-entrypoint.sh /usr/local/bin/ ARG UID
COPY ./docker/php-fpm.conf /usr/local/etc/php-fpm.d/zz-docker.conf ARG GID
RUN chmod +x /usr/local/bin/docker-entrypoint.sh # Create a new user with the specified UID and GID, reusing an existing group if GID exists
RUN if getent group ${GID}; then \
group_name=$(getent group ${GID} | cut -d: -f1); \
useradd -m -u ${UID} -g ${GID} -s /bin/bash www; \
else \
groupadd -g ${GID} www && \
useradd -m -u ${UID} -g www -s /bin/bash www; \
group_name=www; \
fi
# Update php-fpm to use the new user and group
RUN sed -i "s/user = www-data/user = www/g" /usr/local/etc/php-fpm.d/www.conf && \
sed -i "s/group = www-data/group = $group_name/g" /usr/local/etc/php-fpm.d/www.conf
COPY ./docker/entrypoint.sh /usr/local/bin/
RUN chmod +x /usr/local/bin/entrypoint.sh
USER www-data
WORKDIR /var/www WORKDIR /var/www
EXPOSE 9000 EXPOSE 9000
ENTRYPOINT ["docker-entrypoint.sh"] ENTRYPOINT ["entrypoint.sh"]
CMD ["php-fpm"] CMD ["php-fpm"]

View File

@@ -1,52 +0,0 @@
#!/bin/sh
set -e
APP_ENV=${APP_ENV:-unknown}
echo ">> Running in $APP_ENV mode"
# Only for Laravel project
if [ -f "artisan" ]; then
echo ">> Ensuring composer dependencies are up to date..."
if [ "$APP_ENV" = "production" ]; then
composer install --no-dev --optimize-autoloader
else
composer install --optimize-autoloader
fi
if [ -f ".env" ] && grep -q '^APP_KEY=$' .env; then
echo ">> Generating application key..."
php artisan key:generate --ansi
fi
echo ">> Waiting for MySQL..."
while ! nc -z mysql 3306; do sleep 1; done
echo ">> Running migrations..."
php artisan migrate --force || true
if [ ! -L "public/storage" ] && [ -d "storage/app/public" ]; then
echo ">> Creating storage link..."
php artisan storage:link
fi
if [ "$APP_ENV" = "local" ]; then
echo ">> Running seeders..."
php artisan db:seed --force || true
if composer show knuckleswtf/scribe > /dev/null 2>&1; then
echo ">> Generating API documentation..."
php artisan scribe:generate --no-interaction || echo ">> Documentation generation failed, continuing..."
else
echo ">> Scribe not installed, skipping documentation generation"
fi
fi
if [ "$APP_ENV" = "production" ]; then
php artisan optimize
fi
else
echo ">> Not a Laravel project"
fi
exec "$@"

62
docker/entrypoint.sh Executable file
View File

@@ -0,0 +1,62 @@
#!/bin/sh
set -e
echo ">> Running dev setup..."
# Only for Laravel project
if [ ! -f "artisan" ]; then
echo ">> Not a Laravel project"
exec "$@"
fi
gosu www mkdir -p .hashes
if [ ! -f .hashes/.composer-hash ] || ! sha1sum -c .hashes/.composer-hash; then
echo ">> composer.json or composer.lock changed, installing dependencies..."
gosu www composer install --optimize-autoloader --no-interaction
gosu www sha1sum composer.json composer.lock > .hashes/.composer-hash
chown www: .hashes/.composer-hash
else
echo ">> Composer dependencies up to date (hash match), skipping install."
fi
if [ -f ".env" ] && grep -q '^APP_KEY=$' .env; then
echo ">> Generating application key..."
gosu www php artisan key:generate --ansi
fi
echo ">> Waiting for MySQL..."
while ! nc -z mysql 3306; do sleep 1; done
echo ">> Running migrations..."
gosu www php artisan migrate --force
if [ ! -L "public/storage" ] && [ -d "storage/app/public" ]; then
echo ">> Creating storage link..."
gosu www php artisan storage:link
fi
echo ">> Running seeders..."
gosu www php artisan db:seed --force
if composer show knuckleswtf/scribe >/dev/null 2>&1; then
# Define all directories/files Scribe cares about
SCRIBE_SOURCES="config/scribe.php routes/ app/Http/Controllers/ app/Http/Requests/ app/Models/"
# Create combined hash of all .php files in those paths
CURRENT_HASH=$(find $SCRIBE_SOURCES -type f -name "*.php" -exec sha1sum {} + | sha1sum)
if [ ! -f .hashes/.scribe-hash ] || [ "$CURRENT_HASH" != "$(cat .hashes/.scribe-hash)" ]; then
echo ">> Generating API documentation..."
gosu www php artisan scribe:generate --no-interaction \
|| echo ">> Warning: Scribe generation failed, continuing..."
echo "$CURRENT_HASH" > .hashes/.scribe-hash
chown www: .hashes/.scribe-hash
else
echo ">> API docs up to date, skipping Scribe generation."
fi
else
echo ">> Scribe not installed, skipping API docs generation"
fi
exec "$@"

View File

@@ -1,10 +0,0 @@
[global]
daemonize = no
[www]
listen = 9000
pm = dynamic
pm.max_children = 5
pm.start_servers = 2
pm.min_spare_servers = 1
pm.max_spare_servers = 3

62
run.sh
View File

@@ -1,62 +0,0 @@
#!/bin/bash
set -euo pipefail
# Help
if [[ $# -eq 0 ]]; then
echo "Usage: $0 {build|load} [source]"
echo " build - Build image and save archive"
echo " load [source] - Load image from:"
echo " (no arg) - Use archive or build from source"
echo " URL - download from URL then load"
echo " file - load from specified file via docker load command"
echo ""
echo "Archive location: \${IMAGE_NAME}_\$IMAGE_TAG.tar.gz in current directory"
exit 0
fi
# Load config
[[ ! -f .env ]] && cp .env.example .env
source .env
# Validate
if [[ -z "${IMAGE_NAME:-}" ]] || [[ -z "${IMAGE_TAG:-}" ]] || [[ -z "${PHP_VERSION:-}" ]]; then
echo "Error: IMAGE_NAME or IMAGE_TAG or PHP_VERSION not set in .env"
echo "Please add to .env (check vars in .env.example):"
echo "PHP_VERSION=8.3-fpm # Used in Dockerfile"
echo "IMAGE_NAME=your-image-name"
echo "IMAGE_TAG=\${PHP_VERSION} # Or custom tag"
exit 1
fi
IMAGE="$IMAGE_NAME:$IMAGE_TAG"
TAR_FILE="${IMAGE_NAME}_$IMAGE_TAG.tar.gz"
ACTION="${1:-}"
SOURCE="${2:-}"
case "$ACTION" in
build)
docker build -f docker/Dockerfile --build-arg PHP_VERSION=$PHP_VERSION -t "$IMAGE" .
docker save "$IMAGE" | gzip > "$TAR_FILE"
;;
load)
if [[ -f "$TAR_FILE" ]]; then
docker load < "$TAR_FILE"
elif [[ -n "$SOURCE" ]]; then
if [[ "$SOURCE" =~ ^https?:// ]]; then
curl -L "$SOURCE" -o "$TAR_FILE"
docker load < "$TAR_FILE"
else
# Handle local file path
docker load < "$SOURCE"
fi
else
docker build -f docker/Dockerfile --build-arg PHP_VERSION=$PHP_VERSION -t "$IMAGE" .
fi
;;
*)
echo "Error: Unknown action '$ACTION'"
echo "Usage: $0 {build|load} [source]"
exit 1
;;
esac