marfeel/ampoptimizer repository overview

⁠Introduction

This is just a fork from ampproject/toolbox-optimizer⁠.
ampproject/toolbox-optimizer⁠ is a Docker⁠ container that exposes an AMP Optimizer⁠ server for optimizing your amphtml using the same server-side-rendering optimizations as the Google AMP Cache⁠.

⁠How it works

The AMP Optimizer server accepts POST requests at port 3000 and requires an HTML body. It then runs the HTML through the optimizer⁠ package, and returns the result as the response.

⁠Configuration

There are two different kinds of configuration you can supply to the container:

1. Static configuration via environment variables: On startup, the container will search for environment variables prefixed with AMP_OPTIMIZER_ and pass the values as configuration options when initializing the underlying optimizer library. The full list of options are available here⁠. Options should be specified in SCREAMING_SNAKE_CASE as opposed to camelCase. For example, in order to configure the optimizeHeroImages option, you would declare the environment variable named: AMP_OPTIMIZER_OPTIMIZE_HERO_IMAGES.
2. Per-request configuration: there are some options that can only be set on a per-request basis. For example, the canonical flag for specifying an AMP page's canonical link. These can be specified via query params, e.g. /?canonical=http://example.com.