diff --git a/docs/img/dev-tools-1.png b/docs/img/dev-tools-1.png new file mode 100644 index 000000000..11496cf77 Binary files /dev/null and b/docs/img/dev-tools-1.png differ diff --git a/docs/img/dev-tools-2.png b/docs/img/dev-tools-2.png new file mode 100644 index 000000000..125c0a7d7 Binary files /dev/null and b/docs/img/dev-tools-2.png differ diff --git a/docs/img/penpot-report.png b/docs/img/penpot-report.png new file mode 100644 index 000000000..3240691e4 Binary files /dev/null and b/docs/img/penpot-report.png differ diff --git a/docs/technical-guide/getting-started.md b/docs/technical-guide/getting-started.md index f0cff3c80..70248a62e 100644 --- a/docs/technical-guide/getting-started.md +++ b/docs/technical-guide/getting-started.md @@ -280,6 +280,65 @@ Postgres database and another one for the assets uploaded by your users (images clips). There may be more volumes if you enable other features, as explained in the file itself. +### Troubleshooting + +Knowing how to do Penpot troubleshooting can be very useful; on the one hand, it helps to create issues easier to resolve, since they include relevant information from the beginning which also makes them get solved faster; on the other hand, many times troubleshooting gives the necessary information to resolve a problem autonomously, without even creating an issue. + +Troubleshooting requires patience and practice; you have to read the stacktrace carefully, even if it looks like a mess at first. It takes some practice to learn how to read the traces properly and extract important information. + +If your Penpot installation is not working as intended, there are several places to look up searching for hints: + +**Docker logs** + +Check if all containers are up and running: +```bash +docker compose -p penpot -f docker-compose.yaml ps +``` + +Check logs of all Penpot: +```bash +docker compose -p penpot -f docker-compose.yaml logs -f +``` + +If there is too much information and you'd like to check just one service at a time: +```bash +docker compose -p penpot -f docker-compose.yaml logs penpot-frontend -f +``` + +You can always check the logs form a specific container: +```bash +docker logs -f penpot-penpot-postgres-1 +``` + +**Browser logs** + +The browser provides as well useful information to corner the issue. + +First, use the devtools to ensure which version and flags you're using. Go to your Penpot instance in the browser and press F12; you'll see the devtools. In the Console, you can see the exact version that's being used. + +
+ + Devtools > Console + +
+ +Other interesting tab in the devtools is the Network tab, to check if there is a request that throws errors. + +
+ + Devtools > Network + +
+ +**Penpot Report** + +When Penpot crashes, it provides a report with very useful information. Don't miss it! + +
+ + Penpot report + +
## Install with Kubernetes