amppackager
amppackager copied to clipboard
ampproject
Automate best practices for production
This could be a collection of scripts, or packages of various formats (Docker, Flatpak, .deb, etc.). Broad coverage of most of the production environments probably necessitates multiple formats, though we should prefer a solution that covers as many as possible in as few variants as possible. This will reduce the cost of maintenance and the chance of error in one or more of them. Googlers, see go/amp-packager-deployment-requirements for more info.
I've come across a couple examples on the webs:
- https://github.com/Warashi/try-amppackager
- https://github.com/oyorooms/deploy-amppackager-aws/
- https://github.com/ampproject/docs/blob/future/platform/lib/routers/packager.js
Haven't looked at them in detail yet, so I can't vouch for them, but we should link to them on an Implementations wiki page (and link to that from the readme).
One thing that came up in practice was difficulty meeting the "inner = outer" requirement for URLs with pct-encoded chars (such as https://example.com/index%2ehtml or https://example.com/foo%2fbar):
The signed fallback URL must equal the URL at which the SXG was delivered.
This was fixed in amppkg in #313, but the bug may still occur in the various reverse proxies used in front. For instance, I believe https://github.com/Warashi/try-amppackager/blob/895df747aa0948641e7ce979fed88dbf1906cbd6/reverse/proxy.conf#L39 will result in inner URLs that are doubly encoded. OTOH, using rewrite ... ?sign=... results in the opposite problem -- URLs that aren't doubly encoded when we want them to be.
The only mechanism I found that worked with nginx is:
proxy_pass http://amppkg/priv/doc/$scheme://$server_name$request_uri;
proxy_pass doesn't seem to have the same double-encoding bug.
This should also include an auto-updating facility (optional, but enabled by default), to allow the deployed amppackager to remain current with AMP Caches' AMP-Cache-Transform request header.
Additionally, when grabbing the latest release from the GitHub releases branch, it would be great if the fetcher could verify the snapshot by checking against either a) a checksum published on cdn.ampproject.org, or b) a signature included in the codebase, verified against a public key published on cdn.ampproject.org (see minisign or signify).
@banaag Feel free to split both of these things off as separate bugs if you prefer.