Skip to content

docs: document project-scope share providers - #57

Open
lbajsarowicz wants to merge 2 commits into
wardenenv:mainfrom
lbajsarowicz:docs/share-project-providers
Open

docs: document project-scope share providers#57
lbajsarowicz wants to merge 2 commits into
wardenenv:mainfrom
lbajsarowicz:docs/share-project-providers

Conversation

@lbajsarowicz

Copy link
Copy Markdown
Contributor

Builds on #53. Merge order: #53, then this PR.

Extends configuration/share.md for the project-scope share providers added in wardenenv/warden (Cloudflare Quick Tunnel, ngrok, Tailscale): the two-scope model (global agent selected in ~/.warden/.env versus a per-project share service selected with WARDEN_SHARE in the project .env), how each provider is configured and which credential lives where, how warden share url and warden share status behave, provider limits (Quick Tunnel request cap, ngrok free plan and interstitial, Tailscale Funnel prerequisites and ports), a note on Magento base URLs behind a public hostname, and the contributor section for adding a provider of either scope.

Should be merged together with the corresponding wardenenv/warden PRs.

Add configuration/share.md covering the share command, the traffic path
through Traefik, per-developer and per-project configuration, Cloudflare
Tunnel setup including the DNS record, configuration regeneration and
troubleshooting. List the share agent under global services, add a
feature bullet, and document .env.local overrides in customizing.md.
Add the two-scope model and the per-project providers (Cloudflare Quick
Tunnel, ngrok, Tailscale) to the share page: how each is selected and
configured, which credentials live in ~/.warden/.env, how to read the
public URL, provider limits, Funnel prerequisites, and a note on Magento
base URLs behind a public hostname. Extend the contributor section with
the project-scope hook set.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant