Skip to content

A modern, self-hosted backup solution for secure, encrypted backups across local and cloud storage.

2.8 KB
Raw Blame
/**
 * Installation Helper Utilities
 *
 * Helper functions to detect installation type, platform capabilities,
 * and environment configuration for the Pluton application.
 */

export type InstallType = 'docker' | 'binary' | 'server' | 'dev';

/**
 * Check if running as a pkg-packaged binary
 */
export function isBinaryMode(): boolean {
	return !!(process as any).pkg;
}

/**
 * Check if running in Docker container
 */
export function isDockerMode(): boolean {
	return process.env.IS_DOCKER === 'true' || process.env.IS_DOCKER === '1';
}

/**
 * Check if running as a binary on a headless Linux server (no desktop environment)
 */
export function isServerMode(): boolean {
	return isBinaryMode() && process.platform === 'linux' && !isLinuxDesktop();
}

/**
 * Determines the installation type of the application
 * @returns 'docker' | 'binary' | 'server' | 'dev'
 */
export function getInstallType(): InstallType {
	if (isDockerMode()) {
		return 'docker';
	}
	if (isBinaryMode()) {
		return isServerMode() ? 'server' : 'binary';
	}
	return 'dev';
}

/**
 * Checks if running on a Linux desktop environment (not headless/server)
 * by checking for common display environment variables or the PLUTON_LINUX_DESKTOP flag
 * set by the AppImage installer for systemd service mode.
 */
export function isLinuxDesktop(): boolean {
	if (process.platform !== 'linux') return false;

	// Check for explicit desktop flag (set by AppImage installer for systemd service)
	if (process.env.PLUTON_LINUX_DESKTOP === 'true' || process.env.PLUTON_LINUX_DESKTOP === '1') {
		return true;
	}

	// Check for display server (X11 or Wayland)
	const hasDisplay = !!(process.env.DISPLAY || process.env.WAYLAND_DISPLAY);

	// Check for common desktop environment indicators
	const hasDesktopEnv = !!(
		process.env.XDG_CURRENT_DESKTOP ||
		process.env.DESKTOP_SESSION ||
		process.env.GNOME_DESKTOP_SESSION_ID ||
		process.env.KDE_FULL_SESSION
	);

	return hasDisplay || hasDesktopEnv;
}

/**
 * Check if running on a platform that supports keyring (Windows/macOS/Linux Desktop)
 * @deprecated Use isDesktopPlatform() instead
 */
export function isKeyringPlatform(): boolean {
	return isDesktopPlatform();
}

/**
 * Check if running on a desktop platform (Windows/macOS/Linux Desktop)
 */
export function isDesktopPlatform(): boolean {
	const platform = process.platform;
	return (
		platform === 'win32' || platform === 'darwin' || (platform === 'linux' && isLinuxDesktop())
	);
}

/**
 * Check if the app requires keyring-based initial setup
 * @deprecated Use requiresDesktopSetup() instead
 */
export function requiresKeyringSetup(): boolean {
	return requiresDesktopSetup();
}

/**
 * Check if the app requires desktop-based initial setup (via web UI).
 * This is true when: running as binary + on a desktop platform.
 */
export function requiresDesktopSetup(): boolean {
	return isBinaryMode() && isDesktopPlatform();
}