https://github.com/smilyorg/website-image-proxy
Simple proxy that serves a website as an image
https://github.com/smilyorg/website-image-proxy
Last synced: 23 days ago
JSON representation
Simple proxy that serves a website as an image
- Host: GitHub
- URL: https://github.com/smilyorg/website-image-proxy
- Owner: SmilyOrg
- License: mit
- Created: 2021-08-15T20:53:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-07T18:13:07.000Z (over 3 years ago)
- Last Synced: 2025-03-06T05:29:41.535Z (over 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 305 KB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Website Image Proxy
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.
## Usage
### Docker (recommended)
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.
1. Build and run the server via `docker-compose.yml`
```sh
URL=https://google.com docker compose up --build
```
2. 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:
```sh
# .env
URL=https://google.com
```
```sh
docker compose up
```
There are no prebuilt images available yet.
### node.js
This is also not too bad as Puppeteer downloads the required browsers
automatically, faster for development.
1. `npm install` (once to install dependencies)
2. Create an `.env` file to set up environment variables.
```sh
# .env
URL=https://google.com
```
3. `npm start` to run the server.
4. 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.
## Built With
* [Puppeteer]
* [Fastify]
## Contributing
Pull requests are welcome. For major changes, please open an issue first to
discuss what you would like to change.
## License
[MIT](https://choosealicense.com/licenses/mit/)
[Inkplate]: https://inkplate.io/
[Puppeteer]: https://github.com/puppeteer/puppeteer
[Fastify]: https://www.fastify.io/