The Website Image Proxy is a simple service that tries to provide an up-to-date screenshot of a website. This is useful for displaying websites on low-power IoT devices like the Inkplate, where running a full web browser is not feasible.
It will always serve the latest available screenshot immediately without waiting. The neat trick it does is that it expects to be called on a regular interval, so it learns this interval and updates the screenshot just before each call is made. In practice, it means that the screenshots are always fresh (less than a minute out of date) without the need for manual synchronization or configuration.
This is the easiest way as it includes all the dependencies needed already. Tested on a Windows 10 PC (Docker for Desktop) and Synology DS418play.
- Build and run the server via
docker-compose.ymlURL=https://google.com docker compose up --build
- Go to http://localhost:8000/page.png to get a screenshot of the website provided by the URL. You should get a HTTP 204 response until the first screenshot has been made and afterwards the latest available screenshot.
You can also use an .env file:
# .env
URL=https://google.comdocker compose upThere are no prebuilt images available yet.
This is also not too bad as Puppeteer downloads the required browsers automatically, faster for development.
npm install(once to install dependencies)- Create an
.envfile to set up environment variables.
# .env
URL=https://google.comnpm startto run the server.- Go to http://localhost:8000/page.png to get a screenshot of the website provided by the URL. You should get a HTTP 204 response until the first screenshot has been made and afterwards the latest available screenshot.
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.