iffy · August 15, 2024 09:27 · JPorter44 · Apr 2, 2020 · gannons · Apr 2, 2020
diff --git a/.gitignore b/.gitignore
 node_modules
 dist/
 yarn.lock
 wwwroot
diff --git a/README.md b/README.md
diff --git a/main.js b/main.js
 const {app, BrowserWindow, Menu, protocol, ipcMain} = require('electron');
 const log = require('electron-log');
 const {autoUpdater} = require("electron-updater");

 //-------------------------------------------------------------------
 // Logging
 //
 // THIS SECTION IS NOT REQUIRED
 //
 // This logging setup is not required for auto-updates to work,
 // but it sure makes debugging easier :)
 //-------------------------------------------------------------------
 autoUpdater.logger = log;
 autoUpdater.logger.transports.file.level = 'info';
 log.info('App starting...');

 //-------------------------------------------------------------------
 // Define the menu
 //
 // THIS SECTION IS NOT REQUIRED
 //-------------------------------------------------------------------
 let template = []
 if (process.platform === 'darwin') {
  // OS X
  const name = app.getName();
  template.unshift({
    label: name,
    submenu: [
      {
        label: 'About ' + name,
        role: 'about'
      },
      {
        label: 'Quit',
        accelerator: 'Command+Q',
        click() { app.quit(); }
      },
    ]
  })
 }


 //-------------------------------------------------------------------
 // Open a window that displays the version
 //
 // THIS SECTION IS NOT REQUIRED
 //
 // This isn't required for auto-updates to work, but it's easier
 // for the app to show a window than to have to click "About" to see
 // that updates are working.
 //-------------------------------------------------------------------
 let win;

 function sendStatusToWindow(text) {
  log.info(text);
  win.webContents.send('message', text);
 }
 function createDefaultWindow() {
  win = new BrowserWindow();
  win.webContents.openDevTools();
  win.on('closed', () => {
    win = null;
  });
  win.loadURL(`file://${__dirname}/version.html#v${app.getVersion()}`);
  return win;
 }
 autoUpdater.on('checking-for-update', () => {
  sendStatusToWindow('Checking for update...');
 })
 autoUpdater.on('update-available', (ev, info) => {
  sendStatusToWindow('Update available.');
 })
 autoUpdater.on('update-not-available', (ev, info) => {
  sendStatusToWindow('Update not available.');
 })
 autoUpdater.on('error', (ev, err) => {
  sendStatusToWindow('Error in auto-updater.');
 })
 autoUpdater.on('download-progress', (ev, progressObj) => {
  sendStatusToWindow('Download progress...');
 })
 autoUpdater.on('update-downloaded', (ev, info) => {
  sendStatusToWindow('Update downloaded; will install in 5 seconds');
 });
 app.on('ready', function() {
  // Create the Menu
  const menu = Menu.buildFromTemplate(template);
  Menu.setApplicationMenu(menu);

  createDefaultWindow();
 });
 app.on('window-all-closed', () => {
  app.quit();
 });

 //-------------------------------------------------------------------
 // Auto updates
 //
 // For details about these events, see the Wiki:
 // https://github.com/electron-userland/electron-builder/wiki/Auto-Update#events
 //
 // The app doesn't need to listen to any events except `update-downloaded`
 //
 // Uncomment any of the below events to listen for them.  Also,
 // look in the previous section to see them being used.
 //-------------------------------------------------------------------
 // autoUpdater.on('checking-for-update', () => {
 // })
 // autoUpdater.on('update-available', (ev, info) => {
 // })
 // autoUpdater.on('update-not-available', (ev, info) => {
 // })
 // autoUpdater.on('error', (ev, err) => {
 // })
 // autoUpdater.on('download-progress', (ev, progressObj) => {
 // })
 autoUpdater.on('update-downloaded', (ev, info) => {
  // Wait 5 seconds, then quit and install
  // In your application, you don't need to wait 5 seconds.
  // You could call autoUpdater.quitAndInstall(); immediately
  setTimeout(function() {
    autoUpdater.quitAndInstall();  
  }, 5000)
 })

 app.on('ready', function()  {
  autoUpdater.checkForUpdates();
 });
diff --git a/package.json b/package.json
 {
  "name": "electron-updater-generic-example",
  "version": "0.2.0",
  "main": "main.js",
  "description": "electron-updater generic example project",
  "author": "Matt Haggard",
  "devDependencies": {
    "electron": "^1.4.15",
    "electron-builder": "^12.3.1",
    "http-server": "^0.9.0"
  },
  "dependencies": {
    "electron-log": "^1.3.0",
    "electron-updater": "^1.4.2"
  },
  "build": {
    "publish": [
      {
        "provider": "generic",
        "url": "http://127.0.0.1:8080/"
      }
    ],
    "appId": "com.github.iffy.electronupdatergenericexample",
    "mac": {
      "category": "your.app.category.type",
      "target": [
        "zip",
        "dmg"
      ]
    },
    "nsis": {
      "perMachine": true
    }
  }
 }
diff --git a/version.html b/version.html
 <!DOCTYPE html>
 <html>
 <head>
  <title>Electron Updater Example</title>
 </head>
 <body>
  Current version: <span id="version">vX.Y.Z</span>
  <div id="messages"></div>
 <script>
 // Display the current version
 let version = window.location.hash.substring(1);
 document.getElementById('version').innerText = version;

 // Listen for messages
 const {ipcRenderer} = require('electron');
 ipcRenderer.on('message', function(event, text) {
  var container = document.getElementById('messages');
  var message = document.createElement('div');
  message.innerHTML = text;
  container.appendChild(message);
 })
 </script>
 </body>
 </html>
	const {app, BrowserWindow, Menu, protocol, ipcMain} = require('electron');
	const log = require('electron-log');
	const {autoUpdater} = require("electron-updater");

	//-------------------------------------------------------------------
	// Logging
	//
	// THIS SECTION IS NOT REQUIRED
	//
	// This logging setup is not required for auto-updates to work,
	// but it sure makes debugging easier :)
	//-------------------------------------------------------------------
	autoUpdater.logger = log;
	autoUpdater.logger.transports.file.level = 'info';
	log.info('App starting...');

	//-------------------------------------------------------------------
	// Define the menu
	//
	// THIS SECTION IS NOT REQUIRED
	//-------------------------------------------------------------------
	let template = []
	if (process.platform === 'darwin') {
	// OS X
	const name = app.getName();
	template.unshift({
	label: name,
	submenu: [
	{
	label: 'About ' + name,
	role: 'about'
	},
	{
	label: 'Quit',
	accelerator: 'Command+Q',
	click() { app.quit(); }
	},
	]
	})
	}


	//-------------------------------------------------------------------
	// Open a window that displays the version
	//
	// THIS SECTION IS NOT REQUIRED
	//
	// This isn't required for auto-updates to work, but it's easier
	// for the app to show a window than to have to click "About" to see
	// that updates are working.
	//-------------------------------------------------------------------
	let win;

	function sendStatusToWindow(text) {
	log.info(text);
	win.webContents.send('message', text);
	}
	function createDefaultWindow() {
	win = new BrowserWindow();
	win.webContents.openDevTools();
	win.on('closed', () => {
	win = null;
	});
	win.loadURL(`file://${__dirname}/version.html#v${app.getVersion()}`);
	return win;
	}
	autoUpdater.on('checking-for-update', () => {
	sendStatusToWindow('Checking for update...');
	})
	autoUpdater.on('update-available', (ev, info) => {
	sendStatusToWindow('Update available.');
	})
	autoUpdater.on('update-not-available', (ev, info) => {
	sendStatusToWindow('Update not available.');
	})
	autoUpdater.on('error', (ev, err) => {
	sendStatusToWindow('Error in auto-updater.');
	})
	autoUpdater.on('download-progress', (ev, progressObj) => {
	sendStatusToWindow('Download progress...');
	})
	autoUpdater.on('update-downloaded', (ev, info) => {
	sendStatusToWindow('Update downloaded; will install in 5 seconds');
	});
	app.on('ready', function() {
	// Create the Menu
	const menu = Menu.buildFromTemplate(template);
	Menu.setApplicationMenu(menu);

	createDefaultWindow();
	});
	app.on('window-all-closed', () => {
	app.quit();
	});

	//-------------------------------------------------------------------
	// Auto updates
	//
	// For details about these events, see the Wiki:
	// https://github.com/electron-userland/electron-builder/wiki/Auto-Update#events
	//
	// The app doesn't need to listen to any events except `update-downloaded`
	//
	// Uncomment any of the below events to listen for them. Also,
	// look in the previous section to see them being used.
	//-------------------------------------------------------------------
	// autoUpdater.on('checking-for-update', () => {
	// })
	// autoUpdater.on('update-available', (ev, info) => {
	// })
	// autoUpdater.on('update-not-available', (ev, info) => {
	// })
	// autoUpdater.on('error', (ev, err) => {
	// })
	// autoUpdater.on('download-progress', (ev, progressObj) => {
	// })
	autoUpdater.on('update-downloaded', (ev, info) => {
	// Wait 5 seconds, then quit and install
	// In your application, you don't need to wait 5 seconds.
	// You could call autoUpdater.quitAndInstall(); immediately
	setTimeout(function() {
	autoUpdater.quitAndInstall();
	}, 5000)
	})

	app.on('ready', function() {
	autoUpdater.checkForUpdates();
	});
	{
	"name": "electron-updater-generic-example",
	"version": "0.2.0",
	"main": "main.js",
	"description": "electron-updater generic example project",
	"author": "Matt Haggard",
	"devDependencies": {
	"electron": "^1.4.15",
	"electron-builder": "^12.3.1",
	"http-server": "^0.9.0"
	},
	"dependencies": {
	"electron-log": "^1.3.0",
	"electron-updater": "^1.4.2"
	},
	"build": {
	"publish": [
	{
	"provider": "generic",
	"url": "http://127.0.0.1:8080/"
	}
	],
	"appId": "com.github.iffy.electronupdatergenericexample",
	"mac": {
	"category": "your.app.category.type",
	"target": [
	"zip",
	"dmg"
	]
	},
	"nsis": {
	"perMachine": true
	}
	}
	}
	<!DOCTYPE html>
	<html>
	<head>
	<title>Electron Updater Example</title>
	</head>
	<body>
	Current version: <span id="version">vX.Y.Z</span>
	<div id="messages"></div>
	<script>
	// Display the current version
	let version = window.location.hash.substring(1);
	document.getElementById('version').innerText = version;

	// Listen for messages
	const {ipcRenderer} = require('electron');
	ipcRenderer.on('message', function(event, text) {
	var container = document.getElementById('messages');
	var message = document.createElement('div');
	message.innerHTML = text;
	container.appendChild(message);
	})
	</script>
	</body>
	</html>