Skip to content

Docs: agents instructions, Makefile help and restyled readme #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
f3l1x wants to merge 8 commits into
base: master
Choose a base branch
from
Draft

Docs: agents instructions, Makefile help and restyled readme #30

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
a09f7e9
Makefile: add help target and target descriptions
f3l1x Sep 28, 2026
7e1ec40
AI: add agents instructions
f3l1x Sep 28, 2026
63594e0
Editorconfig: init
f3l1x Sep 28, 2026
7e82fa5
Config: add fxnorm configuration
f3l1x Sep 28, 2026
8349a11
Readme: describe package, usage and development
f3l1x Sep 28, 2026
195cf1a
AI: simplify agents instructions to development essentials
f3l1x Sep 29, 2026
24cf1b5
AI: drop CLAUDE.md, agents read AGENTS.md directly
f3l1x Sep 29, 2026
121f5d5
Readme: simplify usage and development
f3l1x Sep 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Readme: simplify usage and development 
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012DSzm4XsY7riy11DAVjsaB
  • Loading branch information
@f3l1x @claude
f3l1x and claude committed Sep 29, 2026
commit 121f5d59fed3b72ddeb2828c1dfc9278b203500d
61 changes: 10 additions & 51 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,16 @@

## Usage

Install the Composer dependencies of the project in the current folder:
Mount your project in `/srv` and run a command in it:

```sh
docker run --rm -v "$(pwd)":/srv dockette/php:8.5 composer install
docker run -v "$(pwd)":/srv dockette/php:8.5 composer install
```

Based on `dockette/debian:bookworm`. The working directory is `/srv`; mount your project there. The CLI images
run `php` by default and run as root.

Run PHP-FPM on port `9000`:

```sh
docker run --rm -p 9000:9000 -v "$(pwd)":/srv dockette/php:8.5-fpm
```

The FPM images run `php-fpm8.5` (or the matching version) in the foreground and log to stderr. They speak
FastCGI only, so put a web server such as Nginx or Caddy in front of them.

Use an image as the base for your own:

```Dockerfile
FROM dockette/php:8.5-fpm

RUN apt-get update && apt-get install -y --no-install-recommends curl && rm -rf /var/lib/apt/lists/*
```

The Sury repository is already configured, so more `php8.5-*` extension packages install the same way.
The image adds Composer 2, about 25 extensions and a `custom.ini` with PHP limits and the `Europe/Prague` time
zone. The `-fpm` tags run PHP-FPM with one FastCGI pool on port `9000` and `open_basedir` set to
`/data:/srv:/var/tmp:/tmp`; mount your own `.ini` file into `/etc/php/8.5/cli/conf.d` or
`/etc/php/8.5/fpm/conf.d` to change a setting, see the [PHP configuration reference](https://www.php.net/manual/en/ini.list.php).

## Versions

Expand Down Expand Up @@ -108,39 +91,15 @@ The extensions per version:
| xsl | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
| zip | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |

## Configuration

Each image adds one `custom.ini`, stored in `/etc/php/{version}/mods-available/custom.ini` and linked as
`999-custom.ini` into the `cli`, `cgi` and (for `-fpm`) `fpm` config folders. It sets:

```ini
memory_limit = 521M
upload_max_filesize = 256M
post_max_size = 256M
date.timezone=Europe/Prague
```

The container time zone is also `Europe/Prague` (`TZ`). To change a setting, mount your own file over
`/etc/php/8.5/mods-available/custom.ini`, or add a file with a higher number to the `conf.d` folder.

The `-fpm` tags replace the Debian pool with `/etc/php/{version}/fpm/php-fpm.conf`: one `www` pool on port `9000`
as `www-data`, `pm = dynamic` with up to 9 children, `open_basedir` set to `/data:/srv:/var/tmp:/tmp` and
`clear_env = yes`. Put your application under `/srv` or `/data`, or PHP can't open its files. Extra pools go to
`/etc/php/{version}/fpm/pool.d/*.conf`.

## Development

Build and test the latest version, then run it with the current folder in `/srv`:

```sh
make build
make build VERSION=8.5-fpm
make test
make run
make build # build the image (VERSION=8.5)
make test # smoke test the CLI and FPM image
make run # run it with the current folder in /srv
```

`VERSION` selects another version (`make build VERSION=8.4`); `make test` tests the CLI and FPM image of one
version, so build both first. `make help` lists all targets.
Run `make` to list every target.

## Maintenance

Expand Down
Loading