screeenly

screeenly is an open source web application which lets users create website screenshots through a simple API. It's built with Laravel.

The latest version is hosted on screeenly.com. You can follow us on Twitter

---

☝️ A completely new version of screeenly has recently been released: https://3.screeenly.com.

The app has been rebuilt from the ground up. Its API now can also convert websites into PDFs, return the rendered HTML of a website. This now also works for your own provided HTML code. In addition, you can now update a lot more settings; like pixel density or wether images should be loaded.

The new app requires a paid subscription. The subscription covers server costs and maintenance.

The open source version of screeenly (this repo right here) which is hosted on http://screeenly.com will remain available for the forseeable future. If anything should change and you've registered on screeenly.com, you will receive a notice.

The repository runs on Laravel 13.

---

Documentation and more

The wiki holds the documentation.

• API specification
• Read about the code structure

Requirements

• PHP 8.5 or newer
• Composer 2
• Node.js 22 or newer and npm
• A Chrome binary for Puppeteer: npx puppeteer browsers install chrome-headless-shell
• MySQL, PostgreSQL or SQLite

Run the tests with vendor/bin/phpunit. Format the code with composer format.

Build the frontend assets with npm ci && npm run build. The compiled files in public/css, public/js and public/mix-manifest.json are committed. Rebuild and commit them after you change resources/js or resources/sass. npm run dev builds without minification, npm run watch rebuilds on changes.

Upgrading from Laravel 8 (PHP 8.0)

1. Switch the server to PHP 8.5 or newer.
2. Run composer install --no-dev --optimize-autoloader.
3. Run npm ci, npm run build and npx puppeteer browsers install chrome-headless-shell. Puppeteer 24 needs this separate download.
4. Update .env:
   • CACHE_DRIVER is now CACHE_STORE. The old name still works.
   • FILESYSTEM_DRIVER is now FILESYSTEM_DISK. The old name still works.
   • MAIL_ENCRYPTION is replaced by MAIL_SCHEME. Use smtps for implicit TLS (port 465). Leave it empty for STARTTLS (port 587).
   • BROADCAST_DRIVER is no longer used. Remove it.
5. Run php artisan migrate --force, then php artisan optimize.
6. Restart queue workers and PHP-FPM.

Self Hosting

screeenly is quite a simple PHP app. Therefore, it's quite easy to self host the application on your own server.

Self Hosting on your own Server

If you're comfortable running your own server follow your self-hosting guide here.

Laravel Forge

Deploy script for the site:

cd $FORGE_SITE_PATH
git pull origin $FORGE_SITE_BRANCH

$FORGE_COMPOSER install --no-dev --no-interaction --prefer-dist --optimize-autoloader

npm ci
npx puppeteer browsers install chrome-headless-shell

( flock -w 10 9 || exit 1
    echo 'Restarting FPM...'; sudo -S service $FORGE_PHP_FPM reload ) 9>/tmp/fpmlock

$FORGE_PHP artisan migrate --force
$FORGE_PHP artisan optimize

The scheduler runs screeenly:cleanup every hour. Add a Forge scheduled job php artisan schedule:run every minute so it runs.

Deploy to Zeet

Otherwise, Zeet makes deploying Screeenly dead simple, just click the button above. This guide will walk you through the configuration needed.

Deploy to Heroku

If managing servers is not your thing, we've also written a guide on how to deploy the app to Heroku.
By using Heroku, you can run your own version of screeenly basically for free.

Docker Images

If you're interested in a Docker version of screeenly, you can use the daily built images created by Jacek Szafarkiewicz.

• Dockerfile
• Docker Image

Please note: We do not provide any support for these Docker Images.

Security

If you discover a security vulnerability within this package, please e-mail us at [email protected]. All security vulnerabilities will be promptly addressed.

LICENSE

MIT