UniqueSoft/openpanel
2
0
Fork 0
mirror of https://github.com/stefanpejcic/openpanel synced 2025-06-26 18:28:26 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Create selfhosted-screenshots-api.md

Browse Source
This commit is contained in:
Stefan Pejcic 2024-11-13 14:07:19 +01:00 committed by GitHub
parent 66daabe551
commit 74556f94cc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 31 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
website/docs/articles/dev-experience/selfhosted-screenshots-api.md Normal file
View File

@ -0,0 +1,31 @@
# Self-hosted Screenshots API for OpenPanel SiteManager
[OpenPanel SiteManager](/docs/panel/applications/) displays a website screenshot for each website. These screenshots are generated using our hosted API.
## Use Self-hosted Local Service
When installing OpenPanel on your server, you can use the `--screenshots=local` flag to generate and host screenshots locally on your server instead.
This method is recommended for shared servers with a few TBs of storage and hundreds of websites.
OpenPanel will then install [Playwright](https://playwright.dev/) on your server to generate screenshots for all websites locally. Note that Playwright requires 1GB of disk space for the service, so it is not recommended for VPS servers.
## Use Third-Party Screenshot APIs
To use a third-party screenshot API, simply update the screenshots URL with the following command:
```
opencli config update screenshots "http://screenshots-api.openpanel.com/screenshot"
```
Replace `http://screenshots-api.openpanel.com/screenshot` with the URL of the third-party service, which will accept `/<DOMAIN>` and return an image.
## Use Self-hosted Remote API
If you have multiple OpenPanel servers and want to use your own screenshots API, you can designate one server to generate all the screenshots for domains hosted on other servers.
To do this, set up the [Screenshots API service for OpenPanel](https://github.com/stefanpejcic/OpenPanel/blob/main/services/screenshots/README.md) on one server, add the domain to it, and then update the screenshots service on your OpenPanel servers to use the new instance:
```
opencli config update screenshots "http://your-screenshots-api.com:5000/screenshot"
```