mirror of
https://github.com/penpot/penpot.git
synced 2025-02-28 17:56:50 -05:00
📚 Document how to troubleshoot Penpot (#5937)
This commit is contained in:
parent
15d09eb0d4
commit
aac61ff229
4 changed files with 59 additions and 0 deletions
BIN
docs/img/dev-tools-1.png
Normal file
BIN
docs/img/dev-tools-1.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 56 KiB |
BIN
docs/img/dev-tools-2.png
Normal file
BIN
docs/img/dev-tools-2.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 41 KiB |
BIN
docs/img/penpot-report.png
Normal file
BIN
docs/img/penpot-report.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 132 KiB |
|
@ -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
|
clips). There may be more volumes if you enable other features, as explained in the file
|
||||||
itself.
|
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 <code class="language-bash">Console</code>, you can see the exact version that's being used.
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<a href="/img/dev-tools-1.png" target="_blank">
|
||||||
|
<img src="/img/dev-tools-1.png" alt="Devtools > Console" />
|
||||||
|
</a>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
Other interesting tab in the devtools is the <code class="language-bash">Network</code> tab, to check if there is a request that throws errors.
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<a href="/img/dev-tools-2.png" target="_blank">
|
||||||
|
<img src="/img/dev-tools-2.png" alt="Devtools > Network" />
|
||||||
|
</a>
|
||||||
|
</figure>
|
||||||
|
|
||||||
|
**Penpot Report**
|
||||||
|
|
||||||
|
When Penpot crashes, it provides a report with very useful information. Don't miss it!
|
||||||
|
|
||||||
|
<figure>
|
||||||
|
<a href="/img/penpot-report.png" target="_blank">
|
||||||
|
<img src="/img/penpot-report.png" alt="Penpot report" />
|
||||||
|
</a>
|
||||||
|
</figure>
|
||||||
|
|
||||||
## Install with Kubernetes
|
## Install with Kubernetes
|
||||||
|
|
||||||
|
|
Loading…
Add table
Reference in a new issue