gaschz/trilium
1
0
Fork 0
mirror of https://github.com/zadam/trilium.git synced 2026-02-17 11:14:36 +01:00
Code Issues Actions 14 Packages Projects Releases Wiki Activity

docs(guide): add instructions on installing from .zip

Browse Source
This commit is contained in:
Elian Doran 2026-01-26 20:37:32 +02:00
parent 537d92421c
commit 82ea4c1a04
No known key found for this signature in database
3 changed files with 102 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

78
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Web Clipper.html generated vendored
View File

@ -7,13 +7,9 @@
<h2>Supported browsers</h2> <h2>Supported browsers</h2>
<p>Trilium Web Clipper officially supports the following web browsers:</p> <p>Trilium Web Clipper officially supports the following web browsers:</p>
<ul> <ul>
<li> <li>Mozilla Firefox, using Manifest v2.</li>
<p>Mozilla Firefox, using Manifest v2.</p> <li>Google Chrome, using Manifest v3. Theoretically the extension should work
</li> on other Chromium-based browsers as well, but they are not officially supported.</li>
<li>
<p>Google Chrome, using Manifest v3. Theoretically the extension should work
on other Chromium-based browsers as well, but they are not officially supported.</p>
</li>
</ul> </ul>
<h2>Obtaining the extension</h2> <h2>Obtaining the extension</h2>
<aside class="admonition warning"> <aside class="admonition warning">
@ -68,5 +64,73 @@
<p>It's also possible to configure the <a href="#root/_help_WOcw2SLH6tbX">server</a> address <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 if you don't run the desktop application, or want it to work without the
desktop application running.</p> desktop application running.</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>
<p><a href="https://github.com/TriliumNext/Trilium/releases">GitHub Releases</a> by
looking for releases starting with <em>Web Clipper.</em>
</p>
</li>
<li>
<p>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 spellcheck="false">web-clipper-extension</code>.</p>
</li>
</ul>
<h3>For Chrome</h3>
<ol>
<li>
<p>Download <code spellcheck="false">trilium-web-clipper-[x.y.z]-chrome.zip</code>.</p>
</li>
<li>
<p>Extract the archive.</p>
</li>
<li>
<p>In Chrome, navigate to <code spellcheck="false">chrome://extensions/</code>
</p>
</li>
<li>
<p>Toggle <em>Developer Mode</em> in top-right of the page.</p>
</li>
<li>
<p>Press the <em>Load unpacked</em> button near the header.</p>
</li>
<li>
<p>Point to the extracted directory from step (2).</p>
</li>
</ol>
<h3>For Firefox</h3>
<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 spellcheck="false">about:config</code> and change
<code
spellcheck="false">xpinstall.signatures.required</code>to <code spellcheck="false">false</code>.</p>
</aside>
<ol>
<li>
<p>Navigate to <code spellcheck="false">about:addons</code>.</p>
</li>
<li>
<p>Select <em>Extensions</em> in the left-side navigation.</p>
</li>
<li>
<p>Press the <em>Gear</em> icon on the right of the <em>Manage Your Extensions</em> title.</p>
</li>
<li>
<p>Select <em>Install Add-on From File…</em>
</p>
</li>
<li>
<p>Point it to <code spellcheck="false">trilium-web-clipper-[x.y.z]-firefox.zip</code>.</p>
</li>
<li>
<p>Press the <em>Add</em> button to confirm.</p>
</li>
</ol>
<h2>Credits</h2> <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> <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>

2
docs/Developer Guide/Developer Guide/Documentation.md vendored
View File

@ -1,5 +1,5 @@
# Documentation # Documentation
There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/rFcOjCdtKSRx/Documentation_image.png" width="205" height="162"> There are multiple types of documentation for Trilium:<img class="image-style-align-right" src="api/images/jaeLd6kJGrRa/Documentation_image.png" width="205" height="162">
* The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>. * The _User Guide_ represents the user-facing documentation. This documentation can be browsed by users directly from within Trilium, by pressing <kbd>F1</kbd>.
* The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers. * The _Developer's Guide_ represents a set of Markdown documents that present the internals of Trilium, for developers.

30
docs/User Guide/User Guide/Installation & Setup/Web Clipper.md vendored
View File

@ -55,6 +55,36 @@ The extension needs to connect to a running Trilium instance. By default, it sca
It's also possible to configure the [server](Server%20Installation.md) address if you don't run the desktop application, or want it to work without the desktop application running. It's also possible to configure the [server](Server%20Installation.md) address if you don't run the desktop application, or want it to work without the desktop application running.
## Testing development versions
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:
* [GitHub Releases](https://github.com/TriliumNext/Trilium/releases) by looking for releases starting with _Web Clipper._
* Artifacts in GitHub Actions, by looking for the [_Deploy web clipper extension_ workflow](https://github.com/TriliumNext/Trilium/actions/workflows/web-clipper.yml). Once a workflow run is selected, the ZIP files are available in the _Artifacts_ section, under the name `web-clipper-extension`.
### For Chrome
1. Download `trilium-web-clipper-[x.y.z]-chrome.zip`.
2. Extract the archive.
3. In Chrome, navigate to `chrome://extensions/`
4. Toggle _Developer Mode_ in top-right of the page.
5. Press the _Load unpacked_ button near the header.
6. Point to the extracted directory from step (2).
### For Firefox
> [!WARNING]
> Firefox prevents installation of unsigned packages in the “retail” version. To be able to install extensions from disk, consider using _Firefox Developer Edition_ or a non-branded version of Firefox (e.g. _GNU IceCat_).
>
> One time, go to `about:config` and change `xpinstall.signatures.required` to `false`.
1. Navigate to `about:addons`.
2. Select _Extensions_ in the left-side navigation.
3. Press the _Gear_ icon on the right of the _Manage Your Extensions_ title.
4. Select _Install Add-on From File…_
5. Point it to `trilium-web-clipper-[x.y.z]-firefox.zip`.
6. Press the _Add_ button to confirm.
## Credits ## Credits
Some parts of the code are based on the [Joplin Notes browser extension](https://github.com/laurent22/joplin/tree/master/Clipper). Some parts of the code are based on the [Joplin Notes browser extension](https://github.com/laurent22/joplin/tree/master/Clipper).