Sign inSign up

gaetanddr/nginx

By gaetanddr

ā€¢Updated 11 months ago

A lightweight, rootless-compatible Nginx container based on BoxHarbor's Alpine base image.

Image
0

363

gaetanddr/nginx repository overview

ā BoxHarbor - Nginx

Docker Pulls GitHub

A lightweight, rootless-compatible Nginx container based on BoxHarbor's Alpine base image. Perfect for serving static content, reverse proxying, or as a foundation for web applications.

ā Features

  • šŸŖ¶ Lightweight: Alpine-based
  • šŸ”’ Rootless Compatible: Works with Podman and Docker rootless
  • āš” High Performance: Optimized Nginx configuration
  • šŸ“ Persistent Config: Store configuration in /config
  • šŸŒ Multi-arch: Supports amd64, arm64, armv7
  • šŸ”§ Easy Customization: Simple configuration management

ā Quick Start

ā Docker
docker run -d \
  --name nginx \
  -p 8080:8080 \
  -v $(pwd)/config:/config \
  -v $(pwd)/web:/web \
  -e PUID=1000 \
  -e PGID=1000 \
  ghcr.io/boxharbor/nginx:latest
ā Podman (Rootless)
podman run -d \
  --name nginx \
  -p 8080:8080 \
  -v $(pwd)/config:/config:Z \
  -v $(pwd)/web:/web:Z \
  -e PUID=1000 \
  -e PGID=1000 \
  ghcr.io/boxharbor/nginx:latest
ā Docker Compose
version: '3.8'

services:
  nginx:
    image: ghcr.io/boxharbor/nginx:latest
    container_name: nginx
    ports:
      - "8080:8080"
    volumes:
      - ./config:/config
      - ./web:/web
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    restart: unless-stopped

ā Environment Variables

VariableDefaultDescription
PUID1000User ID for file permissions
PGID1000Group ID for file permissions
TZUTCTimezone
UMASK022File creation mask

ā Volumes

PathDescription
/configNginx configuration files
/webWeb root directory (default document root)

ā Ports

PortDescription
8080HTTP (non-privileged port for rootless)

ā Directory Structure

/config/
ā”œā”€ā”€ nginx.conf          # Main Nginx configuration
ā”œā”€ā”€ sites-enabled/      # Virtual host configurations
ā”‚   ā””ā”€ā”€ default.conf    # Default site
ā””ā”€ā”€ ssl/               # SSL certificates (if needed)

/web/
ā””ā”€ā”€ index.html         # Your web content

ā Configuration

ā First Run

On first run, default configuration files are copied to /config:

  • nginx.conf - Main Nginx configuration
  • sites-enabled/default.conf - Default virtual host

Edit these files to customize your setup!

ā Custom Site Configuration

Create a new file in /config/sites-enabled/:

server {
    listen 8080;
    server_name example.com;
    
    root /web/example;
    index index.html;
    
    location / {
        try_files $uri $uri/ =404;
    }
}

Restart the container to apply changes:

docker restart nginx
# or
podman restart nginx
ā SSL/TLS Configuration

Mount your certificates and update the configuration:

volumes:
  - ./config:/config
  - ./certs:/config/ssl:ro
  - ./web:/web

Update sites-enabled/default.conf:

server {
    listen 8443 ssl;
    ssl_certificate /config/ssl/cert.pem;
    ssl_certificate_key /config/ssl/key.pem;
    
    # ... rest of configuration
}

ā Use Cases

ā Static Website Hosting
# Place your files in ./web/
mkdir -p ./web
echo "<h1>Hello from BoxHarbor!</h1>" > ./web/index.html

# Run the container
docker run -d -p 8080:8080 -v $(pwd)/web:/web ghcr.io/boxharbor/nginx:latest
ā Reverse Proxy

Edit /config/sites-enabled/default.conf:

server {
    listen 8080;
    server_name api.example.com;
    
    location / {
        proxy_pass http://backend:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}
ā PHP-FPM Backend
services:
  nginx:
    image: ghcr.io/boxharbor/nginx:latest
    volumes:
      - ./config:/config
      - ./web:/web
    depends_on:
      - php-fpm
  
  php-fpm:
    image: php:fpm-alpine
    volumes:
      - ./web:/web

ā Troubleshooting

ā Permission Denied

Ensure PUID/PGID match your host user:

id -u  # Get your UID
id -g  # Get your GID

Set these in your docker run command or compose file.

ā Port Already in Use

Change the host port:

docker run -d -p 9090:8080 ghcr.io/boxharbor/nginx:latest
ā Configuration Errors

Check logs:

docker logs nginx
# or
podman logs nginx

Test configuration:

docker exec nginx nginx -t

ā Building from Source

git clone https://github.com/BoxHarbor/nginx.git
cd nginx
docker build -t boxharbor/nginx:latest .

ā Contributing

Contributions are welcome! Please read our Contributing Guidelinesā  before submitting PRs.

ā License

GPL-3.0 License - see LICENSEā  file for details.

ā Support

Built with ā¤ļø by the BoxHarbor team

Tag summary

Content type

Image

Digest

sha256:7721b8db9ā€¦

Size

9.4 MB

Last updated

11 months ago

docker pull gaetanddr/nginx