mirror of
				https://github.com/zadam/trilium.git
				synced 2025-11-04 05:28:59 +01:00 
			
		
		
		
	docs(user): document system requirements
	
		
			
	
		
	
	
		
	
		
			Some checks failed
		
		
	
	
		
			
				
	
				Checks / main (push) Has been cancelled
				
			
		
			
				
	
				CodeQL Advanced / Analyze (actions) (push) Has been cancelled
				
			
		
			
				
	
				CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
				
			
		
			
				
	
				Deploy Documentation / Build and Deploy Documentation (push) Has been cancelled
				
			
		
			
				
	
				Dev / Test development (push) Has been cancelled
				
			
		
			
				
	
				/ Check Docker build (Dockerfile) (push) Has been cancelled
				
			
		
			
				
	
				/ Check Docker build (Dockerfile.alpine) (push) Has been cancelled
				
			
		
			
				
	
				playwright / main (push) Has been cancelled
				
			
		
			
				
	
				Dev / Build Docker image (push) Has been cancelled
				
			
		
			
				
	
				Dev / Check Docker build (Dockerfile) (push) Has been cancelled
				
			
		
			
				
	
				Dev / Check Docker build (Dockerfile.alpine) (push) Has been cancelled
				
			
		
			
				
	
				/ Build Docker images (Dockerfile, ubuntu-24.04-arm, linux/arm64) (push) Has been cancelled
				
			
		
			
				
	
				/ Build Docker images (Dockerfile.alpine, ubuntu-latest, linux/amd64) (push) Has been cancelled
				
			
		
			
				
	
				/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v7) (push) Has been cancelled
				
			
		
			
				
	
				/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v8) (push) Has been cancelled
				
			
		
			
				
	
				/ Merge manifest lists (push) Has been cancelled
				
			
		
		
	
	
				
					
				
			
		
			Some checks failed
		
		
	
	Checks / main (push) Has been cancelled
				
			CodeQL Advanced / Analyze (actions) (push) Has been cancelled
				
			CodeQL Advanced / Analyze (javascript-typescript) (push) Has been cancelled
				
			Deploy Documentation / Build and Deploy Documentation (push) Has been cancelled
				
			Dev / Test development (push) Has been cancelled
				
			/ Check Docker build (Dockerfile) (push) Has been cancelled
				
			/ Check Docker build (Dockerfile.alpine) (push) Has been cancelled
				
			playwright / main (push) Has been cancelled
				
			Dev / Build Docker image (push) Has been cancelled
				
			Dev / Check Docker build (Dockerfile) (push) Has been cancelled
				
			Dev / Check Docker build (Dockerfile.alpine) (push) Has been cancelled
				
			/ Build Docker images (Dockerfile, ubuntu-24.04-arm, linux/arm64) (push) Has been cancelled
				
			/ Build Docker images (Dockerfile.alpine, ubuntu-latest, linux/amd64) (push) Has been cancelled
				
			/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v7) (push) Has been cancelled
				
			/ Build Docker images (Dockerfile.legacy, ubuntu-24.04-arm, linux/arm/v8) (push) Has been cancelled
				
			/ Merge manifest lists (push) Has been cancelled
				
			This commit is contained in:
		
							parent
							
								
									76dd9baea8
								
							
						
					
					
						commit
						859d9dcd04
					
				
							
								
								
									
										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
											
										
									
								
							
							
								
								
									
										21
									
								
								apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.html
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,21 @@
 | 
				
			|||||||
 | 
					<p>The desktop version of Trilium supports all three main operating systems:</p>
 | 
				
			||||||
 | 
					<ul>
 | 
				
			||||||
 | 
					  <li data-list-item-id="e9369fe00e2202eddd7638f9115592204">Windows
 | 
				
			||||||
 | 
					    <ul>
 | 
				
			||||||
 | 
					      <li data-list-item-id="ecbf2fbdd331d51182332dd3d33aeab15">Windows 11 is officially supported.</li>
 | 
				
			||||||
 | 
					      <li data-list-item-id="e029be961ae70031059602696f29f72bf">Windows on ARM is also supported</li>
 | 
				
			||||||
 | 
					    </ul>
 | 
				
			||||||
 | 
					  </li>
 | 
				
			||||||
 | 
					  <li data-list-item-id="e87f0cd97f723e8bd59f181622122906b">Linux:
 | 
				
			||||||
 | 
					    <ul>
 | 
				
			||||||
 | 
					      <li data-list-item-id="efa1b52fdb55980bee3f3482ee0f55dfa">Most modern distributions are supported, including NixOS.</li>
 | 
				
			||||||
 | 
					      <li data-list-item-id="efe26984776dbcafc56afcc83a4d1b85b">ARM is supported in <code>aarch64</code> (no ARM v7 support). </li>
 | 
				
			||||||
 | 
					    </ul>
 | 
				
			||||||
 | 
					  </li>
 | 
				
			||||||
 | 
					  <li data-list-item-id="eabb3c5c35295997be8b2579caa6cae1b">macOS
 | 
				
			||||||
 | 
					    <ul>
 | 
				
			||||||
 | 
					      <li data-list-item-id="e2848f18f02ba6ded3f20f46e12fecc54">Minimum supported operating system: macOS Monterey </li>
 | 
				
			||||||
 | 
					      <li data-list-item-id="ea709467c48e79ae0c7e4d3c5e9261505">Both Intel and Apple Silicon devices are supported.</li>
 | 
				
			||||||
 | 
					    </ul>
 | 
				
			||||||
 | 
					  </li>
 | 
				
			||||||
 | 
					</ul>
 | 
				
			||||||
							
								
								
									
										17
									
								
								apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.html
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										17
									
								
								apps/server/src/assets/doc_notes/en/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.html
									
									
									
										generated
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,17 @@
 | 
				
			|||||||
 | 
					<ul>
 | 
				
			||||||
 | 
					  <li data-list-item-id="edfd91483e74d0b747136f134131b9720">Using Docker, the server can be run on Windows, Linux and macOS devices.</li>
 | 
				
			||||||
 | 
					  <li
 | 
				
			||||||
 | 
					  data-list-item-id="efde3b56d3d4f5b167bad52f55637e111">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>
 | 
				
			||||||
							
								
								
									
										70
									
								
								docs/User Guide/!!!meta.json
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										70
									
								
								docs/User Guide/!!!meta.json
									
									
									
									
										vendored
									
									
								
							@ -331,6 +331,41 @@
 | 
				
			|||||||
                                    "format": "markdown",
 | 
					                                    "format": "markdown",
 | 
				
			||||||
                                    "dataFileName": "Using the desktop application .md",
 | 
					                                    "dataFileName": "Using the desktop application .md",
 | 
				
			||||||
                                    "attachments": []
 | 
					                                    "attachments": []
 | 
				
			||||||
 | 
					                                },
 | 
				
			||||||
 | 
					                                {
 | 
				
			||||||
 | 
					                                    "isClone": false,
 | 
				
			||||||
 | 
					                                    "noteId": "Rp0q8bSP6Ayl",
 | 
				
			||||||
 | 
					                                    "notePath": [
 | 
				
			||||||
 | 
					                                        "pOsGYCXsbNQG",
 | 
				
			||||||
 | 
					                                        "Otzi9La2YAUX",
 | 
				
			||||||
 | 
					                                        "poXkQfguuA0U",
 | 
				
			||||||
 | 
					                                        "Rp0q8bSP6Ayl"
 | 
				
			||||||
 | 
					                                    ],
 | 
				
			||||||
 | 
					                                    "title": "System Requirements",
 | 
				
			||||||
 | 
					                                    "notePosition": 20,
 | 
				
			||||||
 | 
					                                    "prefix": null,
 | 
				
			||||||
 | 
					                                    "isExpanded": false,
 | 
				
			||||||
 | 
					                                    "type": "text",
 | 
				
			||||||
 | 
					                                    "mime": "text/html",
 | 
				
			||||||
 | 
					                                    "attributes": [
 | 
				
			||||||
 | 
					                                        {
 | 
				
			||||||
 | 
					                                            "type": "label",
 | 
				
			||||||
 | 
					                                            "name": "shareAlias",
 | 
				
			||||||
 | 
					                                            "value": "system-requirements",
 | 
				
			||||||
 | 
					                                            "isInheritable": false,
 | 
				
			||||||
 | 
					                                            "position": 30
 | 
				
			||||||
 | 
					                                        },
 | 
				
			||||||
 | 
					                                        {
 | 
				
			||||||
 | 
					                                            "type": "label",
 | 
				
			||||||
 | 
					                                            "name": "iconClass",
 | 
				
			||||||
 | 
					                                            "value": "bx bx-chip",
 | 
				
			||||||
 | 
					                                            "isInheritable": false,
 | 
				
			||||||
 | 
					                                            "position": 40
 | 
				
			||||||
 | 
					                                        }
 | 
				
			||||||
 | 
					                                    ],
 | 
				
			||||||
 | 
					                                    "format": "markdown",
 | 
				
			||||||
 | 
					                                    "dataFileName": "System Requirements.md",
 | 
				
			||||||
 | 
					                                    "attachments": []
 | 
				
			||||||
                                }
 | 
					                                }
 | 
				
			||||||
                            ]
 | 
					                            ]
 | 
				
			||||||
                        },
 | 
					                        },
 | 
				
			||||||
@ -1151,6 +1186,41 @@
 | 
				
			|||||||
                                    "format": "markdown",
 | 
					                                    "format": "markdown",
 | 
				
			||||||
                                    "dataFileName": "Third-party cloud hosting.md",
 | 
					                                    "dataFileName": "Third-party cloud hosting.md",
 | 
				
			||||||
                                    "attachments": []
 | 
					                                    "attachments": []
 | 
				
			||||||
 | 
					                                },
 | 
				
			||||||
 | 
					                                {
 | 
				
			||||||
 | 
					                                    "isClone": false,
 | 
				
			||||||
 | 
					                                    "noteId": "iGTnKjubbXkA",
 | 
				
			||||||
 | 
					                                    "notePath": [
 | 
				
			||||||
 | 
					                                        "pOsGYCXsbNQG",
 | 
				
			||||||
 | 
					                                        "Otzi9La2YAUX",
 | 
				
			||||||
 | 
					                                        "WOcw2SLH6tbX",
 | 
				
			||||||
 | 
					                                        "iGTnKjubbXkA"
 | 
				
			||||||
 | 
					                                    ],
 | 
				
			||||||
 | 
					                                    "title": "System Requirements",
 | 
				
			||||||
 | 
					                                    "notePosition": 140,
 | 
				
			||||||
 | 
					                                    "prefix": null,
 | 
				
			||||||
 | 
					                                    "isExpanded": false,
 | 
				
			||||||
 | 
					                                    "type": "text",
 | 
				
			||||||
 | 
					                                    "mime": "text/html",
 | 
				
			||||||
 | 
					                                    "attributes": [
 | 
				
			||||||
 | 
					                                        {
 | 
				
			||||||
 | 
					                                            "type": "label",
 | 
				
			||||||
 | 
					                                            "name": "shareAlias",
 | 
				
			||||||
 | 
					                                            "value": "system-requirements",
 | 
				
			||||||
 | 
					                                            "isInheritable": false,
 | 
				
			||||||
 | 
					                                            "position": 30
 | 
				
			||||||
 | 
					                                        },
 | 
				
			||||||
 | 
					                                        {
 | 
				
			||||||
 | 
					                                            "type": "label",
 | 
				
			||||||
 | 
					                                            "name": "iconClass",
 | 
				
			||||||
 | 
					                                            "value": "bx bx-chip",
 | 
				
			||||||
 | 
					                                            "isInheritable": false,
 | 
				
			||||||
 | 
					                                            "position": 40
 | 
				
			||||||
 | 
					                                        }
 | 
				
			||||||
 | 
					                                    ],
 | 
				
			||||||
 | 
					                                    "format": "markdown",
 | 
				
			||||||
 | 
					                                    "dataFileName": "System Requirements.md",
 | 
				
			||||||
 | 
					                                    "attachments": []
 | 
				
			||||||
                                }
 | 
					                                }
 | 
				
			||||||
                            ]
 | 
					                            ]
 | 
				
			||||||
                        },
 | 
					                        },
 | 
				
			||||||
 | 
				
			|||||||
							
								
								
									
										12
									
								
								docs/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										12
									
								
								docs/User Guide/User Guide/Installation & Setup/Desktop Installation/System Requirements.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,12 @@
 | 
				
			|||||||
 | 
					# System Requirements
 | 
				
			||||||
 | 
					The desktop version of Trilium supports all three main operating systems:
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					*   Windows
 | 
				
			||||||
 | 
					    *   Windows 11 is officially supported.
 | 
				
			||||||
 | 
					    *   Windows on ARM is also supported
 | 
				
			||||||
 | 
					*   Linux:
 | 
				
			||||||
 | 
					    *   Most modern distributions are supported, including NixOS.
 | 
				
			||||||
 | 
					    *   ARM is supported in `aarch64` (no ARM v7 support).
 | 
				
			||||||
 | 
					*   macOS
 | 
				
			||||||
 | 
					    *   Minimum supported operating system: macOS Monterey
 | 
				
			||||||
 | 
					    *   Both Intel and Apple Silicon devices are supported.
 | 
				
			||||||
							
								
								
									
										11
									
								
								docs/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							
							
						
						
									
										11
									
								
								docs/User Guide/User Guide/Installation & Setup/Server Installation/System Requirements.md
									
									
									
									
										vendored
									
									
										Normal file
									
								
							@ -0,0 +1,11 @@
 | 
				
			|||||||
 | 
					# System Requirements
 | 
				
			||||||
 | 
					*   Using Docker, the server can be run on Windows, Linux and macOS devices.
 | 
				
			||||||
 | 
					*   Native binaries are provided for Linux x64 and ARM (`aarch64`).
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					## Legacy ARM support
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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”.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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.
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					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.
 | 
				
			||||||
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user