mirror of
https://github.com/zadam/trilium.git
synced 2025-11-01 19:05:59 +01:00
chore(edit-docs): move Markdown documentation outside src for now
This commit is contained in:
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 583 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 188 KiB |
@@ -0,0 +1,18 @@
|
||||
# Anonymized Database
|
||||

|
||||
|
||||
In certain scenarios, understanding the structure of a database is crucial for troubleshooting issues. However, sharing your actual [database](../Advanced%20Usage/Database.md) file with personal notes is not advisable. To address this, Trilium offers a feature to anonymize the database. This feature can be accessed via Menu -> Options -> Advanced tab.
|
||||
|
||||
This feature creates a copy of your database with all sensitive data removed. Specifically, it strips out note titles, contents, revisions, history, and some non-system attributes while retaining the overall structure and metadata, such as modification dates. After anonymization, the database undergoes a [vacuuming process](https://sqlite.org/lang_vacuum.html) to ensure no sensitive data remnants remain in the file. The anonymized database is saved in the `anonymized` directory within the [data directory](../Installation%20%26%20Setup/Data%20directory.md), making it safe to share with bug reports.
|
||||
|
||||
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](../Installation%20%26%20Setup/Data%20directory.md)). You can safely attach it to a bug report.
|
||||
|
||||
## Command Line Anonymization
|
||||
|
||||
If your [database](../Advanced%20Usage/Database.md) is corrupted to the point where Trilium cannot start, the anonymization process can still be executed via the command line:
|
||||
|
||||
```
|
||||
node src/anonymize.js
|
||||
```
|
||||
|
||||
Run this command from the directory containing Trilium's source files, typically found in the `resources/app` directory for desktop builds.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 100 KiB |
39
docs/User Guide/User Guide/Troubleshooting/Error logs.md
Normal file
39
docs/User Guide/User Guide/Troubleshooting/Error logs.md
Normal file
@@ -0,0 +1,39 @@
|
||||
# Error logs
|
||||
It's important to provide all available error logs together with bug reports. This page will show you how to do it.
|
||||
|
||||
## Backend logs
|
||||
|
||||
Open [data directory](../Installation%20%26%20Setup/Data%20directory.md), go to `log` subdirectory and find the latest log file, e.g. `trilium-2022-12-14.log`. You can attach the whole file to the bug report (preferable) or open it and copy-paste only the last lines / lines you believe are relevant.
|
||||
|
||||
If you have trouble finding it the log files, there's also an in-app option in top-left menu button -> Advanced -> Show backend log.
|
||||
|
||||
## Frontend logs
|
||||
|
||||
To provide frontend logs, we need to open the Developer Console. Often the easiest way is to press `CTRL-SHIFT-I` which should work in most browsers (and desktop app). Make sure that the error producing action happened right before you copy&paste the errors, the console is cleared on app restart.
|
||||
|
||||
If that doesn't work, then:
|
||||
|
||||
* in Trilium desktop app, go to top-left menu button -> Advanced -> Open Dev Tools
|
||||
* In Firefox/Chrome right-click anywhere in the page and click Inspect:
|
||||
|
||||

|
||||
|
||||
Once you have Dev Tools open, click on "Console" tab:
|
||||
|
||||

|
||||
|
||||
Copy-paste (or screenshot) the logs. It's better to provide not just errors, but the whole log, which might provide context while analyzing the bug.
|
||||
|
||||
## Providing sensitive data
|
||||
|
||||
If you don't feel comfortable attaching the logs or anything sensitive to the public GitHub issues, feel free to contact the devs in our Matrix [support channel](https://github.com/TriliumNext/Notes#-discuss-with-us).
|
||||
|
||||
Use this email to also provide anything which could assist in analysing the bug - e.g. files/images/ZIPs being imported or [anonymized database](Anonymized%20Database.md).
|
||||
|
||||
### Exporting note subtree for reproduction
|
||||
|
||||
Often times, bugs manifest themselves in specific notes and having them would greatly ease reproduction and fixing.
|
||||
|
||||
In such case, please export the relevant note subtree by right-clicking it on the left tree, choosing Export - HTML as ZIP:
|
||||
|
||||

|
||||
BIN
docs/User Guide/User Guide/Troubleshooting/Error logs_image.png
Normal file
BIN
docs/User Guide/User Guide/Troubleshooting/Error logs_image.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 136 KiB |
@@ -0,0 +1,4 @@
|
||||
# Reporting issues
|
||||
Go to [Issues · TriliumNext/Notes](https://github.com/TriliumNext/Notes/issues) and press “New issue”.
|
||||
|
||||
If you are reporting a bug, select “Bug Report” and fill in the details.
|
||||
@@ -0,0 +1,21 @@
|
||||
# Synchronization fails with 504 Gateway Timeout
|
||||
Synchronization can sometimes take a long amount of time in order to compute the items that require update. When running behind a reverse proxy, the request can time out.
|
||||
|
||||
The solution is to increase the timeout at proxy level.
|
||||
|
||||
## Nginx
|
||||
|
||||
Add the following to the configuration file:
|
||||
|
||||
```conf
|
||||
proxy_connect_timeout 300;
|
||||
proxy_send_timeout 300;
|
||||
proxy_read_timeout 300;
|
||||
send_timeout 300;
|
||||
```
|
||||
|
||||
And restart the server.
|
||||
|
||||
See [Nginx Proxy Setup](../Installation%20%26%20Setup/Server%20Installation/2.%20Reverse%20proxy/Nginx.md) for more information about the Nginx setup.
|
||||
|
||||
If it still doesn't work, try increasing the timeout.
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 212 KiB |
@@ -0,0 +1,16 @@
|
||||
# "TriliumNext Notes" Not Opened
|
||||

|
||||
|
||||
When running TriliumNext for the first time or updating to a newer version, macOS will prevent its execution.
|
||||
|
||||
On older versions of macOS it was possible to bypass this step simply by right clicking and selecting Open, which would show a button to run anyway. This got removed since macOS 15.0.
|
||||
|
||||
To bypass this issue, follow these steps:
|
||||
|
||||
1. Go to System Settings → Privacy & Security and look for the “Security” section.
|
||||
2. There should be a “TriliumNext Notes was blocked to protect your Mac” item. Simply click “Open Anyway”.
|
||||
3. Select “Open Anyway” and proceed with the authentication. Afterwards the application should start on its own.
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| <br><br>The privacy settings in “System Settings”, showing the alert that TriliumNext was blocked. | <br><br>The confirmation screen to bypass the run restrictions. |
|
||||
Reference in New Issue
Block a user