mirror of
https://github.com/zadam/trilium.git
synced 2025-10-19 22:58:52 +02:00
docs(user): using desktop application as server (closes #6431)
This commit is contained in:
Elian Doran
parent
985a54edd1
commit
5071f61174
2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
generated
vendored
2
apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json
generated
vendored
File diff suppressed because one or more lines are too long
35
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/Using the desktop application .html
generated
vendored
Normal file
35
apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/Using the desktop application .html
generated
vendored
Normal file
@ -0,0 +1,35 @@
|
||||
<p>Sometimes, setting up a <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_help_WOcw2SLH6tbX">dedicated server installation</a> is
|
||||
not feasible. The desktop application ships with a fully functional server
|
||||
instance by default.</p>
|
||||
<p>You can access this web interface locally by navigating to <a href="http://localhost:37840/login">http://localhost:37840/login</a>.</p>
|
||||
<aside
|
||||
class="admonition note">
|
||||
<p>The server embedded in the desktop application will only run as long as
|
||||
the desktop application itself is running. So closing the application will
|
||||
also close the server. To overcome this, you can try hiding the application
|
||||
in the system tray.</p>
|
||||
</aside>
|
||||
<h2>Mobile interface</h2>
|
||||
<p>By default, this will display the desktop user interface, even on mobile.
|
||||
To switch to the mobile version, simply go to the <a class="reference-link"
|
||||
href="#root/pOsGYCXsbNQG/gh7bpGYxajRS/Vc8PjrjAGuOp/_help_x3i7MxGccDuM">Global menu</a> and
|
||||
select “Switch to the mobile version”.</p>
|
||||
<h2>Allowing the port externally on Windows with Windows Defender Firewall</h2>
|
||||
<p>First, find out the IP of your desktop server by running <code>ipconfig</code> in
|
||||
your local terminal. Then try accessing <code>http://<ip>:37840/login</code> on
|
||||
another device. If it doesn't work, then most likely the port is blocked
|
||||
by your operating system's firewall.</p>
|
||||
<p>If you use Windows Defender Firewall:</p>
|
||||
<ol>
|
||||
<li data-list-item-id="e181018d4ed9d5f6ed6fac8dfcfcd9fdc">Go to Windows's start menu and look for “Windows Defender Firewall with
|
||||
Advanced Security”.</li>
|
||||
<li data-list-item-id="ed0adc669e5aab708cb8c98bdfbc50d5a">Go to “Inbound Rules” on the left tree, and select “New Rule” in the “Actions”
|
||||
sidebar on the right.</li>
|
||||
<li data-list-item-id="edb48ee7c3e7b80b78e553b30ef71d01f">Select “Port” and press “Next”.</li>
|
||||
<li data-list-item-id="ecfaef8d3f67901bbbf0d3f5c1edca797">Type in <code>37840</code> in the “Specific local ports” section and then
|
||||
press “Next”.</li>
|
||||
<li data-list-item-id="e0fd590158c462104c099cac4971daee9">Leave “Allow the connection” checked and press “Next”.</li>
|
||||
<li data-list-item-id="edd8c39fed27bb27e02e525a48c17d4a0">Configure the networks to apply to (check all if unsure) and then press
|
||||
“Next”.</li>
|
||||
<li data-list-item-id="eade1aa266a382975c4b59106e2632cb1">Add an appropriate name to the rule (e.g. “Trilium Notes”) and press “Finish”.</li>
|
||||
</ol>
|
||||
@ -6,26 +6,22 @@
|
||||
See below for more details on this.</p>
|
||||
<p>Note that this is not an Android/iOS app, this is just mobile friendly
|
||||
web page served on the <a href="#root/_help_WOcw2SLH6tbX">server edition</a>.</p>
|
||||
<h2>Screenshots</h2>
|
||||
<h3>Mobile phone</h3>
|
||||
<p>
|
||||
<img src="Mobile Frontend_mobile-sma.png">
|
||||
</p>
|
||||
<h3>Tablet</h3>
|
||||
<p>
|
||||
<img src="Mobile Frontend_mobile-tab.png">
|
||||
</p>
|
||||
<h2>Testing via the desktop application</h2>
|
||||
<p>If you are running Trilium without a dedicated <a href="#root/pOsGYCXsbNQG/Otzi9La2YAUX/_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/pOsGYCXsbNQG/Otzi9La2YAUX/poXkQfguuA0U/_help_nRqcgfTb97uV">Using the desktop application as a server</a>.
|
||||
To access it go to <code>http://<ip>:37840/login?mobile</code> .</p>
|
||||
<h2>Limitations</h2>
|
||||
<p>Mobile frontend provides only some of the features of the full desktop
|
||||
frontend:</p>
|
||||
<ul>
|
||||
<li>it is possible to browse the whole note tree, read and edit all types
|
||||
<li data-list-item-id="e738e54a9aff5f827b1321f2afb8cc89f">it is possible to browse the whole note tree, read and edit all types
|
||||
of notes, but you can create only text notes</li>
|
||||
<li>reading and editing <a href="#root/_help_bwg0e8ewQMak">protected notes</a> is
|
||||
<li data-list-item-id="e0e3748ecf5c55000c2a220ae4daa13fa">reading and editing <a href="#root/_help_bwg0e8ewQMak">protected notes</a> is
|
||||
possible, but creating them is not supported</li>
|
||||
<li>editing options is not supported</li>
|
||||
<li>cloning notes is not supported</li>
|
||||
<li>uploading file attachments is not supported</li>
|
||||
<li data-list-item-id="edb73b27209d2628a43c131551470688b">editing options is not supported</li>
|
||||
<li data-list-item-id="eee7c0f90ea1fbd6b79aac302ccf7ff0b">cloning notes is not supported</li>
|
||||
<li data-list-item-id="e82466c594de53615b657260c9ead626a">uploading file attachments is not supported</li>
|
||||
</ul>
|
||||
<h2>Forcing mobile/desktop frontend</h2>
|
||||
<p>Trilium decides automatically whether to use mobile or desktop frontend.
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 84 KiB |
64
docs/User Guide/!!!meta.json
vendored
64
docs/User Guide/!!!meta.json
vendored
@ -230,7 +230,45 @@
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Desktop Installation.md",
|
||||
"attachments": [],
|
||||
"dirFileName": "Desktop Installation",
|
||||
"children": [
|
||||
{
|
||||
"isClone": false,
|
||||
"noteId": "nRqcgfTb97uV",
|
||||
"notePath": [
|
||||
"pOsGYCXsbNQG",
|
||||
"Otzi9La2YAUX",
|
||||
"poXkQfguuA0U",
|
||||
"nRqcgfTb97uV"
|
||||
],
|
||||
"title": "Using the desktop application as a server",
|
||||
"notePosition": 10,
|
||||
"prefix": null,
|
||||
"isExpanded": false,
|
||||
"type": "text",
|
||||
"mime": "text/html",
|
||||
"attributes": [
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "WOcw2SLH6tbX",
|
||||
"isInheritable": false,
|
||||
"position": 10
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "x3i7MxGccDuM",
|
||||
"isInheritable": false,
|
||||
"position": 20
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Using the desktop application .md",
|
||||
"attachments": []
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"isClone": false,
|
||||
@ -1039,28 +1077,18 @@
|
||||
"value": "bx bx-mobile-alt",
|
||||
"isInheritable": false,
|
||||
"position": 60
|
||||
},
|
||||
{
|
||||
"type": "relation",
|
||||
"name": "internalLink",
|
||||
"value": "nRqcgfTb97uV",
|
||||
"isInheritable": false,
|
||||
"position": 70
|
||||
}
|
||||
],
|
||||
"format": "markdown",
|
||||
"dataFileName": "Mobile Frontend.md",
|
||||
"attachments": [
|
||||
{
|
||||
"attachmentId": "CyswsZZ3GwtQ",
|
||||
"title": "mobile-tablet.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Mobile Frontend_mobile-tab.png"
|
||||
},
|
||||
{
|
||||
"attachmentId": "txzBbmMtgsrx",
|
||||
"title": "mobile-smartphone.png",
|
||||
"role": "image",
|
||||
"mime": "image/png",
|
||||
"position": 10,
|
||||
"dataFileName": "Mobile Frontend_mobile-sma.png"
|
||||
}
|
||||
]
|
||||
"attachments": []
|
||||
},
|
||||
{
|
||||
"isClone": false,
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
# Using the desktop application as a server
|
||||
Sometimes, setting up a [dedicated server installation](../Server%20Installation.md) is not feasible. The desktop application ships with a fully functional server instance by default.
|
||||
|
||||
You can access this web interface locally by navigating to [http://localhost:37840/login](http://localhost:37840/login).
|
||||
|
||||
> [!NOTE]
|
||||
> The server embedded in the desktop application will only run as long as the desktop application itself is running. So closing the application will also close the server. To overcome this, you can try hiding the application in the system tray.
|
||||
|
||||
## Mobile interface
|
||||
|
||||
By default, this will display the desktop user interface, even on mobile. To switch to the mobile version, simply go to the <a class="reference-link" href="../../Basic%20Concepts%20and%20Features/UI%20Elements/Global%20menu.md">Global menu</a> and select “Switch to the mobile version”.
|
||||
|
||||
## Allowing the port externally on Windows with Windows Defender Firewall
|
||||
|
||||
First, find out the IP of your desktop server by running `ipconfig` in your local terminal. Then try accessing `http://<ip>:37840/login` on another device. If it doesn't work, then most likely the port is blocked by your operating system's firewall.
|
||||
|
||||
If you use Windows Defender Firewall:
|
||||
|
||||
1. Go to Windows's start menu and look for “Windows Defender Firewall with Advanced Security”.
|
||||
2. Go to “Inbound Rules” on the left tree, and select “New Rule” in the “Actions” sidebar on the right.
|
||||
3. Select “Port” and press “Next”.
|
||||
4. Type in `37840` in the “Specific local ports” section and then press “Next”.
|
||||
5. Leave “Allow the connection” checked and press “Next”.
|
||||
6. Configure the networks to apply to (check all if unsure) and then press “Next”.
|
||||
7. Add an appropriate name to the rule (e.g. “Trilium Notes”) and press “Finish”.
|
||||
@ -5,15 +5,9 @@ Mobile frontend is limited in features compared to full desktop frontend. See be
|
||||
|
||||
Note that this is not an Android/iOS app, this is just mobile friendly web page served on the [server edition](Server%20Installation.md).
|
||||
|
||||
## Screenshots
|
||||
## Testing via the desktop application
|
||||
|
||||
### Mobile phone
|
||||
|
||||
|
||||
|
||||
### Tablet
|
||||
|
||||
|
||||
If you are running Trilium without a dedicated [server installation](Server%20Installation.md), you can still test the mobile application using the desktop application. For more information, see <a class="reference-link" href="Desktop%20Installation/Using%20the%20desktop%20application%20.md">Using the desktop application as a server</a>. To access it go to `http://<ip>:37840/login?mobile` .
|
||||
|
||||
## Limitations
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 28 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 84 KiB |
Loading…
x
Reference in New Issue
Block a user