diff --git a/docs/technical-guide/getting-started.md b/docs/technical-guide/getting-started.md index 1b262cb3d..5aeebd283 100644 --- a/docs/technical-guide/getting-started.md +++ b/docs/technical-guide/getting-started.md @@ -341,66 +341,6 @@ penpot.mycompany.com { } ``` -### 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 This section details everything you need to know to get Penpot up and running in diff --git a/docs/technical-guide/index.md b/docs/technical-guide/index.md index 5197ea1b3..8f0b2783a 100644 --- a/docs/technical-guide/index.md +++ b/docs/technical-guide/index.md @@ -37,6 +37,11 @@ Also, if you are a developer, you can get into the code, to explore it, learn ho or extend it and contribute with new functionality. For this, we have a different Docker installation. In the [Developer Guide][6] you can find how to setup a development environment and many other dev-oriented documentation. +## Troubleshooting Penpot + +The [Troubleshooting][8] section guides you through the different logs in Penpot so you can easily identify +any issue that may arise as well as report it comprehensively. + [1]: /technical-guide/getting-started/#install-with-elestio [2]: /technical-guide/getting-started/#install-with-docker [3]: /technical-guide/configuration/ @@ -44,3 +49,4 @@ In the [Developer Guide][6] you can find how to setup a development environment [5]: /technical-guide/integration/ [6]: /technical-guide/developer/ [7]: /technical-guide/getting-started/#install-with-kubernetes +[8]: /technical-guide/troubleshooting/ diff --git a/docs/technical-guide/troubleshooting.md b/docs/technical-guide/troubleshooting.md new file mode 100644 index 000000000..56274258b --- /dev/null +++ b/docs/technical-guide/troubleshooting.md @@ -0,0 +1,62 @@ +--- +title: 5. Troubleshooting Penpot +--- + +# Troubleshooting Penpot + +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. + +So, if your Penpot installation is not working as intended, there are several places to look up searching for hints. + +## Browser logs + +Regardless of the type of installation you have performed, you can find useful information about Penpot in your browser. + +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. + +![Console](/img/dev-tools-1.png) + +Other interesting tab in the devtools is the Network tab, to check if there is a request that throws errors. + +![Network](/img/dev-tools-2.png) + +## Penpot report + +When Penpot crashes, it provides a report with very useful information. Don't miss it! + +![Penpot Report](/img/penpot-report.png) + +## Docker logs + +If you are using the Docker installation, this is an easy way to take a look at the 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 +```