Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
feat(mobile/text): offer code block, quote and admonition under +
Elian Doran26cd0c8e4081
diff --git a/apps/client/src/widgets/type_widgets/text/toolbar.spec.ts b/apps/client/src/widgets/type_widgets/text/toolbar.spec.tsindex f8191162b5..09d37a565d 100644--- a/apps/client/src/widgets/type_widgets/text/toolbar.spec.ts+++ b/apps/client/src/widgets/type_widgets/text/toolbar.spec.ts@@ -124,7 +124,7 @@ describe("group labels", () => {});describe("buildMobileToolbar", () => {- it("nests only the insert menu, which holds the least used insertions", () => {+ it("nests only the insert menu, which holds the least used insertions and the wrapping blocks", () => {const { toolbar, textFormattingToolbar } = buildMobileToolbar(true);const groups = (toolbar.items as unknown[]).filter((item) => typeof item !== "string");expect(groups).toStrictEqual([ {@@ -132,6 +132,8 @@ describe("buildMobileToolbar", () => {icon: "plus",asMenu: { layout: "tiles" },items: [+ "codeBlock", "blockQuote", "admonition",+ "|","collapsible", "tabs", "multicolumnLayout","|","horizontalLine", "pageBreak", "footnote",@@ -199,9 +201,6 @@ describe("buildMobileToolbar", () => {bulletedList: "blockType",numberedList: "blockType",todoList: "blockType",- codeBlock: "blockType",- blockQuote: "blockType",- admonition: "blockType",fontSize: "fontSizeMenu",fontColor: "colorMenu",imageUpload: "attachMenu",diff --git a/apps/client/src/widgets/type_widgets/text/toolbar.ts b/apps/client/src/widgets/type_widgets/text/toolbar.tsindex fda161e630..549fd26eda 100644--- a/apps/client/src/widgets/type_widgets/text/toolbar.ts+++ b/apps/client/src/widgets/type_widgets/text/toolbar.ts@@ -60,6 +60,9 @@ export function buildMobileToolbar(aiAssistant: boolean) {// Groups of three fill the rows of tiles.asMenu: { layout: "tiles" },items: [+ // Also in the block type menu, where a reader might not look for them.+ "codeBlock", "blockQuote", "admonition",+ "|","collapsible", "tabs", "multicolumnLayout","|","horizontalLine", "pageBreak", "footnote",diff --git a/apps/server/src/assets/help/help_content.json b/apps/server/src/assets/help/help_content.jsonindex 8d7e71784b..bbd76d38f2 100644--- a/apps/server/src/assets/help/help_content.json+++ b/apps/server/src/assets/help/help_content.json@@ -29,7 +29,7 @@"_help_yeEaYqosGLSh": "<p>As an alternative to <a href=\"#root/_help_Dgg7bR3b6K9j\">hosting your own Trilium instance</a>, there are two services out there that provide out of the box support for Trilium.</p><aside class=\"admonition important\"><p><strong>Disclaimer</strong>: The Trilium Notes project and maintainers are not directly affiliated with either of the projects.</p><p>PikaPods have gracefully offered us free credits for testing purposes.</p></aside><h2>Cloud instance providers</h2><h3>PikaPods</h3><ol><li>Go to <a href=\"https://www.pikapods.com\">pikapods.com</a> and sign up.</li><li>In the “Available Apps” section, look for \"TriliumNext<br> and select “Run your own”.</li><li>Follow the on-screen instructions to set up your own cloud hosted instance.</li></ol><p>PikaPods generally updates their Trilium instances to the latest version within a two-week interval after a new version is released.</p><h2>Matching your version with the cloud instance</h2><p>Please note that once you set up <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> between a cloud instance and <a href=\"#root/_help_poXkQfguuA0U\">desktop</a> clients, it's important that the version of the desktop application and the server match up.</p><p>When setting up a cloud instance, it's best to check the version of the server by accessing it via a web browser and going to the <em>About</em> section. It's best that both the desktop and the server have the same <em>App version</em>; however it's generally OK to update the desktop to a newer version than the server if it has the same <em>Sync version</em>.</p><p>If the <em>Sync version</em> between the server and the desktop application doesn't match, synchronization will not work.</p>","_help_iGTnKjubbXkA": "<ul><li>Using Docker, the server can be run on Windows, Linux and macOS devices.</li><li>Native binaries are provided for Linux x64 and ARM (<code>aarch64</code>).</li></ul><h2>Legacy ARM support</h2><p>The Docker builds also provide <code>linux/arm/v7</code> and <code>linux/arm/v8</code> platforms. These platforms are considered legacy since Trilium uses Node.js version 24 which have <a href=\"https://github.com/nodejs/node/commit/6682861d6f\">officially downgraded support</a> for these platforms to “experimental”.</p><p>As a result, Trilium needs to use Node.js 22 for these versions. As soon as soon Node.js 22 will no longer be compatible, support for <code>armv7</code> and <code>armv8</code> will be dropped entirely.</p><p>Regardless of upstream support, these platforms are supported on a best-effort basis and are not officially supported by the Trilium development team. Bug reports are accepted but they will not be treated with priority; contributions are welcome.</p>","_help_cbkrhQjrkKrh": "<p>Trilium is an offline-first note-taking application that stores all data locally on the desktop client. However, it also offers the option to set up synchronization with a server instance, allowing multiple desktop clients to sync with a central server. This creates a star-shaped topology:</p><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_image.jpg\"></p><p>In this setup, a central server (referred to as the <em>sync server</em>) and multiple <em>client</em> (or <em>desktop</em>) instances synchronize with the sync server. Once configured, synchronization is automatic and ongoing, requiring no manual intervention.</p><h2>Setting Up Synchronization</h2><h3>Security Considerations</h3><p>Setting up the server securely is critical and can be complex. It is crucial to use a valid <a href=\"#root/_help_l2VkvOwUNfZj\">TLS certificate</a> (HTTPS) rather than an unencrypted HTTP connection to ensure security and avoid potential vulnerabilities.</p><h3>Synchronizing a Desktop Instance with a Sync Server</h3><p>This method is used when you already have a desktop instance of Trilium and want to set up a sync server on your web host.</p><ol><li><strong>Server Deployment</strong>: Ensure your server instance is deployed but uninitialized.</li><li><strong>Desktop Configuration</strong>: Open your desktop instance, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Sync</em> → <em>Sync server</em>, and set the <em>Server address</em> to your sync server's address.<ul><li>Note that the sync server can also be overridden through <a class=\"reference-link\" href=\"#root/_help_Gzjqa934BdH4\">Configuration (config.ini or environment variables)</a>, case in which that value takes precedence. If that's the case, a field called <em>Server in use</em> indicates it.</li></ul></li><li><strong>Testing Sync</strong>: Click the <em>Test sync</em> button to verify the connection to the sync server.<ul><li>If successful, the client will start pushing all data to the server instance.</li><li>This process may take some time, but you can continue using Trilium. Periodically check the server instance to confirm when the sync is complete. Once finished, you should see the login screen on the server.</li></ul></li></ol><h3>Synchronizing a Desktop Instance from a Sync Server</h3><p>This method is used when you already have a sync server and want to configure a new desktop instance to sync with it.</p><ol><li><strong>Desktop Setup</strong>: Follow the <a href=\"#root/_help_poXkQfguuA0U\">desktop installation page</a>.</li><li><strong>Initial Configuration</strong>: When prompted, choose the option to set up sync with a sync server.</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_sync-init.png\" alt=\"screenshot of the sync from server setup page\"></p><ol><li><strong>Server Details</strong>: Configure the Trilium server address and enter the server's password. If the server has <a class=\"reference-link\" href=\"#root/_help_7DAiwaf8Z7Rz\">Multi-factor authentication with TOTP</a> enabled, also enter a one-time password from your authenticator app, or a recovery code.</li><li><strong>Finish Setup</strong>: Click the \"Finish setup\" button. If successful, you will see the following screen:</li></ol><p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Synchronization_sync-in-progress.png\" alt=\"screenshot of the sync page\"></p><p>Once synchronization is complete, you will be automatically redirected to the Trilium application.</p><h3>Desktop-to-desktop sync</h3><p>This method allows two desktop instances to synchronize between each other without requiring a <a class=\"reference-link\" href=\"#root/_help_WOcw2SLH6tbX\">Server Installation</a>.</p><aside class=\"admonition warning\"><p>Since v0.104.0, LAN access needs to be enabled to allow this sync to function. See <a class=\"reference-link\" href=\"#root/_help_swSFivWk6KkA\">Network Access</a> for information on how to do so.</p></aside><h2>Proxy Configuration</h2><p>Two proxy setups are supported:</p><ul><li><strong>Explicit Proxy Configuration</strong>: Set the proxy server in Options / Sync. Only unauthenticated proxy servers are supported.</li><li><strong>System Proxy Settings</strong>: If no proxy server is explicitly configured, Trilium will use the system proxy settings.</li></ul><h2>Troubleshooting</h2><h3>Date/Time Synchronization</h3><p>For successful synchronization, both client and server must have the same date and time, with a tolerance of up to five minutes.</p><h3>Certificate Issues</h3><p>When using TLS, Trilium will verify the server certificate. If verification fails (e.g., due to self-signed certificates or certain corporate proxies), you can run the Trilium client with the <code>NODE_TLS_REJECT_UNAUTHORIZED</code> environment variable set to <code>0</code>:</p><pre><code class=\"language-text-x-trilium-auto\">export NODE_TLS_REJECT_UNAUTHORIZED=0</code></pre><p>This will disable TLS certificate verification, significantly reducing security and exposing the setup to MITM attacks. It is strongly recommended to use a valid signed server certificate. Newer Trilium versions include a script called <code>trilium-no-cert-check.sh</code> for this purpose.</p><h3>Conflict Resolution</h3><p>If you edit the same note on multiple instances before synchronization, Trilium resolves conflicts by retaining the newer change and discarding the older one. The older version remains accessible in <a href=\"#root/_help_vZWERwf8U3nx\">note revisions</a>, allowing data recovery if needed.</p><h3>Hash Check</h3><p>After each synchronization, Trilium computes a hash of all synced data on both the client and the sync server. If there is a discrepancy, Trilium will automatically initiate a recovery mechanism to resolve the issue.</p>",- "_help_RDslemsQ6gCp": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.52%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend_IMG_1765.PNG\" width=\"1242\" height=\"2688\"></figure><p>Trilium has a mobile web frontend which is optimized for touch based devices - smartphones and tablets. It is activated automatically during login process based on browser detection.</p><p>Mobile frontend is limited in features compared to the full desktop version. See below for more details on this.</p><h2>Layout basics</h2><p>Unlike the desktop version, the mobile version has a slightly different UI meant to better fit the constrained screens of a mobile phone.</p><p>Here is a non-exhaustive list of differences between the desktop version and the mobile one:</p><ul><li>The <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.<ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> bar is also displayed at the top of the note tree.</li><li>The full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> function can be triggered either from either the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> or from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</li><li>The <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> is shorter: <em>Open new window</em> and <em>Show cheatsheet</em> are left out, and <em>Switch to desktop version</em> is under <em>Advanced</em>.</li><li>The <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> is displayed at the bottom of the screen.<ul><li>The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.</li></ul></li><li>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</li><li>In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. It starts with <em>Undo</em> and <em>Redo</em>, since the on-screen keyboard has no keys for them. The <span class=\"tn-icon cke cke-plus\"></span> button after them opens the less common insertions as tiles at the bottom of the screen: collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import. The tiles marked with <span class=\"tn-icon bx bx-chevron-right\"></span> open a list of choices: <em>Columns</em> the number of columns, <em>Footnote</em> a new footnote or a reference to an existing one, <em>Date/time</em> the format of the date and time, and <em>Insert text snippet</em> the template to insert, which is grayed out while there are none. The block type button shows the type of the current block as an icon rather than its name, and opens the block types as tiles at the bottom of the screen, with the current one highlighted: paragraph and heading 2 to 6, then bulleted list, numbered list and to-do list, then code block, block quote and admonition. Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it. Typing <code>-</code> , <code>1.</code> or <code>[ ]</code> at the start of a line also starts a list. The style of a list (such as roman numerals) and its start number can only be changed on desktop. The <span class=\"tn-icon cke cke-trilium-ai\"></span> AI assistant button, shown once a provider is configured, opens its quick actions as a menu at the bottom of the screen, with <em>Ask AI…</em> at its top. The alignment button shows the alignment of the current block, and opens left, center, right and justify as a row of tiles, with the current one highlighted. The <span class=\"tn-icon cke cke-paper-clip\"></span> button replaces the separate image upload and attach file buttons: it opens <em>Image</em>, <em>Attach and embed file</em> and <em>Attach file as a link</em> as a row of tiles, each of which opens the device's file picker. The <span class=\"tn-icon cke cke-table\"></span> table button opens common table sizes as tiles.<ul><li>The formatting applied to text (bold, italic, underline, strikethrough, inline code, superscript and subscript, keyboard shortcut, font size and colors, and removing formatting) is on a row of its own, which ends with <span class=\"tn-icon cke cke-trilium-scissors\"></span> to cut the selection into a sub-note. Tap <span class=\"tn-icon cke cke-text\"></span> next to the block type button to show it, and <span class=\"tn-icon cke cke-previous-arrow\"></span> at its start to return to the main row. Selecting text shows this row on its own, and it goes back to the main row once the selection is gone (for example as you start typing), unless you opened or closed the row yourself in the meantime. The font size button opens the list of sizes as a menu at the bottom of the screen, each drawn at its size, with the current one checked. A single color button replaces the separate text and background color buttons: it opens a menu with a row of colors for the text and one for its background, each with a cell that removes the color and one that opens the device's color picker.</li></ul></li><li>While the on-screen keyboard is open, a <span class=\"tn-icon bx bxs-keyboard\"></span> button in the bottom-right corner, just above the keyboard, hides it. In a text note, the button is at the right end of the formatting toolbar. While a menu of the formatting toolbar is open in place of the keyboard, the button becomes a <span class=\"tn-icon bx bx-x\"></span>, which closes the menu and brings the keyboard back. This works in every note type and in every text field, and is the only way to hide the keyboard in the iOS app, where the keyboard has no <em>Done</em> button.</li><li>The <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a> are grouped under a tab switcher in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.</li><li>Since v0.100.0, <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span> iOS with Safari</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the […] button in the bottom-right of the screen and select Share.</li><li>Scroll down to reveal the full list of items and choose <em>Add to Home Screen</em>.</li><li>Press <em>Add</em> and the web app will be available.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Android with Google Chrome</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Google Chrome requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the top-right of the screen and select <em>Add to Home screen.</em></li><li>Select the <em>Install</em> option.</li><li>Select an appropriate name.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Android with Brave</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Brave requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the bottom-right of the screen and select <em>Add to Home screen</em>.</li><li>Press the <em>Install</em> option.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Samsung Browser</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the hamburger menu in the bottom-right of the screen.</li><li>Select <em>Add to</em>, followed by <em>Home screen</em>.</li><li>Press <em>Add</em> and the web app will appear on the home page.</li></ol></div></section></div><h2>Sharing to Trilium</h2><p>Once installed as a PWA on Android, Trilium appears in the system's share menu, so links, text, images and other files can be sent to it from other apps. Shared content is saved to the <a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, and Trilium opens the note it created:</p><ul><li>Text or a link becomes a text note. A shared link is also stored in the <code>#pageUrl</code> label.</li><li>A single file becomes an image note or a file note, placed directly in the inbox.</li><li>Several files, or files shared together with text, are placed under a new text note that holds the text.</li></ul><p>Every note created this way carries the <code>#clipType=share</code> label, which gives a shared text note the <span class=\"tn-icon bx bx-share\"></span> icon unless the note has an <code>#iconClass</code> of its own. A single share can carry at most 20 files.</p><aside class=\"admonition note\"><p>Sharing requires being logged in. If the session has expired, log in again and share once more.</p></aside><h2>Testing via the desktop application</h2><p>If you are running Trilium without a dedicated <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a>, you can still test the mobile application using the desktop application. For more information, see <a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code>http://<ip>:37840/login?mobile</code> .</p><h2>Forcing mobile/desktop frontend</h2><p>Trilium decides automatically whether to use mobile or desktop front-end. If this is not appropriate, you can use <code>?mobile</code> or <code>?desktop</code> query param on <strong>login</strong> page (Note: you might need to log out).</p><p>Alternatively, simply select <em>Switch to mobile version</em> in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. In the mobile version, select <em>Advanced</em> → <em>Switch to desktop version</em> there instead.</p><h2>Scripting</h2><p>You can alter the behavior with <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, just like for normal frontend. For script notes to be executed, they need to have labeled <code>#run=mobileStartup</code>.</p><p>Custom <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> widgets are also supported.</p>",+ "_help_RDslemsQ6gCp": "<figure class=\"image image-style-align-right image_resized\" style=\"width:33.52%;\"><img style=\"aspect-ratio:1242/2688;\" src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Mobile%20Frontend_IMG_1765.PNG\" width=\"1242\" height=\"2688\"></figure><p>Trilium has a mobile web frontend which is optimized for touch based devices - smartphones and tablets. It is activated automatically during login process based on browser detection.</p><p>Mobile frontend is limited in features compared to the full desktop version. See below for more details on this.</p><h2>Layout basics</h2><p>Unlike the desktop version, the mobile version has a slightly different UI meant to better fit the constrained screens of a mobile phone.</p><p>Here is a non-exhaustive list of differences between the desktop version and the mobile one:</p><ul><li>The <a class=\"reference-link\" href=\"#root/_help_oPVyFC7WL2Lp\">Note Tree</a> is displayed as a sidebar. To display the sidebar, press the button in the top-left of the screen.<ul><li>There is also a swipe gesture that can be done from the left of the screen, but the browser's navigation gesture interferes with it most of the time (depending on the platform).</li><li>Press and hold a note to display the <a class=\"reference-link\" href=\"#root/_help_YtSN43OrfzaA\">Note tree contextual menu</a>.</li></ul></li><li>The <a class=\"reference-link\" href=\"#root/_help_Ms1nauBra7gq\">Quick search</a> bar is also displayed at the top of the note tree.</li><li>The full <a class=\"reference-link\" href=\"#root/_help_eIg8jdvaoNNd\">Search</a> function can be triggered either from either the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> or from the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, if configured.</li><li>The <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a> is shorter: <em>Open new window</em> and <em>Show cheatsheet</em> are left out, and <em>Switch to desktop version</em> is under <em>Advanced</em>.</li><li>The <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> is displayed at the bottom of the screen.<ul><li>The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.</li></ul></li><li>Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.</li><li>In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. It starts with <em>Undo</em> and <em>Redo</em>, since the on-screen keyboard has no keys for them. The <span class=\"tn-icon cke cke-plus\"></span> button after them opens insertions as tiles at the bottom of the screen: code block, block quote and admonition (also in the block type button), then the less common collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import. The tiles marked with <span class=\"tn-icon bx bx-chevron-right\"></span> open a list of choices: <em>Code block</em> the language, <em>Admonition</em> its type, <em>Columns</em> the number of columns, <em>Footnote</em> a new footnote or a reference to an existing one, <em>Date/time</em> the format of the date and time, and <em>Insert text snippet</em> the template to insert, which is grayed out while there are none. The block type button shows the type of the current block as an icon rather than its name, and opens the block types as tiles at the bottom of the screen, with the current one highlighted: paragraph and heading 2 to 6, then bulleted list, numbered list and to-do list, then code block, block quote and admonition. Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it. Typing <code>-</code> , <code>1.</code> or <code>[ ]</code> at the start of a line also starts a list. The style of a list (such as roman numerals) and its start number can only be changed on desktop. The <span class=\"tn-icon cke cke-trilium-ai\"></span> AI assistant button, shown once a provider is configured, opens its quick actions as a menu at the bottom of the screen, with <em>Ask AI…</em> at its top. The alignment button shows the alignment of the current block, and opens left, center, right and justify as a row of tiles, with the current one highlighted. The <span class=\"tn-icon cke cke-paper-clip\"></span> button replaces the separate image upload and attach file buttons: it opens <em>Image</em>, <em>Attach and embed file</em> and <em>Attach file as a link</em> as a row of tiles, each of which opens the device's file picker. The <span class=\"tn-icon cke cke-table\"></span> table button opens common table sizes as tiles.<ul><li>The formatting applied to text (bold, italic, underline, strikethrough, inline code, superscript and subscript, keyboard shortcut, font size and colors, and removing formatting) is on a row of its own, which ends with <span class=\"tn-icon cke cke-trilium-scissors\"></span> to cut the selection into a sub-note. Tap <span class=\"tn-icon cke cke-text\"></span> next to the block type button to show it, and <span class=\"tn-icon cke cke-previous-arrow\"></span> at its start to return to the main row. Selecting text shows this row on its own, and it goes back to the main row once the selection is gone (for example as you start typing), unless you opened or closed the row yourself in the meantime. The font size button opens the list of sizes as a menu at the bottom of the screen, each drawn at its size, with the current one checked. A single color button replaces the separate text and background color buttons: it opens a menu with a row of colors for the text and one for its background, each with a cell that removes the color and one that opens the device's color picker.</li></ul></li><li>While the on-screen keyboard is open, a <span class=\"tn-icon bx bxs-keyboard\"></span> button in the bottom-right corner, just above the keyboard, hides it. In a text note, the button is at the right end of the formatting toolbar. While a menu of the formatting toolbar is open in place of the keyboard, the button becomes a <span class=\"tn-icon bx bx-x\"></span>, which closes the menu and brings the keyboard back. This works in every note type and in every text field, and is the only way to hide the keyboard in the iOS app, where the keyboard has no <em>Done</em> button.</li><li>The <a class=\"reference-link\" href=\"#root/_help_3seOhtN8uLIY\">Tabs</a> are grouped under a tab switcher in the <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.</li><li>Since v0.100.0, <a class=\"reference-link\" href=\"#root/_help_luNhaphA37EO\">Split View</a> can also be used in mobile view, but with a maximum of two panes at once. The splits are displayed vertically instead of horizontally.</li></ul><h2>Installing as a PWA</h2><p>The mobile view can be set up as a PWA. While this does not offer any offline capabilities, it will display the application in full-screen and makes it easy to access via your mobile phone's home screen.</p><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-apple\"></span> iOS with Safari</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the […] button in the bottom-right of the screen and select Share.</li><li>Scroll down to reveal the full list of items and choose <em>Add to Home Screen</em>.</li><li>Press <em>Add</em> and the web app will be available.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Android with Google Chrome</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Google Chrome requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the top-right of the screen and select <em>Add to Home screen.</em></li><li>Select the <em>Install</em> option.</li><li>Select an appropriate name.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Android with Brave</p><div class=\"trilium-tab-panel\"><aside class=\"admonition important\"><p>Brave requires the server to be served over HTTPS in order to display in full-screen. If using HTTP, the app will appear like a normal web page (similar to a bookmark).</p></aside><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the three vertical dots icon in the bottom-right of the screen and select <em>Add to Home screen</em>.</li><li>Press the <em>Install</em> option.</li><li>The web app will appear as an application, not on the home screen.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\">Samsung Browser</p><div class=\"trilium-tab-panel\"><ol><li>Open your default web browser and access your Trilium instance.</li><li>Login.</li><li>Press the hamburger menu in the bottom-right of the screen.</li><li>Select <em>Add to</em>, followed by <em>Home screen</em>.</li><li>Press <em>Add</em> and the web app will appear on the home page.</li></ol></div></section></div><h2>Sharing to Trilium</h2><p>Once installed as a PWA on Android, Trilium appears in the system's share menu, so links, text, images and other files can be sent to it from other apps. Shared content is saved to the <a class=\"reference-link\" href=\"#root/_help_S0Fos78ZfcY7\">Note Inbox</a>, and Trilium opens the note it created:</p><ul><li>Text or a link becomes a text note. A shared link is also stored in the <code>#pageUrl</code> label.</li><li>A single file becomes an image note or a file note, placed directly in the inbox.</li><li>Several files, or files shared together with text, are placed under a new text note that holds the text.</li></ul><p>Every note created this way carries the <code>#clipType=share</code> label, which gives a shared text note the <span class=\"tn-icon bx bx-share\"></span> icon unless the note has an <code>#iconClass</code> of its own. A single share can carry at most 20 files.</p><aside class=\"admonition note\"><p>Sharing requires being logged in. If the session has expired, log in again and share once more.</p></aside><h2>Testing via the desktop application</h2><p>If you are running Trilium without a dedicated <a href=\"#root/_help_WOcw2SLH6tbX\">server installation</a>, you can still test the mobile application using the desktop application. For more information, see <a class=\"reference-link\" href=\"#root/_help_nRqcgfTb97uV\">Using the desktop application as a server</a>. To access it go to <code>http://<ip>:37840/login?mobile</code> .</p><h2>Forcing mobile/desktop frontend</h2><p>Trilium decides automatically whether to use mobile or desktop front-end. If this is not appropriate, you can use <code>?mobile</code> or <code>?desktop</code> query param on <strong>login</strong> page (Note: you might need to log out).</p><p>Alternatively, simply select <em>Switch to mobile version</em> in the <a class=\"reference-link\" href=\"#root/_help_x3i7MxGccDuM\">Global menu</a>. In the mobile version, select <em>Advanced</em> → <em>Switch to desktop version</em> there instead.</p><h2>Scripting</h2><p>You can alter the behavior with <a class=\"reference-link\" href=\"#root/_help_CdNpE2pqjmI6\">Scripting</a>, just like for normal frontend. For script notes to be executed, they need to have labeled <code>#run=mobileStartup</code>.</p><p>Custom <a class=\"reference-link\" href=\"#root/_help_xYmIYSP6wE3F\">Launch Bar</a> widgets are also supported.</p>","_help_MtPxeAWVAzMg": "<p><img src=\"{{helpAssets}}/User%20Guide/Installation%20%26%20Setup/Web%20Clipper_image.png\"></p><p>Trilium Web Clipper is a web browser extension which allows user to clip text, screenshots, whole pages and short notes and save them directly to Trilium Notes.</p><h2>Supported browsers</h2><p>Trilium Web Clipper officially supports the following web browsers:</p><ul><li>Mozilla Firefox, using Manifest v2.</li><li>Google Chrome, using Manifest v3. Theoretically the extension should work on other Chromium-based browsers as well, but they are not officially supported.</li></ul><h2>Obtaining the extension</h2><p>The extension is available from the official browser web stores:</p><ul><li><strong>Firefox</strong>: <a href=\"https://addons.mozilla.org/firefox/addon/trilium-notes-web-clipper/\">Trilium Web Clipper on Firefox Add-ons</a></li><li><strong>Chrome</strong>: <a href=\"https://chromewebstore.google.com/detail/trilium-web-clipper/ofoiklieachadcaeffficgjaajojpkpi\">Trilium Web Clipper on Chrome Web Store</a></li></ul><h2>Functionality</h2><ul><li>select text and clip it with the right-click context menu</li><li>click on an image or link and save it through context menu</li><li>save whole page from the popup or context menu</li><li>save a PDF that the browser shows, as a file note</li><li>save a screenshot of an area you select, of the visible part of the page or of the whole page, from either popup or context menu</li><li>create short text note from popup</li></ul><h2>The popup</h2><p>Clicking the extension's button in the browser toolbar opens its popup:</p><ul><li><p>The popup shows what will be saved from the current page: the note's title, which can be edited before saving, the website, and below them a preview, which starts with a box for your own note and the page's description. A switch above the preview chooses what to save, among what the page offers:</p><ul><li><em>Selection</em>, when text is selected on the page: <em>Save selection</em> saves it into the note of that page's clippings, as the context menu does.</li><li><em>Page</em>: <em>Save page to Trilium</em> saves the page's text and images. A smaller switch at the top of the preview chooses how much of the page to keep: <em>Article</em> keeps only the page's main text, without its menus, sidebars and footers, and <em>Whole page</em> keeps everything the page shows. <em>Whole page</em> is for pages that are not an article (such as a gallery or a page of cards), where <em>Article</em> can leave out part of the content; the preview shows what each one keeps. <em>Article</em> is unavailable on a page where Trilium finds no article. The author the page names shows under the description, marked by the <span class=\"tn-icon bx bx-user\"></span> icon. It can be edited or cleared before saving, or written in when the page names none, and is saved in the <code>#pageAuthor</code> label of the note. When the page states when it was published, that date shows under the author, marked by the <span class=\"tn-icon bx bx-calendar\"></span> icon, and is saved in the <code>#publishedDate</code> label of the note. When it states when it was last modified, that date shows below, marked by the <span class=\"tn-icon bx bx-history\"></span> icon, and is saved in the <code>#modifiedDate</code> label.</li><li><em>PDF</em>, when the tab shows a PDF in the browser's viewer: <em>Save PDF to Trilium</em> downloads the PDF and saves it as a file note, which Trilium opens in its <a class=\"reference-link\" href=\"#root/_help_XJGJrpu7F9sh\">PDFs</a> viewer. Only the title and the description can be edited, since a file note has no text of its own for your note. The page's address is saved in the note's <code>#pageUrl</code> label and the PDF's file name in <code>#originalFileName</code>. Saving a PDF needs Trilium v0.107.0 or later.</li><li><em>Bookmark</em>, always: there is no preview, and <em>Save bookmark</em> saves a link to the page with your note as the content of the note. Left empty, the title stays the page's title.</li></ul><p>The box for your note, marked by the <span class=\"tn-icon bx bx-info-circle\"></span> icon, has the cursor when the popup opens, so a note (such as why the page is worth keeping) can be typed right away. It grows with its text, and keeps it when switching between <em>Selection</em>, <em>Page</em> and <em>Bookmark</em>. A note on a selection or a page is saved above the clipped content, in a <em>Note</em> admonition. Left empty, nothing is added. <kbd>Ctrl</kbd>+<kbd>Enter</kbd> in any of the popup's fields saves, whichever is chosen.</p><p>The description, marked by the <span class=\"tn-icon bx bx-align-left\"></span> icon, comes from the page's <code>description</code> meta tag, or the one it gives social sites. It can be edited or cleared before saving, or written in when the page has none, and is saved in the <code>#pageDescription</code> label of the note. Clippings saved with the keyboard shortcuts or the context menu, screenshots and images included, get the description as the page gives it. Each clipping that brings a description updates the label. The description, the author and the dates are shown by clicking the <em>Web clip</em> badge next to the title of the note (see <a class=\"reference-link\" href=\"#root/_help_B5dihXRDksTk\">Note badges</a>).</p><p>The popup opens on the selection if there is one, otherwise on <em>Page</em>, showing the article, or the whole page when the page has no article. On a PDF, it opens on <em>PDF</em>. On a page that shows nothing to save, it opens on <em>Bookmark</em> and says so. The keyboard shortcuts and the context menu still save right away, without a preview: saving the whole page that way saves the article, the whole page when the page has no article, or the PDF when the tab shows one.</p></li><li><p>Pages the extension cannot access (the browser's own pages, the extension stores, and pages that were open before the extension was installed until they are reloaded) cannot be saved or captured, so the popup says so in place of the preview, and only <em>All tabs</em> remains available there.</p></li><li><p>Below the preview, a row of buttons offers the other actions: <em>Area</em> (a screenshot of an area you select), <em>Visible</em> (a screenshot of the visible part of the page), <em>Full page</em> (a screenshot of the whole page) and <em>All tabs</em> (saves the links of every tab in the current window as a list of <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a>, or of plain links when <em>Autogenerate link previews</em> is turned off). Hovering over a button shows its full name and, if it has one, its keyboard shortcut.</p></li><li><p><em>Full page</em> scrolls through the page, takes a screenshot of each part and joins them into one image, then scrolls back to where the page was. The scrollbars are hidden while it does, so they do not appear in the image. Stay on the tab until it is saved: switching to another tab stops the screenshot. A header that stays at the top of the window appears once, at the top of the image, and headings that stick while scrolling appear where they are in the page. Other elements that stay in place while scrolling (such as cookie banners and chat buttons) are left out, while a background that fills the whole window repeats on every screen. In Firefox, the page is captured without scrolling through it, which is faster: such a background then appears only at the top, and images that the page loads only once they are scrolled into view can be missing. A long page is saved as several images, one below the other in the note. A page longer than 100 screens is cut off there, and the message after saving says so. Screenshots keep their full height in Trilium: <em>Resize image</em> (under <em>Automatically compress images</em> in Options → Media) limits only their width.</p></li><li><p>The popup stays open while Trilium saves, which can take a few seconds for a long page or a large PDF, and the other actions wait until it is done. The bar at the top of the popup then says, in green, that the clipping was saved (in place of the notice that the page was already clipped), with <em>Open note</em> to open it in Trilium (and, after <em>All tabs</em>, <em>Close saved tabs</em>), or, in red, why it could not be saved. The same clipping cannot be saved twice by accident: the save button stays disabled until another mode is chosen. <em>Crop</em> is the exception: the popup closes so that an area of the page can be selected, and the notification on the page reports the outcome.</p></li><li><p>If the current page was already clipped, a notice at the top offers to open the note in Trilium.</p></li><li><p>If Trilium cannot be found, the popup explains why instead of showing the actions, with buttons to look for Trilium again and to open the options.</p></li><li><p>The bottom of the popup shows whether the extension is connected to Trilium, as a colored dot (green when connected, amber when the versions are not compatible, red when Trilium was not found) next to a description of the connection, followed by the buttons for the extension's options and for this help page. A button to check the connection again appears next to them when hovering over the bar, and stays visible while Trilium cannot be reached or is not compatible.</p></li></ul><h2>Location of clippings</h2><p>Trilium will save these clippings as a new child note under a \"clipper inbox\" note.</p><p>By default, that's the <a class=\"reference-link\" href=\"#root/_help_l0tKav7yLHGF\">Day Notes</a> but you can override that by setting the <a href=\"#root/_help_zEY4DaJG4YT5\">label</a> <code>clipperInbox</code>, on any other note.</p><p>Further clippings of the same kind from the same page are added to the note created by the first one, even on a later day or after that note was moved out of the clipper inbox. The note stays where it is and is not cloned back into the inbox. A PDF is the exception: each save creates a new file note, since the PDF can have changed since it was last saved.</p><p>The icon of a clipped note shows what was saved:</p><ul><li><span class=\"tn-icon bx bx-paperclip\"></span> a selection, a screenshot or a link from the context menu;</li><li><span class=\"tn-icon bx bx-globe\"></span> a page (<em>Article</em> or <em>Whole page</em>);</li><li><span class=\"tn-icon bx bx-bookmark\"></span> a bookmark;</li><li><span class=\"tn-icon bx bx-window-alt\"></span> the tabs of a window.</li></ul><p>The icon is derived from the note's <code>#clipType</code> label, so setting an <code>#iconClass</code> label on the note replaces it. A saved PDF has the icon of a PDF file, like any other PDF in Trilium.</p><h2>Embedded videos</h2><p>A YouTube video embedded in a clipped page is saved as a <a class=\"reference-link\" href=\"#root/_help_UmgZAfcltxkS\">Link Previews</a> embed, with the video's title and thumbnail. As with a link preview added in the editor, the video plays only when clicked. Other embedded content (such as videos from other websites) is not saved.</p><p>The popup's preview shows each such video as a chip with the YouTube icon and the video's short link, and leaves out the embedded content that will not be saved.</p><h2>Keyboard shortcuts</h2><p>Keyboard shortcuts are available for most functions:</p><ul><li>Save selected text: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li><li>Save whole page: <kbd>Alt</kbd>+<kbd>Shift</kbd>+<kbd>S</kbd> (Mac: <kbd>⌥</kbd>+<kbd>⇧</kbd>+<kbd>S</kbd>)</li><li>Save a screenshot of an area: <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>E</kbd> (Mac: <kbd>⌘</kbd>+<kbd>⇧</kbd>+<kbd>E</kbd>)</li><li>Save all tabs of the current window: no default shortcut, but one can be assigned as described below.</li><li>Save a screenshot of the whole page: no default shortcut, but one can be assigned as described below.</li></ul><p>To set custom shortcuts, follow the directions for your browser.</p><ul><li><strong>Firefox</strong>: <code>about:addons</code> → Gear icon ⚙️ → Manage extension shortcuts</li><li><strong>Chrome</strong>: <code>chrome://extensions/shortcuts</code></li></ul><aside class=\"admonition note\"><p>On Firefox, the default shortcuts interfere with some browser features. As such, the keyboard combinations will not trigger the Web Clipper action. To fix this, simply change the keyboard shortcut to something that works. The defaults will be adjusted in future versions.</p></aside><h2>Configuration</h2><p>The extension needs to connect to a running Trilium instance. By default, it looks for the desktop application on port 37840 of the local computer. If the desktop application runs on a different port (for example because it was started with the <code>TRILIUM_PORT</code> environment variable), enter that port in the extension's options. The extension checks for Trilium again every minute, or right away when pressing the refresh button at the bottom of its popup.</p><p>It's also possible to configure the <a href=\"#root/_help_WOcw2SLH6tbX\">server</a> address if you don't run the desktop application, or want it to work without the desktop application running.</p><p>To connect to a server, enter its address and your password in the extension's options and press <em>Login to the server instance</em>. If the server uses <a href=\"#root/_help_7DAiwaf8Z7Rz\">multi-factor authentication</a>, also fill in <em>Authentication code</em> with the current code from your authenticator app (or one of your recovery codes); otherwise leave it empty. The password and the code are used only once, to obtain a token for the extension, and are not stored.</p><h3>When a clipping fails</h3><p>After each clipping made with a keyboard shortcut or the context menu, a notification in the corner of the page confirms that it was saved, with a link to open the new note in Trilium. A clipping made from the popup reports in the popup instead, unless the popup was closed before it was saved. If the clipping could not be saved, the message says why instead:</p><ul><li>Trilium was not found: start the desktop application, or check the server address and token in the extension's options.</li><li>The versions of Trilium and the extension are not compatible: update the one the message names.</li><li>Trilium rejected the request: the message includes the reason Trilium gave.</li><li>The popup could not reach the extension's background script, or it gave no answer: close the popup and open it again. If the extension was just updated or reloaded, reload the page as well.</li><li>A PDF could not be saved: Trilium is older than v0.107.0, the website refused to send the PDF again, or the PDF is larger than 100 MB. The extension downloads the PDF with the browser's cookies for that website, so a PDF behind a login can be saved while you are logged in.</li></ul><p>The extension downloads the images of a clipping itself, so that they are stored in Trilium together with the note. If some of them cannot be downloaded (for example because the website refuses the request), the clipping is still saved, and the notification says how many images are missing. Those images keep their address on the original website: Trilium tries to download them once more if <em>Download images automatically</em> is enabled in <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Media</em>, and otherwise the note shows them from the website for as long as it serves them.</p><p>The notification is shown on the page itself, so it does not appear on pages where extensions cannot run (such as the browser's own settings pages, the extension stores and Firefox's PDF viewer). A clipping saved from the popup on such a page still reports in the popup.</p><h2>Testing development versions</h2><p>Development versions are version pre-release versions, generally meant for testing purposes. These are not available in the Google or Firefox web stores, but can be downloaded from either:</p><ul><li><a href=\"https://github.com/TriliumNext/Trilium/releases\">GitHub Releases</a> by looking for releases starting with <em>Web Clipper.</em></li><li>Artifacts in GitHub Actions, by looking for the <a href=\"https://github.com/TriliumNext/Trilium/actions/workflows/web-clipper.yml\"><em>Deploy web clipper extension</em> workflow</a>. Once a workflow run is selected, the ZIP files are available in the <em>Artifacts</em> section, under the name <code>web-clipper-extension</code>.</li></ul><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-chrome\"></span> Chrome</p><div class=\"trilium-tab-panel\"><ol><li>Download <code>trilium-web-clipper-[x.y.z]-chrome.zip</code>.</li><li>Extract the archive.</li><li>In Chrome, navigate to <code>chrome://extensions/</code></li><li>Toggle <em>Developer Mode</em> in top-right of the page.</li><li>Press the <em>Load unpacked</em> button near the header.</li><li>Point to the extracted directory from step (2).</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bxl-firefox\"></span> Firefox</p><div class=\"trilium-tab-panel\"><aside class=\"admonition warning\"><p>Firefox prevents installation of unsigned packages in the “retail” version. To be able to install extensions from disk, consider using <em>Firefox Developer Edition</em> or a non-branded version of Firefox (e.g. <em>GNU IceCat</em>).</p><p>One time, go to <code>about:config</code> and change <code>xpinstall.signatures.required</code> to <code>false</code>.</p></aside><ol><li>Navigate to <code>about:addons</code>.</li><li>Select <em>Extensions</em> in the left-side navigation.</li><li>Press the <em>Gear</em> icon on the right of the <em>Manage Your Extensions</em> title.</li><li>Select <em>Install Add-on From File…</em></li><li>Point it to <code>trilium-web-clipper-[x.y.z]-firefox.zip</code>.</li><li>Press the <em>Add</em> button to confirm.</li></ol></div></section></div><h2>Credits</h2><p>Some parts of the code are based on the <a href=\"https://github.com/laurent22/joplin/tree/master/Clipper\">Joplin Notes browser extension</a>.</p>","_help_n1lujUxCwipy": "<p>This document outlines the steps required to upgrade Trilium to a new release version.</p><h2>How to Upgrade</h2><p>Trilium does not support built-in automatic upgrades; all updates must be performed manually. The upgrade process varies depending on the installation method:</p><ul><li><a href=\"#root/_help_rWX5eY045zbE\"><strong>Docker Server Installation</strong></a>: Pull the new image and restart the container.</li><li><strong>Other Installations</strong>: Download the latest version from the <a href=\"https://github.com/TriliumNext/Trilium/releases/latest\">release page</a> and replace the existing application files.</li></ul><h2>Database Compatibility and Migration</h2><p>Upon startup, Trilium will automatically migrate the <a href=\"#root/_help_wX4HbRucYSDD\">database</a> to the new version. Note that after migration, older versions of Trilium will be unable to read the database. If you need to revert to a previous version of Trilium and its database, you can restore the <a href=\"#root/_help_ODY7qQn5m2FT\">backup</a> that is created prior to migration.</p><h2>Sync Compatibility</h2><p>The <a href=\"#root/_help_cbkrhQjrkKrh\">synchronization</a> protocol used by Trilium is versioned, requiring all members of the sync cluster to use the same protocol version. Therefore, when upgrading to a new version, you may need to upgrade all instances in the sync cluster. Changes to the sync protocol version are typically indicated on the release page.</p>","_help_ODY7qQn5m2FT": "<p>Trilium supports simple backup scheme where it saves copy of the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> on these events:</p><ul><li>once a day</li><li>once a week</li><li>once a month</li><li>before DB migration to newer version</li></ul><p>So in total you'll have at most 4 backups from different points in time which should protect you from various problems. These backups are stored by default in <code>backup</code> directory placed in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>.</p><p>This is only very basic backup solution, and you're encouraged to add some better backup solution - e.g. backing up the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> to cloud / different computer etc.</p><p>Note that <a class=\"reference-link\" href=\"#root/_help_cbkrhQjrkKrh\">Synchronization</a> provides also some backup capabilities by its nature of distributing the data to other computers.</p><h2>Creating a backup</h2><div class=\"trilium-tabs\"><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-desktop\"></span> On the desktop app & web client</p><div class=\"trilium-tab-panel\"><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and press the <em>Backup now</em> button.</li><li>The backup creation process may take a few moments, especially for larger databases. A notification will inform you when the backup is complete.</li><li>The backup will be saved as <code>backup-now</code> in the <em>Existing backups</em> list, where you can download it.</li></ol></div></section><section class=\"trilium-tab\"><p class=\"trilium-tab-title\"><span class=\"tn-icon bx bx-globe\"></span> On the standalone client</p><div class=\"trilium-tab-panel\"><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and press the <em>Download backup</em> button.</li><li>You will be prompted to restart the app. Confirm, and the app will restart automatically.</li><li>Set a <em>backup name</em> or <em>password</em> (both optional), then press <em>Continue</em>.</li><li>Press the <em>Generate and download</em> button and wait for the download to complete.</li><li>Once you confirm the download is saved on your device, press <em>Finish</em> to complete</li></ol></div></section></div><h2>Downloading a backup</h2><ul><li><strong>Desktop and web client</strong>: to download an existing backup, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Existing backups</em> and select <em>Download</em> (<span class=\"tn-icon bx bx-download\"></span>).</li><li><strong>Standalone client</strong>: automatic backups are not supported in this version. You can manually create and download a backup by going to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Download backup</em>.</li></ul><h2>Restoring a backup</h2><ul><li><strong>For a new Trilium instance</strong>: When setting up a new Trilium instance, use the <em>Restore from backup</em> option in the setup menu to guide you through restoring your existing backup.</li><li><strong>For an existing Trilium instance</strong>: To restore a backup and replace your current database, go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> and click <em>Restore a backup</em>. You will be prompted to restart the app for the restoration process to begin. After restarting, you can choose to back up the existing database before overwriting it. Note: For the web client, use the Start Over feature ( <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Database</em> → <em>Start over</em> (<span class=\"tn-icon bx bx-reset\"></span>)) to switch to the setup screen and restore a backup.</li></ul><p>Next, select the backup file (.db or .tnbackup) from your device. The web client is optimized for handling large backups and is resilient to unstable network conditions, similar to the desktop application.</p><p>If your database is encrypted, you will be prompted to enter the password used for encrypting the backup file. Without the correct password, decryption and restoration cannot proceed.</p><p>Restoring a backup may take some time, depending on its size. Once it completes, Trilium will open the freshly restored database.</p><h3>The alternative way for restoring a backup</h3><p>Let's assume you want to restore the weekly backup (only in .db format, .tnbackup files are not supported by this method), here's how to do it:</p><ul><li>find <a href=\"#root/_help_tAassRL4RSQL\">data directory</a> Trilium uses - easy way is to open \"About Trilium Notes\" (<span class=\"tn-icon bx bx-info-circle\"></span>) from \"Menu\" in upper left corner and looking at \"data directory\"<ul><li>I'll refer to <code>~/trilium-data</code> as data directory from now on</li></ul></li><li>find <code>~/trilium-data/backup/backup-weekly.db</code> - this is the <a class=\"reference-link\" href=\"#root/_help_wX4HbRucYSDD\">Database</a> backup.</li><li>at this point stop/kill Trilium</li><li>delete <code>~/trilium-data/document.db</code>, <code>~/trilium-data/document.db-wal</code> and <code>~/trilium-data/document.db-shm</code> (latter two files are auto generated)</li><li>copy and rename this <code>~/trilium-data/backup/backup-weekly.db</code> to <code>~/trilium-data/document.db</code></li><li>make sure that the file is writable, e.g. with <code>chmod 600 document.db</code></li><li>start Trilium again</li></ul><aside class=\"admonition warning\"><p>If you have configured sync then you need to do it across all members of the sync cluster, otherwise older version (restored backup) of the document will be detected and synced to the newer version.</p></aside><h2>Changing the backup location in Trilium (desktop only)</h2><p>Starting with version 0.105, the Trilium desktop client allows users to change the directory where backups are stored. Follow these steps to specify a custom backup directory:</p><ol><li>Navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup location</em>.</li><li>Click the <em>Select location</em> button.</li><li>Choose any writable directory on your file system. This could include network shares, depending on your operating system.</li></ol><p>Once you set a custom directory, all manual and automatic backups will be saved there. If the selected directory becomes unavailable, backups may fail or revert to the default location.</p><aside class=\"admonition tip\"><p>For better privacy when using unsafe backup locations, you can enable backup encryption, which makes the backup file unreadable without the correct password.</p></aside><h2>Backup encryption</h2><p>Trilium can secure the entire content of the database backup, ensuring it remains unreadable unless the correct password is provided. This is particularly useful for storing backups in unsecured locations, like network shares, unencrypted external drives, or cloud services. </p><p>Encrypted database backups use the Trilium Backup Container (.tnbackup) format, which relies on AES-256-GCM. This authenticated encryption mode scrambles the data and generates a tag confirming it hasn't been altered. The password itself isn't directly used as the key; it's processed through scrypt, a key derivation function designed to be slow and memory-intensive, making brute-force password guessing difficult even with powerful hardware. Each backup also receives a random 16-byte salt, ensuring that the same password never produces the same encryption key twice. Additionally, critical metadata such as chunk order, length, and header flags are cryptographically bound into the encryption (via \"additional authenticated data\"), preventing undetected tampering like reorder, truncate, or splice operations.</p><h3>Enabling backup encryption</h3><p>To enable encryption for automatic backups in the Desktop application:</p><ol><li>Go to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup options</em>.</li><li>Click on <em>Turn on encryption</em> and set a password.</li></ol><p>Once encryption is enabled, all newly created backups (both automatic and manual) will be encrypted with the specified password. Backups created prior to enabling encryption will remain unsecured.</p><p>You can change the password anytime using the <em>Change password</em> button. The new password will apply to backups created after the change.</p><p>To disable encryption, uncheck <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Enable encryption</em>.</p><aside class=\"admonition note\"><p>On some systems, a keyring may not be available for Trilium to securely store the encryption password. In such cases, the encryption option is disabled.</p></aside><h2>Backup compression</h2><p>Database backups can be optionally compressed to minimize storage footprint. This method is effective primarily when the database consists largely of text content. However, media files (images, videos, audio), along with PDF, ODF, and DOCX files, are already compressed in their original formats and won't benefit from further compression.</p><p>Compressed backups are stored using the Trilium Backup Container (.tnbackup), employing RFC 1952 GZIP compression.</p><aside class=\"admonition warning\"><p><strong>Note:</strong> Compression increases the time required for backup creation and restoration. It may also lead to higher CPU usage during automatic backups, potentially draining the battery faster on battery-powered devices. Enable this option only if necessary.</p></aside><h3>Enabling Backup Compression (Desktop Only)</h3><p>To enable compression for new automatic and manual backups, navigate to <a class=\"reference-link\" href=\"#root/_help_4TIF1oA4VQRO\">Options</a> → <em>Backup</em> → <em>Backup options</em> and toggle <em>Enable compression</em> to on.</p><h2>Disabling backup</h2><p>Although this is not recommended, it is possible to disable backup in <code>config.ini</code> in the <a href=\"#root/_help_tAassRL4RSQL\">data directory</a>:</p><pre><code class=\"language-text-x-trilium-auto\">[General]\n... some other configs\n# set to true to disable backups (e.g. because of limited space on server)\nnoBackup=true</code></pre><p>You can also review the <a href=\"#root/_help_Gzjqa934BdH4\">configuration</a> file to provide all <code>config.ini</code> values as environment variables instead.</p><p>See <a href=\"https://github.com/TriliumNext/Trilium/blob/master/config-sample.ini\">sample config</a>.</p>",diff --git a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.mdindex cb91263208..45dbf5e2b6 100644--- a/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md+++ b/docs/User Guide/User Guide/Installation & Setup/Mobile Frontend.md@@ -20,7 +20,7 @@ Here is a non-exhaustive list of differences between the desktop version and the* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a> is displayed at the bottom of the screen.* The launch bar uses a different configuration for icons than the desktop version. See the dedicated page for more information on how to configure it.* Most of the note-related actions are grouped in the horizontal dots icon on the top-right of the note.-* In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. It starts with _Undo_ and _Redo_, since the on-screen keyboard has no keys for them. The <span class="tn-icon cke cke-plus"></span> button after them opens the less common insertions as tiles at the bottom of the screen: collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import. The tiles marked with <span class="tn-icon bx bx-chevron-right"></span> open a list of choices: _Columns_ the number of columns, _Footnote_ a new footnote or a reference to an existing one, _Date/time_ the format of the date and time, and _Insert text snippet_ the template to insert, which is grayed out while there are none. The block type button shows the type of the current block as an icon rather than its name, and opens the block types as tiles at the bottom of the screen, with the current one highlighted: paragraph and heading 2 to 6, then bulleted list, numbered list and to-do list, then code block, block quote and admonition. Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it. Typing `-` , `1.` or `[ ]` at the start of a line also starts a list. The style of a list (such as roman numerals) and its start number can only be changed on desktop. The <span class="tn-icon cke cke-trilium-ai"></span> AI assistant button, shown once a provider is configured, opens its quick actions as a menu at the bottom of the screen, with _Ask AI…_ at its top. The alignment button shows the alignment of the current block, and opens left, center, right and justify as a row of tiles, with the current one highlighted. The <span class="tn-icon cke cke-paper-clip"></span> button replaces the separate image upload and attach file buttons: it opens _Image_, _Attach and embed file_ and _Attach file as a link_ as a row of tiles, each of which opens the device's file picker. The <span class="tn-icon cke cke-table"></span> table button opens common table sizes as tiles.+* In a text note, the formatting toolbar sits at the bottom of the screen as a single row that scrolls sideways. It is shown only while you are editing the text, and hides when you hide the keyboard or move to another field, such as the note title. It starts with _Undo_ and _Redo_, since the on-screen keyboard has no keys for them. The <span class="tn-icon cke cke-plus"></span> button after them opens insertions as tiles at the bottom of the screen: code block, block quote and admonition (also in the block type button), then the less common collapsible, tabs, columns, horizontal line, page break, footnote, math, drawing canvas, Mermaid diagram, bookmark, link and content embeds, special characters, emoji, icon, date/time, template and Markdown import. The tiles marked with <span class="tn-icon bx bx-chevron-right"></span> open a list of choices: _Code block_ the language, _Admonition_ its type, _Columns_ the number of columns, _Footnote_ a new footnote or a reference to an existing one, _Date/time_ the format of the date and time, and _Insert text snippet_ the template to insert, which is grayed out while there are none. The block type button shows the type of the current block as an icon rather than its name, and opens the block types as tiles at the bottom of the screen, with the current one highlighted: paragraph and heading 2 to 6, then bulleted list, numbered list and to-do list, then code block, block quote and admonition. Picking a paragraph or a heading in a list turns the item back into plain text, and the same goes for a code block. Block quote and admonition wrap the current block rather than replace it, so they are highlighted alongside it; pick one again to remove it. Typing `-` , `1.` or `[ ]` at the start of a line also starts a list. The style of a list (such as roman numerals) and its start number can only be changed on desktop. The <span class="tn-icon cke cke-trilium-ai"></span> AI assistant button, shown once a provider is configured, opens its quick actions as a menu at the bottom of the screen, with _Ask AI…_ at its top. The alignment button shows the alignment of the current block, and opens left, center, right and justify as a row of tiles, with the current one highlighted. The <span class="tn-icon cke cke-paper-clip"></span> button replaces the separate image upload and attach file buttons: it opens _Image_, _Attach and embed file_ and _Attach file as a link_ as a row of tiles, each of which opens the device's file picker. The <span class="tn-icon cke cke-table"></span> table button opens common table sizes as tiles.* The formatting applied to text (bold, italic, underline, strikethrough, inline code, superscript and subscript, keyboard shortcut, font size and colors, and removing formatting) is on a row of its own, which ends with <span class="tn-icon cke cke-trilium-scissors"></span> to cut the selection into a sub-note. Tap <span class="tn-icon cke cke-text"></span> next to the block type button to show it, and <span class="tn-icon cke cke-previous-arrow"></span> at its start to return to the main row. Selecting text shows this row on its own, and it goes back to the main row once the selection is gone (for example as you start typing), unless you opened or closed the row yourself in the meantime. The font size button opens the list of sizes as a menu at the bottom of the screen, each drawn at its size, with the current one checked. A single color button replaces the separate text and background color buttons: it opens a menu with a row of colors for the text and one for its background, each with a cell that removes the color and one that opens the device's color picker.* While the on-screen keyboard is open, a <span class="tn-icon bx bxs-keyboard"></span> button in the bottom-right corner, just above the keyboard, hides it. In a text note, the button is at the right end of the formatting toolbar. While a menu of the formatting toolbar is open in place of the keyboard, the button becomes a <span class="tn-icon bx bx-x"></span>, which closes the menu and brings the keyboard back. This works in every note type and in every text field, and is the only way to hide the keyboard in the iOS app, where the keyboard has no _Done_ button.* The <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Tabs.md">Tabs</a> are grouped under a tab switcher in the <a class="reference-link" href="../Basic%20Concepts%20and%20Features/UI%20Elements/Launch%20Bar.md">Launch Bar</a>, where the tabs are displayed in a full-screen grid with preview for easy switching, as well as additional options such as reopening closed tabs.