Build your personal knowledge base with Trilium Notes
TypeScript electronelectron-appknowledge-baseknowledge-graphknowledge-managementknowledge-management-graphlocal-firstnote-managmentnote-takernote-takingnotebooknotesnotes-apppersonal-knowledge-basepersonal-wikiscriptableself-hostedself-hostingwiki
import { getLog, options as optionService, utils as coreUtils } from "@triliumnext/core";
import { execFile } from "child_process";
import electron from "electron";
import fs from "fs";
import os from "os";
import path from "path";
// Electron's app.setLoginItemSettings() covers macOS and Windows but is a no-op on
// Linux, where autostart is instead a freedesktop ".desktop" file dropped into the
// per-user autostart directory. We therefore branch on the platform.
// We tag the autostart command so the app can tell, at launch, that it was started
// by the OS at login (and should hide to the tray) rather than launched manually
// (where it must show a window). macOS has no argv hook for login items, so
// wasLaunchedHidden() reads `wasOpenedAtLogin` from the login item there instead.
export const START_HIDDEN_FLAG = "--start-hidden";
/**
* Reconciles the OS autostart entry with the current `launchOnStartup` /
* `hideOnAutoStart` options. Safe to call repeatedly (it's idempotent) and on every
* startup, so the OS state is repaired if it drifts. Failures are logged rather than
* thrown so a permission error (e.g. a read-only autostart dir on Linux) can't take
* down app startup.
*/
export function applyLaunchOnStartup() {
try {
const enabled = optionService.getOptionBool("launchOnStartup");
const hidden = enabled && optionService.getOptionBool("hideOnAutoStart");
if (process.platform === "linux" && process.env.FLATPAK_ID) {
applyFlatpakAutostart(enabled, hidden);
} else if (process.platform === "linux") {
applyLinuxAutostart(enabled, hidden);
} else {
// macOS + Windows: handled natively by Electron. `args` is the Windows
// mechanism and macOS ignores it, so `hidden` reaches macOS through the
// `hideOnAutoStart` option that wasLaunchedHidden() reads at startup.
electron.app.setLoginItemSettings({
openAtLogin: enabled,
args: hidden ? [START_HIDDEN_FLAG] : []
});
}
} catch (e) {
getLog().error(`Failed to apply launch-on-startup setting: ${coreUtils.safeExtractMessageAndStackFromError(e)}`);
}
}
/**
* Whether this process was started hidden by the OS at login (vs. launched manually).
* Used to decide whether the main window should open minimized to the tray.
*/
export function wasLaunchedHidden(): boolean {
if (process.platform === "darwin") {
// A macOS login item carries no arguments, so Electron reports only that the
// app was opened at login and `hideOnAutoStart` decides whether to hide it.
return electron.app.getLoginItemSettings().wasOpenedAtLogin && optionService.getOptionBool("hideOnAutoStart");
}
return process.argv.includes(START_HIDDEN_FLAG);
}
/**
* Registers the IPC the renderer sends after the `launchOnStartup` option changes,
* so the autostart entry updates immediately without an app restart.
*/
export function setupAutoLaunch() {
electron.ipcMain.on("reapply-launch-on-startup", applyLaunchOnStartup);
}
/**
* A Flatpak cannot write the host's autostart directory, and its executable path only exists
* inside the sandbox, so the Background portal writes the entry, with a `flatpak run` command.
*/
function applyFlatpakAutostart(enabled: boolean, hidden: boolean) {
const commandline = hidden ? `['trilium', '${START_HIDDEN_FLAG}']` : "['trilium']";
const options = `{'autostart': <${enabled}>, 'commandline': <${commandline}>}`;
execFile("gdbus", [
"call", "--session",
"--dest", "org.freedesktop.portal.Desktop",
"--object-path", "/org/freedesktop/portal/desktop",
"--method", "org.freedesktop.portal.Background.RequestBackground",
"", options
], (error) => {
if (error) {
getLog().error(`Failed to request autostart from the Background portal: ${error.message}`);
}
});
}
function applyLinuxAutostart(enabled: boolean, hidden: boolean) {
const autostartDir = getLinuxAutostartDir();
const desktopFile = path.join(autostartDir, "trilium.desktop");
if (enabled) {
fs.mkdirSync(autostartDir, { recursive: true });
fs.writeFileSync(desktopFile, buildLinuxDesktopEntry(hidden));
} else {
fs.rmSync(desktopFile, { force: true });
}
}
function getLinuxAutostartDir() {
// XDG Base Directory spec: use $XDG_CONFIG_HOME when set and non-empty,
// otherwise fall back to ~/.config. Read lazily so the env is honoured at apply
// time rather than module load.
const configHome = process.env.XDG_CONFIG_HOME || path.join(os.homedir(), ".config");
return path.join(configHome, "autostart");
}
function buildLinuxDesktopEntry(hidden: boolean) {
// TRILIUM_LAUNCH_EXEC is a pre-quoted command set by packages that run on a system Electron;
// otherwise relaunch the AppImage bundle or the running executable.
const exec = process.env.TRILIUM_LAUNCH_EXEC || `"${process.env.APPIMAGE ?? process.execPath}"`;
const execLine = hidden ? `Exec=${exec} ${START_HIDDEN_FLAG}` : `Exec=${exec}`;
return [
"[Desktop Entry]",
"Type=Application",
`Name=${electron.app.getName()}`,
execLine,
"Terminal=false",
"X-GNOME-Autostart-enabled=true",
""
].join("\n");
}