github/torrentpier
1
0
Fork 0
mirror of https://github.com/torrentpier/torrentpier synced 2025-08-22 14:23:57 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

feat(docker): add Docker support with configuration files and environment setup

Browse source 
- Introduced .dockerignore to exclude unnecessary files from Docker context.
- Added docker-compose.yml for defining services including MySQL, Redis, Meilisearch, Mailpit, and MinIO.
- Created .env.sail.example for Sail-specific environment variables, enhancing local development setup.
- Updated .env.example to include AWS_ENDPOINT for S3 compatibility.
- Bumped laravel/sail version in composer.json to ^1.43 for improved functionality.
- Added comprehensive documentation for Laravel Sail development in docs/docs/development/sail.md.

These changes aim to streamline the development process using Docker and Laravel Sail, providing a robust local environment for the TorrentPier application.
This commit is contained in:
Yury Pikhtarev 2025-07-09 17:25:54 +02:00
commit 13ea4f8bb1
No known key found for this signature in database
7 changed files with 802 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

68
.dockerignore Normal file
View file

@ -0,0 +1,68 @@
# Git
.git
.gitignore
.gitattributes
# CI
.github
.gitlab-ci.yml
.travis.yml
# Docker
docker-compose.yml
docker-compose.*.yml
Dockerfile*
.dockerignore
# IDE
.claude
.idea
.vscode
*.swp
*.swo
*~
# OS
.DS_Store
Thumbs.db
# Laravel
/node_modules
/public/build
/public/hot
/public/storage
/storage/*.key
/storage/pail
/vendor
.env
.env.*
!.env.example
!.env.sail.example
.phpunit.result.cache
Homestead.json
Homestead.yaml
auth.json
# Logs
npm-debug.log
yarn-error.log
*.log
# Testing
.phpunit.cache
/coverage
.pest
# Docs
/docs
# Legacy
/legacy
# Misc
.editorconfig
README.md
LICENSE
CLAUDE.local.md
phpunit.xml
webpack.mix.js

1
.env.example
View file

@ -67,6 +67,7 @@ AWS_ACCESS_KEY_ID=
AWS_SECRET_ACCESS_KEY=
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=
AWS_ENDPOINT=
AWS_USE_PATH_STYLE_ENDPOINT=false
VITE_APP_NAME="${APP_NAME}"

93
.env.sail.example Normal file
View file

@ -0,0 +1,93 @@
APP_NAME=TorrentPier
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_URL=http://localhost
APP_LOCALE=en
APP_FALLBACK_LOCALE=en
APP_FAKER_LOCALE=en_US
APP_MAINTENANCE_DRIVER=cache
APP_MAINTENANCE_STORE=redis
PHP_CLI_SERVER_WORKERS=4
BCRYPT_ROUNDS=12
LOG_CHANNEL=stack
LOG_STACK=single
LOG_DEPRECATIONS_CHANNEL=null
LOG_LEVEL=debug
DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=torrentpier
DB_USERNAME=sail
DB_PASSWORD=password
SESSION_DRIVER=redis
SESSION_LIFETIME=120
SESSION_ENCRYPT=false
SESSION_PATH=/
SESSION_DOMAIN=null
BROADCAST_CONNECTION=log
FILESYSTEM_DISK=s3
QUEUE_CONNECTION=redis
CACHE_PREFIX=tp_
CACHE_STORE=redis
MEMCACHED_HOST=memcached
REDIS_CLIENT=predis
REDIS_HOST=redis
REDIS_PASSWORD=null
REDIS_PORT=6379
SCOUT_DRIVER=meilisearch
SCOUT_PREFIX=tp_
SCOUT_QUEUE=true
MEILISEARCH_HOST=http://meilisearch:7700
MEILISEARCH_KEY=masterKey
MAIL_MAILER=smtp
MAIL_SCHEME=null
MAIL_HOST=mailpit
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_FROM_ADDRESS="hello@torrentpier.local"
MAIL_FROM_NAME="${APP_NAME}"
AWS_ACCESS_KEY_ID=sail
AWS_SECRET_ACCESS_KEY=password
AWS_DEFAULT_REGION=us-east-1
AWS_BUCKET=local
AWS_ENDPOINT=http://minio:9000
AWS_USE_PATH_STYLE_ENDPOINT=true
VITE_APP_NAME="${APP_NAME}"
# Sail specific configuration
WWWGROUP=1000
WWWUSER=1000
# Sail port forwarding configuration
APP_PORT=80
VITE_PORT=5173
FORWARD_DB_PORT=3306
FORWARD_REDIS_PORT=6379
FORWARD_MEILISEARCH_PORT=7700
FORWARD_MAILPIT_PORT=1025
FORWARD_MAILPIT_DASHBOARD_PORT=8025
# Sail PHP configuration
SAIL_XDEBUG_MODE=off
SAIL_XDEBUG_CONFIG=client_host=host.docker.internal
# Sail Meilisearch analytics
MEILISEARCH_NO_ANALYTICS=true

2
composer.json
View file

@ -34,7 +34,7 @@
"fakerphp/faker": "^1.23",
"laravel/pail": "^1.2.2",
"laravel/pint": "^1.18",
"laravel/sail": "^1.41",
"laravel/sail": "^1.43",
"mockery/mockery": "^1.6",
"nunomaduro/collision": "^8.6",
"pestphp/pest": "^3.8",

2
composer.lock generated
View file

@ -4,7 +4,7 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
"content-hash": "6ed91dee962bbd152c5db5e783d901b1",
"content-hash": "afa2c63d273b3a28c3ab186f7cc91656",
"packages": [
{
"name": "brick/math",

127
docker-compose.yml Normal file
View file

@ -0,0 +1,127 @@
services:
laravel.test:
build:
context: ./vendor/laravel/sail/runtimes/8.4
dockerfile: Dockerfile
args:
WWWGROUP: '${WWWGROUP}'
image: sail-8.4/app
extra_hosts:
- 'host.docker.internal:host-gateway'
ports:
- '${APP_PORT:-80}:80'
- '${VITE_PORT:-5173}:${VITE_PORT:-5173}'
environment:
WWWUSER: '${WWWUSER}'
LARAVEL_SAIL: 1
XDEBUG_MODE: '${SAIL_XDEBUG_MODE:-off}'
XDEBUG_CONFIG: '${SAIL_XDEBUG_CONFIG:-client_host=host.docker.internal}'
IGNITION_LOCAL_SITES_PATH: '${PWD}'
volumes:
- '.:/var/www/html'
networks:
- sail
depends_on:
- mysql
- redis
- meilisearch
- mailpit
- minio
mysql:
image: 'mysql/mysql-server:8.0'
ports:
- '${FORWARD_DB_PORT:-3306}:3306'
environment:
MYSQL_ROOT_PASSWORD: '${DB_PASSWORD}'
MYSQL_ROOT_HOST: '%'
MYSQL_DATABASE: '${DB_DATABASE}'
MYSQL_USER: '${DB_USERNAME}'
MYSQL_PASSWORD: '${DB_PASSWORD}'
MYSQL_ALLOW_EMPTY_PASSWORD: 1
volumes:
- 'sail-mysql:/var/lib/mysql'
- './vendor/laravel/sail/database/mysql/create-testing-database.sh:/docker-entrypoint-initdb.d/10-create-testing-database.sh'
networks:
- sail
healthcheck:
test:
- CMD
- mysqladmin
- ping
- '-p${DB_PASSWORD}'
retries: 3
timeout: 5s
redis:
image: 'redis:alpine'
ports:
- '${FORWARD_REDIS_PORT:-6379}:6379'
volumes:
- 'sail-redis:/data'
networks:
- sail
healthcheck:
test:
- CMD
- redis-cli
- ping
retries: 3
timeout: 5s
meilisearch:
image: 'getmeili/meilisearch:latest'
ports:
- '${FORWARD_MEILISEARCH_PORT:-7700}:7700'
environment:
MEILI_NO_ANALYTICS: '${MEILISEARCH_NO_ANALYTICS:-false}'
volumes:
- 'sail-meilisearch:/meili_data'
networks:
- sail
healthcheck:
test:
- CMD
- wget
- '--no-verbose'
- '--spider'
- 'http://127.0.0.1:7700/health'
retries: 3
timeout: 5s
mailpit:
image: 'axllent/mailpit:latest'
ports:
- '${FORWARD_MAILPIT_PORT:-1025}:1025'
- '${FORWARD_MAILPIT_DASHBOARD_PORT:-8025}:8025'
networks:
- sail
minio:
image: 'minio/minio:latest'
ports:
- '${FORWARD_MINIO_PORT:-9000}:9000'
- '${FORWARD_MINIO_CONSOLE_PORT:-8900}:8900'
environment:
MINIO_ROOT_USER: sail
MINIO_ROOT_PASSWORD: password
volumes:
- 'sail-minio:/data'
networks:
- sail
command: 'minio server /data --console-address ":8900"'
healthcheck:
test:
- CMD
- mc
- ready
- local
retries: 3
timeout: 5s
networks:
sail:
driver: bridge
volumes:
sail-mysql:
driver: local
sail-redis:
driver: local
sail-meilisearch:
driver: local
sail-minio:
driver: local

511
docs/docs/development/sail.md Normal file
View file

@ -0,0 +1,511 @@
---
sidebar_position: 3
---
# Laravel Sail Development
Laravel Sail provides a Docker-powered local development environment for TorrentPier. This guide covers everything you need to know about using Sail for development.
## Prerequisites
Before getting started with Sail, ensure you have:
- Docker Desktop installed and running
- Git for cloning the repository
- A terminal/command line interface
:::tip
For Windows users, we recommend using WSL2 (Windows Subsystem for Linux) for the best experience.
:::
## Quick Start
### 1. Clone the Repository
```bash
git clone https://github.com/torrentpier/torrentpier.git
cd torrentpier
```
### 2. Copy Environment File
```bash
cp .env.sail.example .env
```
### 3. Install Dependencies
If you don't have PHP installed locally, you can use a temporary container:
```bash
docker run --rm \
-u "$(id -u):$(id -g)" \
-v "$(pwd):/var/www/html" \
-w /var/www/html \
laravelsail/php84-composer:latest \
composer install --ignore-platform-reqs
```
### 4. Start Sail
```bash
./vendor/bin/sail up -d
```
### 5. Generate Application Key
```bash
./vendor/bin/sail artisan key:generate
```
### 6. Run Migrations
```bash
./vendor/bin/sail artisan migrate
```
### 7. Install Frontend Dependencies
```bash
./vendor/bin/sail npm install
./vendor/bin/sail npm run dev
```
Your application will be available at:
- Application: http://localhost
- Mailpit (Email testing): http://localhost:8025
- Meilisearch: http://localhost:7700
## Sail Configuration
### Environment Variables
The `.env.sail.example` file contains pre-configured settings for Docker services:
```env
# Database
DB_CONNECTION=mysql
DB_HOST=mysql
DB_PORT=3306
DB_DATABASE=torrentpier
DB_USERNAME=sail
DB_PASSWORD=password
# Redis
REDIS_HOST=redis
REDIS_PORT=6379
# Meilisearch
MEILISEARCH_HOST=http://meilisearch:7700
MEILISEARCH_KEY=masterKey
# Mailpit
MAIL_MAILER=smtp
MAIL_HOST=mailpit
MAIL_PORT=1025
# MinIO
AWS_ACCESS_KEY_ID=sail
AWS_SECRET_ACCESS_KEY=password
AWS_BUCKET=local
AWS_ENDPOINT=http://minio:9000
AWS_USE_PATH_STYLE_ENDPOINT=true
```
### Services
TorrentPier's Sail configuration includes:
- **MySQL 8.0** - Primary database
- **Redis** - Caching and queues
- **Meilisearch** - Full-text search engine
- **Mailpit** - Email testing interface
- **MinIO** - S3-compatible object storage for file uploads
### Customizing Services
To add additional services:
```bash
./vendor/bin/sail artisan sail:add
```
Available services include:
- PostgreSQL
- MariaDB
- Memcached
- MinIO
- Selenium
- Soketi
## Common Commands
### Starting and Stopping
```bash
# Start all services
./vendor/bin/sail up -d
# Stop all services
./vendor/bin/sail stop
# Stop and remove containers
./vendor/bin/sail down
# Remove containers and volumes (full reset)
./vendor/bin/sail down -v
```
### Artisan Commands
```bash
# Run any Artisan command
./vendor/bin/sail artisan [command]
# Examples:
./vendor/bin/sail artisan migrate
./vendor/bin/sail artisan db:seed
./vendor/bin/sail artisan queue:work
./vendor/bin/sail artisan scout:import
```
### Composer Commands
```bash
# Install dependencies
./vendor/bin/sail composer install
# Update dependencies
./vendor/bin/sail composer update
# Add a package
./vendor/bin/sail composer require package/name
```
### NPM Commands
```bash
# Install dependencies
./vendor/bin/sail npm install
# Run development server
./vendor/bin/sail npm run dev
# Build for production
./vendor/bin/sail npm run build
```
### Testing
```bash
# Run all tests
./vendor/bin/sail test
# Run specific test
./vendor/bin/sail test tests/Feature/ExampleTest.php
# Run tests with coverage
./vendor/bin/sail test --coverage
```
### Database Operations
```bash
# Access MySQL CLI
./vendor/bin/sail mysql
# Export database
./vendor/bin/sail exec mysql mysqldump -u sail -ppassword torrentpier > backup.sql
# Import database
./vendor/bin/sail exec mysql mysql -u sail -ppassword torrentpier < backup.sql
```
### Shell Access
```bash
# Access application container
./vendor/bin/sail shell
# Access as root
./vendor/bin/sail root-shell
# Access specific service
./vendor/bin/sail exec redis redis-cli
```
## Shell Alias
For convenience, add this alias to your shell configuration:
```bash
# ~/.bashrc or ~/.zshrc
alias sail='sh $([ -f sail ] && echo sail || echo vendor/bin/sail)'
```
Now you can use:
```bash
sail up
sail artisan migrate
sail npm run dev
```
## Debugging with Xdebug
### Enable Xdebug
Set in your `.env` file:
```env
SAIL_XDEBUG_MODE=debug,develop
```
### Configure Your IDE
#### PHPStorm
1. Go to Settings → PHP → Servers
2. Add a new server:
- Name: `localhost`
- Host: `localhost`
- Port: `80`
- Debugger: `Xdebug`
- Use path mappings: Yes
- Project files: `/var/www/html`
#### VS Code
Install the PHP Debug extension and add to `.vscode/launch.json`:
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "Listen for Sail Xdebug",
"type": "php",
"request": "launch",
"port": 9003,
"pathMappings": {
"/var/www/html": "${workspaceFolder}"
}
}
]
}
```
## Performance Optimization
### Windows (WSL2)
For better performance on Windows:
1. Clone the project inside WSL2:
```bash
cd ~/projects
git clone https://github.com/torrentpier/torrentpier.git
```
2. Configure Vite for HMR:
```js
// vite.config.js
export default defineConfig({
server: {
hmr: {
host: 'localhost',
},
},
});
```
### macOS
Enable VirtioFS in Docker Desktop:
1. Go to Docker Desktop → Settings → General
2. Enable "Use Virtualization framework"
3. Go to Settings → Resources → File sharing
4. Enable "VirtioFS"
## Production Builds
### Building for Production
```bash
# Build production Docker image
docker build -f Dockerfile.production -t torrentpier:latest .
# Using docker-compose
docker compose -f docker-compose.production.yml build
```
### Running Production Containers
```bash
# Start production stack
docker compose -f docker-compose.production.yml up -d
# View logs
docker compose -f docker-compose.production.yml logs -f
# Stop production stack
docker compose -f docker-compose.production.yml down
```
## Troubleshooting
### Port Conflicts
If you get port conflicts, customize ports in `.env`:
```env
APP_PORT=8080
FORWARD_DB_PORT=3307
FORWARD_REDIS_PORT=6380
FORWARD_MEILISEARCH_PORT=7701
FORWARD_MAILPIT_PORT=1026
FORWARD_MAILPIT_DASHBOARD_PORT=8026
```
### Permission Issues
Fix permission issues:
```bash
# Set correct ownership
./vendor/bin/sail exec laravel.test chown -R sail:sail storage bootstrap/cache
# Or from host
sudo chown -R $(id -u):$(id -g) storage bootstrap/cache
```
### Container Won't Start
1. Check logs:
```bash
./vendor/bin/sail logs laravel.test
```
2. Rebuild containers:
```bash
./vendor/bin/sail build --no-cache
./vendor/bin/sail up -d
```
3. Reset everything:
```bash
./vendor/bin/sail down -v
rm -rf vendor node_modules
# Then start from Quick Start
```
### Database Connection Issues
If you can't connect to the database:
1. Wait for MySQL to be ready:
```bash
./vendor/bin/sail exec mysql mysqladmin ping -h localhost --silent --wait=30
```
2. Check MySQL logs:
```bash
./vendor/bin/sail logs mysql
```
3. Verify credentials match `.env` file
## Advanced Usage
### Custom PHP Extensions
To add PHP extensions, first publish Sail's Dockerfiles:
```bash
./vendor/bin/sail artisan sail:publish
```
Then modify `docker/8.4/Dockerfile`:
```dockerfile
RUN apt-get update && apt-get install -y \
php8.4-gmp \
php8.4-imagick
```
Finally rebuild:
```bash
./vendor/bin/sail build --no-cache
```
### Running Multiple Projects
Use different APP_PORT values:
```bash
# Project 1 (.env)
APP_PORT=8001
# Project 2 (.env)
APP_PORT=8002
```
### Using Different PHP Versions
1. Publish Sail's Dockerfiles:
```bash
./vendor/bin/sail artisan sail:publish
```
2. Modify `docker-compose.yml`:
```yaml
services:
laravel.test:
build:
context: ./docker/8.3
```
3. Rebuild:
```bash
./vendor/bin/sail build --no-cache
```
## GitHub Codespaces / Devcontainers
For GitHub Codespaces support:
```bash
./vendor/bin/sail artisan sail:install --devcontainer
```
This creates `.devcontainer/devcontainer.json` for use with:
- GitHub Codespaces
- VS Code Remote Containers
- JetBrains Gateway
## Additional Resources
- [Official Laravel Sail Documentation](https://laravel.com/docs/sail)
- [Docker Documentation](https://docs.docker.com/)
- [Docker Compose Documentation](https://docs.docker.com/compose/)
## Getting Help
If you encounter issues:
1. Check the [troubleshooting](#troubleshooting) section
2. Search existing [GitHub Issues](https://github.com/torrentpier/torrentpier/issues)
3. Ask on our [support forum](https://torrentpier.com)
4. Create a new issue with:
- Your OS and Docker version
- Steps to reproduce
- Error messages/logs