mirror of
				https://github.com/TriliumNext/Notes.git
				synced 2025-11-04 15:11:31 +08:00 
			
		
		
		
	feat(docs): add v1 of the full documentation
This commit is contained in:
		
							parent
							
								
									b7cb2e6e97
								
							
						
					
					
						commit
						064799e8cb
					
				
							
								
								
									
										49
									
								
								data-docs/config.ini
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										49
									
								
								data-docs/config.ini
									
									
									
									
									
										Normal file
									
								
							@ -0,0 +1,49 @@
 | 
				
			|||||||
 | 
					[General]
 | 
				
			||||||
 | 
					# Instance name can be used to distinguish between different instances using backend api.getInstanceName()
 | 
				
			||||||
 | 
					instanceName=
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# set to true to allow using Trilium without authentication (makes sense for server build only, desktop build doesn't need password)
 | 
				
			||||||
 | 
					noAuthentication=false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# set to true to disable backups (e.g. because of limited space on server)
 | 
				
			||||||
 | 
					noBackup=false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Disable automatically generating desktop icon
 | 
				
			||||||
 | 
					# noDesktopIcon=true
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[Network]
 | 
				
			||||||
 | 
					# host setting is relevant only for web deployments - set the host on which the server will listen
 | 
				
			||||||
 | 
					# host=0.0.0.0
 | 
				
			||||||
 | 
					# port setting is relevant only for web deployments, desktop builds run on a fixed port (changeable with TRILIUM_PORT environment variable)
 | 
				
			||||||
 | 
					port=8080
 | 
				
			||||||
 | 
					# true for TLS/SSL/HTTPS (secure), false for HTTP (insecure).
 | 
				
			||||||
 | 
					https=false
 | 
				
			||||||
 | 
					# path to certificate (run "bash bin/generate-cert.sh" to generate self-signed certificate). Relevant only if https=true
 | 
				
			||||||
 | 
					certPath=
 | 
				
			||||||
 | 
					keyPath=
 | 
				
			||||||
 | 
					# setting to give trust to reverse proxies, a comma-separated list of trusted rev. proxy IPs can be specified (CIDR notation is permitted),
 | 
				
			||||||
 | 
					# alternatively 'true' will make use of the leftmost IP in X-Forwarded-For, ultimately an integer can be used to tell about the number of hops between
 | 
				
			||||||
 | 
					# Trilium (which is hop 0) and the first trusted rev. proxy. 
 | 
				
			||||||
 | 
					# once set, expressjs will use the X-Forwarded-For header set by the rev. proxy to determinate the real IPs of clients.
 | 
				
			||||||
 | 
					# expressjs shortcuts are supported: loopback(127.0.0.1/8, ::1/128), linklocal(169.254.0.0/16, fe80::/10), uniquelocal(10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16, fc00::/7)
 | 
				
			||||||
 | 
					trustedReverseProxy=false
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[Session]
 | 
				
			||||||
 | 
					# Use this setting to set a custom value for the "Path" Attribute value of the session cookie.
 | 
				
			||||||
 | 
					# This can be useful, when you have several instances running on the same domain, under different paths (e.g. by using a reverse proxy).
 | 
				
			||||||
 | 
					# It prevents your instances from overwriting each others' cookies, allowing you to stay logged in multiple instances simultanteously.
 | 
				
			||||||
 | 
					# E.g. if you have instances running under https://your-domain.com/triliumNext/instanceA and https://your-domain.com/triliumNext/instanceB
 | 
				
			||||||
 | 
					# you would want to set the cookiePath value to "/triliumNext/instanceA" for your first and "/triliumNext/instanceB" for your second instance
 | 
				
			||||||
 | 
					cookiePath=/
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					# Use this setting to set a custom value for the "Max-Age" Attribute of the session cookie.
 | 
				
			||||||
 | 
					# This controls how long your session will be valid, before it expires and you need to log in again, when you use the "Remember Me" option.
 | 
				
			||||||
 | 
					# Value needs to be entered in Seconds.
 | 
				
			||||||
 | 
					# Default value is 1814400 Seconds, which is 21 Days.
 | 
				
			||||||
 | 
					cookieMaxAge=1814400
 | 
				
			||||||
 | 
					
 | 
				
			||||||
 | 
					[Sync]
 | 
				
			||||||
 | 
					#syncServerHost=
 | 
				
			||||||
 | 
					#syncServerTimeout=
 | 
				
			||||||
 | 
					#syncServerProxy=
 | 
				
			||||||
							
								
								
									
										
											BIN
										
									
								
								data-docs/document.db
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										
											BIN
										
									
								
								data-docs/document.db
									
									
									
									
									
										Normal file
									
								
							
										
											Binary file not shown.
										
									
								
							
		Loading…
	
	
			
			x
			
			
		
	
		Reference in New Issue
	
	Block a user