Skip to content

Commit 859d9dc

Browse files
eliandoraneliandoran
committed
docs(user): document system requirements
1 parent 76dd9ba commit 859d9dc

File tree

6 files changed

+132
-1
lines changed

6 files changed

+132
-1
lines changed

‎apps/server/src/assets/doc_notes/en/User Guide/!!!meta.json‎

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html‎

Lines changed: 21 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.html‎

Lines changed: 17 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/User Guide/!!!meta.json‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,41 @@
331331
"format": "markdown",
332332
"dataFileName": "Using the desktop application .md",
333333
"attachments": []
334+
},
335+
{
336+
"isClone": false,
337+
"noteId": "Rp0q8bSP6Ayl",
338+
"notePath": [
339+
"pOsGYCXsbNQG",
340+
"Otzi9La2YAUX",
341+
"poXkQfguuA0U",
342+
"Rp0q8bSP6Ayl"
343+
],
344+
"title": "System Requirements",
345+
"notePosition": 20,
346+
"prefix": null,
347+
"isExpanded": false,
348+
"type": "text",
349+
"mime": "text/html",
350+
"attributes": [
351+
{
352+
"type": "label",
353+
"name": "shareAlias",
354+
"value": "system-requirements",
355+
"isInheritable": false,
356+
"position": 30
357+
},
358+
{
359+
"type": "label",
360+
"name": "iconClass",
361+
"value": "bx bx-chip",
362+
"isInheritable": false,
363+
"position": 40
364+
}
365+
],
366+
"format": "markdown",
367+
"dataFileName": "System Requirements.md",
368+
"attachments": []
334369
}
335370
]
336371
},
@@ -1151,6 +1186,41 @@
11511186
"format": "markdown",
11521187
"dataFileName": "Third-party cloud hosting.md",
11531188
"attachments": []
1189+
},
1190+
{
1191+
"isClone": false,
1192+
"noteId": "iGTnKjubbXkA",
1193+
"notePath": [
1194+
"pOsGYCXsbNQG",
1195+
"Otzi9La2YAUX",
1196+
"WOcw2SLH6tbX",
1197+
"iGTnKjubbXkA"
1198+
],
1199+
"title": "System Requirements",
1200+
"notePosition": 140,
1201+
"prefix": null,
1202+
"isExpanded": false,
1203+
"type": "text",
1204+
"mime": "text/html",
1205+
"attributes": [
1206+
{
1207+
"type": "label",
1208+
"name": "shareAlias",
1209+
"value": "system-requirements",
1210+
"isInheritable": false,
1211+
"position": 30
1212+
},
1213+
{
1214+
"type": "label",
1215+
"name": "iconClass",
1216+
"value": "bx bx-chip",
1217+
"isInheritable": false,
1218+
"position": 40
1219+
}
1220+
],
1221+
"format": "markdown",
1222+
"dataFileName": "System Requirements.md",
1223+
"attachments": []
11541224
}
11551225
]
11561226
},

‎docs/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# System Requirements
2+
The desktop version of Trilium supports all three main operating systems:
3+
4+
* Windows
5+
* Windows 11 is officially supported.
6+
* Windows on ARM is also supported
7+
* Linux:
8+
* Most modern distributions are supported, including NixOS.
9+
* ARM is supported in `aarch64` (no ARM v7 support).
10+
* macOS
11+
* Minimum supported operating system: macOS Monterey
12+
* Both Intel and Apple Silicon devices are supported.

‎docs/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
# System Requirements
2+
* Using Docker, the server can be run on Windows, Linux and macOS devices.
3+
* Native binaries are provided for Linux x64 and ARM (`aarch64`).
4+
5+
## Legacy ARM support
6+
7+
The Docker builds also provide `linux/arm/v7` and `linux/arm/v8` platforms. These platforms are considered legacy since Trilium uses Node.js version 24 which have [officially downgraded support](https://github.com/nodejs/node/commit/6682861d6f) for these platforms to “experimental”.
8+
9+
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 `armv7` and `armv8` will be dropped entirely.
10+
11+
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.

0 commit comments

Comments
 (0)