Skip to content

Commit b876bd4

Browse files
committed
refactor: rename yml to yaml, standardize pkg templates, add Base category
1 parent 6092f1c commit b876bd4

5 files changed

Lines changed: 49 additions & 24 deletions

File tree

File renamed without changes.

Containerfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ LABEL org.opencontainers.image.title="nginx-base" \
1313
org.opencontainers.image.vendor="daemonless" \
1414
org.opencontainers.image.authors="daemonless" \
1515
io.daemonless.type="base" \
16+
io.daemonless.category="Base" \
1617
io.daemonless.packages="${PACKAGES}"
1718

1819
# Install nginx

README.md

Lines changed: 48 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,63 @@
1-
# nginx-base-image
1+
# Nginx-Base
22

3-
An extended base image pre-configured with **nginx** and s6 supervision for serving web applications on FreeBSD.
43

5-
## Overview
64

7-
This image extends `base-image` by adding a pre-configured nginx installation. It is designed to be a "ready-to-go" platform for PHP, PHP-FPM, or static web applications.
5+
| | |
6+
|---|---|
7+
| **Registry** | `ghcr.io/daemonless/nginx-base` |
8+
| **Source** | []() |
89

9-
## Features
10+
## Deployment
1011

11-
- **Inherits all `base-image` features** (s6, PUID/PGID, VNET).
12-
- **Pre-configured nginx**: Service is defined and ready to serve files from `/usr/local/www/html`.
13-
- **Automatic Permissions**: Logs and web directories are correctly permissioned at startup.
12+
### Podman Compose
1413

15-
## Usage (for Image Developers)
14+
```yaml
15+
services:
16+
nginx-base:
17+
image: ghcr.io/daemonless/nginx-base:latest
18+
container_name: nginx-base
19+
environment:
20+
volumes:
21+
ports:
22+
restart: unless-stopped
23+
```
1624
17-
Use this if your application requires a web server:
25+
### Podman CLI
1826
19-
```dockerfile
20-
FROM ghcr.io/daemonless/nginx-base-image:15
27+
```bash
28+
podman run -d --name nginx-base \
29+
ghcr.io/daemonless/nginx-base:latest
30+
```
2131

22-
# Add your web files
23-
COPY my-site/ /usr/local/www/html/
32+
### Ansible
2433

25-
# Optional: Add custom nginx config
26-
COPY my-nginx.conf /usr/local/etc/nginx/nginx.conf
34+
```yaml
35+
- name: Deploy nginx-base
36+
containers.podman.podman_container:
37+
name: nginx-base
38+
image: ghcr.io/daemonless/nginx-base:latest
39+
state: started
40+
restart_policy: always
2741
```
2842
29-
## Exposed Ports
43+
## Configuration
44+
45+
### Environment Variables
46+
47+
| Variable | Default | Description |
48+
|----------|---------|-------------|
49+
50+
### Volumes
51+
52+
| Path | Description |
53+
|------|-------------|
54+
55+
### Ports
3056
31-
- `80`: Standard HTTP.
32-
- `443`: HTTPS.
57+
| Port | Protocol | Description |
58+
|------|----------|-------------|
3359
34-
## Directory Structure
60+
## Notes
3561
36-
- `/usr/local/www/html`: Default web root.
37-
- `/var/log/nginx`: nginx log directory.
38-
- `/usr/local/etc/nginx`: nginx configuration files.
39-
<!-- Trigger build -->
62+
- **User:** `` (UID/GID set via PUID/PGID)
63+
- **Base:** Built on `ghcr.io/daemonless/base` (FreeBSD)

0 commit comments

Comments
 (0)