Nextended.Aspire.Hosting.Php 10.1.32

Nextended.Aspire.Hosting.Php

Run PHP endpoints inside your Aspire stack — a docroot folder or a single router script served by PHP's built-in web server, with php.ini settings as fluent options.

Runs PHP as an Aspire resource.

📖 Documentation: English · Deutsch  |  🧪 Runnable sample: Php.AppHost

Run PHP endpoints inside your .NET Aspire stack — a folder or a single .php file, served by PHP's built-in web server in the official php:cli container — and call them from your .NET services like any other referenced resource.

Quick start

var builder = DistributedApplication.CreateBuilder(args);

// Folder mode: ./php is the docroot, every .php file inside becomes an endpoint.
var php = builder.AddPhp("php", "./php")
    .WithPhpIni("memory_limit", "256M")
    .WithPhpIni("display_errors", "1");

builder.AddProject<Projects.Api>("api")
    .WithReference(php); // service discovery: http://php resolves inside "api"

builder.Build().Run();

Calling it from .NET:

// with Microsoft.Extensions.ServiceDiscovery (standard Aspire service defaults):
var client = new HttpClient { BaseAddress = new Uri("http://php") };
var json = await client.GetStringAsync("/index.php?who=aspire");
await client.PostAsJsonAsync("/send-mail.php", new { to = "x@y.z", subject = "hi" });

Single file mode

Pass a .php file instead of a folder and it becomes the router script — every request, regardless of path, is handled by that one file:

builder.AddPhp("mailer", "./php/send-mail.php");

API

Notes

• Concurrency: the built-in server runs 8 request workers by default; tune with WithWorkers(n).
• Dev server: PHP's built-in server is a development server — a fine match for Aspire's local orchestration. For production deploys use a proper PHP image (fpm + nginx / apache).
• Extensions: the stock php:cli image ships without extras like mysqli/pdo_mysql — use WithPhpExtensions(...) (compiled at container start, ~20–40s) or bake a custom image and pass it via AddPhp(..., image: "my/php", tag: "dev").
• MySQL: combine with Aspire.Hosting.MySql — AddMySql("mysql").WithPhpMyAdmin() gives you the server plus phpMyAdmin; hand PHP the endpoint via .WithEnvironment("MYSQL_URL", mysql.GetEndpoint("tcp")) and add WithPhpExtensions("mysqli").
• mail(): the container has no MTA, so PHP's mail() silently no-ops. Speak SMTP instead — e.g. add a Mailpit container to the stack and hand its endpoint to PHP (.WithEnvironment("SMTP_URL", mailpit.GetEndpoint("smtp"))). The Php.AppHost test project in this repo shows the full pattern including a dependency-free PHP SMTP sender.

Supported frameworks

• net8.0
• net9.0
• net10.0

Dependencies

• Aspire.Hosting.AppHost

The Nextended family

The other 17 packages in the suite:

Core libraries

• Nextended.Core — Foundation library — extension methods, custom types (Money, Date, BaseId, SuperType), class mapping, deep clone, encryption, hashing and the code-generation attributes.
• Nextended.Cache — Expression-based caching — automatic cache keys from method expressions, CacheProvider with condition-based invalidation, thread-safe AddOrGetExisting.

Data access

• Nextended.EF — Entity Framework Core extensions — graph loading (LoadGraphAsync, IncludeAll, MultiInclude), declarative include definitions, paging, dynamic sorting and bulk operations.

ASP.NET Core & web

• Nextended.Web — ASP.NET Core utilities — zero-config OData (AddODataAuto), composable IQueryable OData appliers, strongly typed controller URLs, streaming download helpers and a background executor that can replay a captured request.
• Nextended.ResponseFilters — Fluent, provider-agnostic pipeline that redacts, masks, rounds, truncates, hashes, prunes and restructures response DTOs before serialization — per request, per user, per permission.
• Nextended.ResponseFilters.AspNetCore — ASP.NET Core adapter for Nextended.ResponseFilters — registers the pipeline as a global IAsyncResultFilter and replays structural edits against the serialized JSON tree.

UI libraries

• Nextended.Blazor — Blazor helpers — IBrowserFile extensions (bytes, data URLs, downloads), a hierarchical model for browsing inside uploaded zip/tar/rar archives, MIME-type detection and component-parameter reflection.
• Nextended.UI — WPF and Windows desktop helpers — a global input-binding manager with hold/sequence matching, DirectInput and XInput gamepad readers, key-bind capture controls, converters, behaviours, markup extensions and runtime-defined PropertyGrid types.

Code generation & tooling

• Nextended.Imaging — Image processing — aspect-preserving resize, crop, colour replacement, brightness-based foreground picking, thumbnail generation, byte/data-URL conversion and MIME detection from magic bytes.
• Nextended.CodeGen — Roslyn source generator — DTOs and interfaces from your entities, strongly typed classes from JSON/XML, lookup tables from Excel, and documentation from source files.

.NET Aspire hosting

• Nextended.Aspire — Conditional AppHost builder extensions — WithReferenceIf / WaitForIf / WithExplicitStartIf, strongly typed environment variables from config objects, HTTPS dev-cert wiring, Docker guards, GitHub-source resources and npm app discovery.
• Nextended.Aspire.Hosting.Supabase — The complete Supabase stack — Postgres, Auth (GoTrue), REST, Realtime, Storage, Studio, Kong and Edge Functions — as one composable Aspire resource.
• Nextended.Aspire.Hosting.N8n — The n8n workflow-automation platform as an Aspire resource, with Postgres persistence, workflow import and a typed client for triggering workflows from .NET.
• Nextended.Aspire.Hosting.Grafana — Grafana, Prometheus, Loki, Tempo, Promtail, cAdvisor, postgres_exporter and the OpenTelemetry Collector as composable resources with auto-provisioned datasources.
• Nextended.Aspire.Hosting.WebDataStudio — WebDataStudio — a browser database studio for PostgreSQL, MySQL, SQL Server, SQLite, Oracle, DuckDB, ClickHouse, MongoDB and Redis — wired to the databases of your stack.
• Nextended.Aspire.Hosting.AspireUI — AspireUI — the visual AppHost builder — as a resource inside your own Aspire stack, with an optional pre-seeded admin user and a starter stack built from your project paths.
• Nextended.Aspire.Hosting.LocalAI — Self-hosted, OpenAI-compatible multimodal AI — image generation, text-to-speech, speech-to-text and video — with gallery model management, GPU support and Open WebUI.
• Nextended.Aspire.Hosting.Php — Run PHP endpoints inside your Aspire stack — a docroot folder or a single router script served by PHP's built-in web server, with php.ini settings as fluent options. (this package)

Links

• 📦 NuGet package
• 📖 Documentation — English
• 📖 Dokumentation — Deutsch
• 🏠 Documentation portal
• 🧪 Runnable sample
• 🧑‍💻 Source code
• 🐛 Report an issue

License

GPL-3.0-or-later — see LICENSE.