Add example deployment guides for nine PHP stacks (en/ru/zh)#245
Merged
Conversation
b4a5ac6 to
73c8354
Compare
Docs: - New docs/en/examples section with an overview index and one recipe per application — Laravel, Symfony, Yii3 (framework mode); WordPress, Drupal, Craft CMS, October CMS (CMS); Magento, OpenCart (e-commerce) — grouped into framework/, cms/, and ecommerce/ subdirectories by type. - Every recipe is a self-contained Docker Compose project: a Dockerfile, a docker-compose.yml, install and first-run commands, OxPHP-specific notes, and verification requests. The overview documents the patterns common to all recipes — extending the published OxPHP image, PHP ABI matching, PHP version choice, routing-mode selection, in-container installs, and the security defaults that apply everywhere. - Cover the OxPHP-specific details each stack needs: framework vs traditional routing, the public document root and ENTRY_FILE, the static-asset version symlink for Magento, the october:mirror public document root with SYMLINK_ALLOW_PATHS, PHP_DENY_PATHS for OpenCart and the WordPress upload directories, and dot-path blocking. - Omit LISTEN_ADDR and DOCUMENT_ROOT from the Compose examples where they match the OxPHP defaults, noting that they are defaults; keep and flag DOCUMENT_ROOT only where a stack overrides it (Drupal and Craft web, Magento pub, OpenCart project root). - Add Russian and Chinese translations of every example page, mirroring the English tree, with prose and in-code comments translated and code, paths, env values, and link targets kept verbatim. - Register the new section in the en, ru, and zh documentation indexes (top navigation link and an Examples section). - Regenerate llms.txt and llms-full.txt to include the new Examples section, and teach scripts/gen-llms-txt.sh to recurse into nested section subdirectories so the per-type example pages are indexed.
73c8354 to
75f16d5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a new Examples documentation section — end-to-end recipes for running nine popular PHP applications on OxPHP, each a self-contained Docker Compose project. Every recipe was built and verified end-to-end (storefront, admin panel, static assets, and the OxPHP internal health endpoint all answer
200).docs/<lang>/examples/is grouped by application type:Each page carries a
Dockerfile, adocker-compose.yml, install and first-run commands, OxPHP-specific notes, and verification requests. An overview index documents the patterns shared by every recipe.What's covered
public/web/pubdocument roots andENTRY_FILE.october:mirror publicdocument root withSYMLINK_ALLOW_PATHS,PHP_DENY_PATHSfor OpenCart internals and the WordPress upload directories, and dot-path blocking.LISTEN_ADDRandDOCUMENT_ROOTare omitted where they match the OxPHP defaults (and noted as defaults);DOCUMENT_ROOTis kept and flagged only where a stack overrides it.Translations
Full Russian and Chinese translations of every example page mirror the English tree — prose and in-code comments translated; code, paths, env values, and link targets kept verbatim. The new section is registered in all three documentation indexes (navigation link and an Examples section).
Verification