Files
MageSail/docs
2026-03-21 03:01:08 -05:00
..
2026-03-21 03:01:08 -05:00
2026-03-21 03:01:08 -05:00
2026-03-21 03:01:08 -05:00
2026-03-21 01:36:59 -05:00
2026-03-21 03:01:08 -05:00
2026-03-21 03:01:08 -05:00
2026-03-21 00:51:50 -05:00
2026-03-21 00:51:50 -05:00
2026-03-21 01:36:59 -05:00

MageSail documentation

MageSail (MageSail_Magesail) integrates Holesail with Magento 2 Admin: tunnel lifecycle, optional NGINX global-map updates, and storefront routing for tunneled hosts.

Development tests (repository root)

PHPUnit, PHPStan (tests + scanned Model/), and PHPCS run from the repo root after composer install — see the root composer.json, phpunit.xml.dist, and .github/workflows/ci.yml.

Guides

Document Description
overview.md Purpose, stack, high-level request flow
installation.md Composer vs app/code, enablement, Node/npm, legacy file migration
configuration.md All Admin config paths (tunnel + NGINX)
admin-ui.md MageSail sidebar menu and tunnel screens
tunnel-store-and-multistore.md Per-tunnel store views, magesail_tunnels.json, base URLs, stop vs remove
request-routing-and-plugins.md DI plugins, headers, and base-URL behavior
nginx-global-map.md Map file edits, nginx -t, reload, permissions
cron-and-monitoring.md Daily cron, auto-restart, DB logs
php-classes-reference.md PHP classes by layer (quick index)
scripts.md Node scripts, nginx helpers, probes
troubleshooting.md Common failures and fixes

Deeper dives (in the module tree)

Root entry point

The repository README.md is the quick start; this directory is the full split-by-topic reference.