gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2025-06-06 18:08:33 +02:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated Troubleshooting (markdown)

zadam 2022-01-10 19:46:14 +01:00
parent 7e13ddbdee
commit 3eb66f7681
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
Troubleshooting.md

@ -4,9 +4,9 @@ Trilium is currently beta quality software, so it's quite expected there will be
You guessed it - it's restart.
If there's a UI problem, it usually means that the Trilium frontend got into inconsistent state and is acting up. Easiest way to fix it is to reload the application - just press `CTRL-R` and frontend will be reloaded.
If there's a UI problem, it usually means that the Trilium frontend got into an inconsistent state and is acting up. The easiest way to fix it is to reload the application - just press `CTRL-R` and frontend will be reloaded.
If this still doesn't help, or you suspect it's actually backend issue, you can restart the whole application - in case of desktop (Electron) build, you just close the window and re-open it again.
If this still doesn't help, or you suspect it's actually a backend issue, you can restart the whole application - in case of desktop (Electron) build, you just close the window and re-open it again.
## Forgotten username/password
@ -35,9 +35,9 @@ If you decide to continue using the existing document file, don't forget to chan
## Broken note crashes Trilium
Sometimes a particular problem can cause issues for Trilium (e.g. render note with faulty script) and causes Trilium to crash. But since Trilium will normally try to load previously open notes, it will attempt to load again the note causing the crash again.
Sometimes a particular problem can cause issues for Trilium (e.g. render note with faulty script) and causes Trilium to crash. But since Trilium will normally try to load previously open notes, it will attempt to load again the note, causing the crash again.
To break out of this vicious cycle you can specify `TRILIUM_START_NOTE_ID` environment variable which will reset the open tabs to only one with the specified note ID (just use `root`). In linux you could use it like this:
To break out of this vicious cycle, you can specify `TRILIUM_START_NOTE_ID` environment variable, which will reset the open tabs to only one with the specified note ID (just use `root`). In linux you could use it like this:
```bash
TRILIUM_START_NOTE_ID=root ./trilium
@ -45,13 +45,13 @@ TRILIUM_START_NOTE_ID=root ./trilium
## Sync and consistency checks
Trilium periodically checks logical consistency of the database (e.g. that every note should have a parent). If some inconsistency is detected, user is notified on the UI about the inconsistency.
Trilium periodically checks logical consistency of the database (e.g. that every note should have a parent). If some inconsistency is detected, the user is notified on the UI about the inconsistency.
In such case, it is recommended to file a bug report and attach anonymized database (see below).
## Broken script prevents application startup
If you experiment with scripting, it might happen that you create a script which crashes whole Trilium. That's even worse if you set it as a startup script or in an active [[custom widget]].
If you experiment with scripting, it might happen that you create a script which crashes the whole Trilium. That's even worse if you set it as a startup script or in an active [[custom widget]].
In such cases you can start Trilium in "safe mode" which will not execute any custom scripts:
@ -61,7 +61,7 @@ TRILIUM_SAFE_MODE=true ./trilium
## Restoring backup
Trilium makes regular automatic backup so When things go really bad we might need the last option - [[restore backup|Backup#restoring-backup]].
Trilium makes regular automatic backup, so When things go really bad we might need the last option - [[restore backup|Backup#restoring-backup]].
## Reporting bugs
@ -69,7 +69,7 @@ It's a great help to send bug reports. Here are some tips where to look at:
Trilium uses GitHub issues - so please send your reports here: https://github.com/zadam/trilium/issues
**To be clear, following are not required for each and every bug report, but may be asked for on per-issue basis.**
**To be clear, the following are not required for each and every bug report, but may be asked for on per-issue basis.**
### Browser console
@ -79,15 +79,15 @@ All JavaScript errors should be also logged to backend logs, but it's possible s
### Backend logs
Trilium logs important events and errors into `logs` directory (inside [[data directory]]). These logs are very helpful in debugging problems so please attach the latest ones with your bug report. You don't have to worry, they don't contain any sensitive information about your notes.
Trilium logs important events and errors into `logs` directory (inside [[data directory]]). These logs are very helpful in debugging problems, so please attach the latest ones with your bug report. You don't have to worry, they don't contain any sensitive information about your notes.
### Anonymized database
In some cases it's necessary to see the database structure to be able to debug the problem. Of course, we can't ask you to send us your [[document|Document]] file with your notes.
In some cases, it's necessary to see the database structure to be able to debug the problem. Of course, we can't ask you to send us your [[document|Document]] file with your notes.
For this Trilium supports anonymization of the database - you can trigger this in Options -> Advanced tab.
For this, Trilium supports anonymization of the database - you can trigger this in Options -> Advanced tab.
This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options, and non-system attributes) while leaving all structure and metadata (e.g. date of last change). After this is done, database is [VACUUMed](https://sqlite.org/lang_vacuum.html) to make sure there's no stale sensitive data in the document file. Resulting file is stored in `anonymized` directory (placed in the [[data directory]]). You can safely attach it with your bug report.
This will create a copy of your document and remove all sensitive data (currently note titles, contents, revisions, history and some of the options, and non-system attributes) while leaving all structure and metadata (e.g. date of last change). After this is done, the database is [VACUUMed](https://sqlite.org/lang_vacuum.html) to make sure there's no stale sensitive data in the document file. The resulting file is stored in `anonymized` directory (placed in the [[data directory]]). You can safely attach it with your bug report or send it to zadam.apps@gmail.com
#### Command line anonymization