https://github.com/derafu/docker-php-caddy-server
Docker with PHP and Caddy for Deployer
https://github.com/derafu/docker-php-caddy-server
caddy deployer docker php
Last synced: about 2 months ago
JSON representation
Docker with PHP and Caddy for Deployer
- Host: GitHub
- URL: https://github.com/derafu/docker-php-caddy-server
- Owner: derafu
- License: mit
- Created: 2025-03-09T23:35:37.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2025-03-10T04:47:19.000Z (about 2 months ago)
- Last Synced: 2025-03-10T05:30:16.684Z (about 2 months ago)
- Topics: caddy, deployer, docker, php
- Language: Dockerfile
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Derafu Sites Server - Docker with PHP and Caddy for Deployer
A modern Docker setup for hosting PHP websites with Caddy web server and SSH access for Deployer deployments.
## Features
- **PHP 8.3**: Supported PHP version with common extensions.
- **Caddy**: Modern web server with automatic HTTPS.
- **SSH Access**: For automated deployments with Deployer.
- **Automatic Site Discovery**: Just add your site folder and it works.
- **Development Domains**: Test with .local domains that map to production folders.
- **Automatic WWW Redirection**: For second-level domains (e.g., example.com → www.example.com).
- **Auto-HTTPS**: Certificates are automatically generated on-demand.
- **Environment Separation**: Development and production environments managed through Docker Compose override.
## Quick Start
### Prerequisites
- Docker and Docker Compose installed on your system.
- SSH key for deployment access.
### Setup
1. Clone this repository:
```bash
git clone https://github.com/derafu/docker-php-caddy-server.git
cd docker-php-caddy-server
```
2. Add your SSH public key to `config/ssh/authorized_keys` for admin, and default deployment, access:
```bash
cat ~/.ssh/id_rsa.pub > config/ssh/authorized_keys
```
3. Build and start the container:
```bash
docker-compose up -d
```
The `-d` parameter runs it in detached mode (background).
### Verification
Check that the container is running:
```bash
docker-compose ps
```
View container logs:
```bash
docker-compose logs -f
```
The `-f` parameter allows you to follow logs in real-time.
### Testing Your First Site
1. Create a test site directory structure:
```bash
mkdir -p sites/www.example.com/public
echo " sites/www.example.com/public/index.php
```
2. Access the site at:
- Production mode: https://www.example.com (requires DNS configuration).
- Development mode: https://www.example.com.local:8443 (requires local hosts entry).
For local development, add to your `/etc/hosts` file:
```
127.0.0.1 www.example.com.local
```
## Directory Structure
```
docker-php-caddy-server/
├── config/ # Configuration files.
│ ├── caddy/ # Caddy configuration.
│ ├── php/ # PHP configuration.
│ ├── ssh/ # SSH configuration and authorized keys.
│ └── supervisor/ # Supervisor configuration.
├── sites/ # Web sites directory for local development.
│ └── www.example.com/ # Example site.
│ └── public/ # Public web files.
├── .env # Docker Compose environment configuration.
├── Dockerfile # Container definition.
├── docker-compose.yml # Docker services configuration (production).
└── docker-compose.override.yml # Development-specific configuration.
```
## Development vs Production Environment
This project uses Docker Compose's override functionality to separate development and production configurations:
### Production Environment
The base `docker-compose.yml` contains the minimal configuration needed for production deployment. It:
- Sets up required environment variables.
- Defines essential ports (HTTP, HTTPS, SSH).
- Doesn't mount external volumes.
### Development Environment
The `docker-compose.override.yml` file adds development-specific settings:
- Adds additional development ports (e.g., management interface).
- Mounts local volumes for easy site development.
### Usage:
- **Development**: Docker Compose automatically merges both files:
```bash
docker-compose up -d
```
- **Production**: Use only the base configuration:
```bash
docker-compose -f docker-compose.yml up -d
```
## Access and Management
### SSH Access
Connect to the container via SSH:
```bash
ssh admin@localhost -p 2222
```
### Direct Container Access
Access the container shell:
```bash
docker exec -it derafu-sites-server-php-caddy bash
```
### Restarting Services
Restart Caddy web server:
```bash
docker exec -it derafu-sites-server-php-caddy supervisorctl restart caddy
```
### Stopping the Container
```bash
docker-compose down
```
### Rebuilding After Configuration Changes
Rebuild for development:
```bash
docker-compose build --no-cache
docker-compose up -d
```
Rebuild for production:
```bash
docker-compose -f docker-compose.yml build --no-cache
docker-compose -f docker-compose.yml up -d
```
## Adding New Sites
1. Create the site directory structure:
```bash
mkdir -p sites/www.newsite.com/public
touch sites/www.newsite.com/public/index.php
```
2. No server restart required! Caddy automatically detects new sites.
3. For local development, add to your hosts file:
```
127.0.0.1 www.newsite.com.local
```
## Environment Variables
Customize behavior through environment variables:
| Variable | Description | Default |
|-----------------------|--------------------------------|---------------------|
| `SERVER_NAME` | Name for the docker container | derafu-sites-server |
| `CADDY_DEBUG` | Enable debug mode with `debug` | (empty) |
| `CADDY_EMAIL` | Email for Let's Encrypt | [email protected] |
| `CADDY_HTTPS_ISSUER` | TLS issuer (internal, acme) | internal |
| `CADDY_LOG_SIZE` | Log file max size | 100mb |
| `CADDY_LOG_KEEP` | Number of log files to keep | 5 |
| `CADDY_LOG_KEEP_DAYS` | Days to keep logs | 14 |
| `WWW_ROOT_PATH` | Web root path | /var/www/sites |
| `HTTP_PORT` | HTTP port in host | 8080 |
| `HTTPS_PORT` | HTTPS port in host | 8443 |
| `SSH_PORT` | SSH port in host | 2222 |
| `ADMIN_USER` | SSH user in the container | admin |
| `ADMIN_GROUP` | SSH group in the container | admin |
## Domain Logic
The server handles domains in the following way:
1. **Development domains**: Any domain ending with `.local` (e.g., `www.example.com.local`)
- Maps to the same directory as its production counterpart.
- Uses internal self-signed certificates.
2. **Production domains**:
- Redirects from non-www to www for second-level domains.
- Automatically obtains and manages Let's Encrypt certificates (issuer `acme`).
## Troubleshooting
### SSL Certificate Issues
If you're having issues with SSL certificates in development:
- Ensure your browser trusts self-signed certificates.
- Try using HTTP instead of HTTPS for local development.
### Permissions Issues
If you encounter permission issues:
```bash
docker exec -it derafu-sites-server-php-caddy chown -R admin:admin /var/www/sites
```
### Logs Location
Logs are available in the container and can be accessed with:
```bash
docker exec -it derafu-sites-server-php-caddy cat /var/log/caddy/access.log
```
## Advanced Usage
### Custom Caddy Configuration
For advanced configurations, modify the Caddyfile at `config/caddy/Caddyfile`.
### Using with Deployer
This container is designed to work with [Deployer](https://deployer.org/) for PHP deployments:
1. Set up your `deploy.php` configuration to connect to the SSH server on port 2222.
2. Use the `admin` user for authentication.
3. Set your deployment path to `/var/www/sites/www.yoursite.com`
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
## License
This package is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).