Notes/src/public/app/doc_notes/en/User Guide/User Guide/FAQ.html

120 lines
6.7 KiB
HTML

This file contains invisible Unicode characters!

This file contains invisible Unicode characters that may be processed differently from what appears below. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to reveal hidden characters.

<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../style.css">
<base target="_parent">
<title data-trilium-title>FAQ</title>
</head>
<body>
<div class="content">
<h1 data-trilium-h1>FAQ</h1>
<div class="ck-content">
<h2>Mac OS support</h2>
<p>Originally, desktop builds of Trilium Notes has been available for Windows
&amp; Linux, but there has been a considerable demand for macOS build.</p>
<p>So I made one, but I underestimated the differences and specifics of Mac
platform which seems to require special handling in several places. My
lack of knowledge and frankly willingness to learn &amp; code Mac specific
functionality resulted in a current state where <a href="https://github.com/TriliumNext/Notes/issues/511">Trilium does not integrate well into the OS</a> </p>
<p>%%{WARNING}%%.</p>
<p>macOS build is from now on considered "unsupported". I will strive to
keep it fundamentally functional, but I won't work on Mac specific features
or integrations. Note that this is more of an acknowledgment of an existing
state rather than sudden change of direction.</p>
<p>Of course, PRs are welcome.</p>
<h2>Translation / localization support</h2>
<p>Trilium is currently available only in English. Translation to other languages
is not planned in the near/medium term because it brings a significant
maintenance overhead. This decision might be revisited once Trilium stabilizes
into a more mature product.</p>
<p>For Chinese, there's an unofficial fork <a href="https://github.com/Nriver/trilium-translation">here</a>.
Use at your own risk.</p>
<h2>Multi user support</h2>
<p>Common request is to allow multiple users collaborate, share notes etc.
So far I'm resisting this because of these reasons:</p>
<ul>
<li>it's a huge feature, or rather a Pandora's box of collaboration features
like user management, permissions, conflict resolution, real-time editing
of a note by multiple people etc. This would be a huge amount of work.
Trilium Notes is project made mostly by one person in free time and that's
unlikely to change in the future.</li>
<li>given its size it would probably pivot the attention away from my main
focus which is a personal note-taking</li>
<li>the assumption that only single person has access to the app simplifies
many things, or just outright makes them possible. In multi-user app, our
<a
href="Note%20Types/Code/Scripts.html">scripting</a>support would be a XSS security hole, while with the single
user assumption it's an endless customizable tool.</li>
</ul>
<h2>How to open multiple documents in one Trilium instance</h2>
<p>This is normally not supported - one Trilium process can open only a single
instance of a <a href="Advanced%20Usage/Database.html">database</a>. However,
you can run two Trilium processes (from one installation), each connected
to a separate document. To achieve this, you need to set a location for
the <a href="Installation%20%26%20Setup/Data%20directory.html">data directory</a> in
the <code>TRILIUM_DATA_DIR</code> environment variable and separate port
on <code>TRILIUM_PORT</code> environment variable. How to do that depends
on the platform, in Unix-based systems you can achieve that by running
command such as this:</p>
<pre><code class="language-text-x-trilium-auto">TRILIUM_DATA_DIR=/home/me/path/to/data/dir TRILIUM_PORT=12345 trilium </code></pre>
<p>You can save this command into a <code>.sh</code> script file or make an
alias. Do this similarly for a second instance with different data directory
and port.</p>
<h2>Can I use Dropbox / Google Drive / OneDrive to sync data across multiple computers.</h2>
<p>No.</p>
<p>These general purpose sync apps are not suitable to sync database files
which are open and being worked on by another application. The result is
that they will corrupt the database file, resulting in data loss and this
message in the Trilium logs:</p>
<blockquote>
<p>SqliteError: database disk image is malformed</p>
</blockquote>
<p>The only supported way to sync Trilium's data across the network is to
use a <a href="Installation%20%26%20Setup/Synchronization.html">sync/web server</a>.</p>
<h2>Why database instead of flat files?</h2>
<p>Trilium stores notes in a <a href="Advanced%20Usage/Database.html">database</a> which
is an SQLite database. People often ask why doesn't Trilium rather use
flat files for note storage - it's fair question since flat files are easily
interoperable, work with SCM/git etc.</p>
<p>Short answer is that file systems are simply not powerful enough for what
we want to achieve with Trilium. Using filesystem would mean fewer features
with probably more problems.</p>
<p>More detailed answer:</p>
<ul>
<li><a href="Basic%20Concepts/Note/Cloning%20Notes.html">clones</a> are what
you might call "hard directory link" in filesystem lingo, but this concept
is not implemented in any filesystem</li>
<li>filesystems make a distinction between directory and file while there's
intentionally no such difference in Trilium</li>
<li>files are stored in no particular order and user can't change this</li>
<li>Trilium allows storing note <a href="Advanced%20Usage/Attributes.html">attributes</a> which
could be represented in extended user attributes but their support differs
greatly among different filesystems / operating systems</li>
<li>Trilium makes links / relations between different notes which can be quickly
retrieved / navigated (e.g. for <a href="Advanced%20Usage/Note%20Map.html">note map</a>).
There's no such support in file systems which means these would have to
be stored in some kind of side-car files (mini-databases).</li>
<li>Filesystems are generally not transactional. While this is not completely
required for a note-taking application, having transactions make it way
easier to keep notes and their metadata in predictable and consistent state.</li>
</ul>
</div>
</div>
</body>
</html>