Windows Service

[tobias-carlbom]

Is it possible to build the project and running it headless as Windows Service?
Are there any instructions?

[MatthewReed303]

@carlbomsdata you can run it in Docker in Windows will auto start/run in the background. Only issue with Docker and Windows it does not support Host network mode and you have to use Bridge.

If you install via NPM, you will have to write a small startup script and put that in your windows startup folder. See the Wiki for Install options https://github.com/frangoteam/FUXA/wiki/Installing-and-Running

[tobias-carlbom]

Thanks! But I actually got it working my making some changes to the index.js file in the electron app. So it runs headless and console output is redirected to a log file. Will share the code tomorrow :)

[MatthewReed303]

@carlbomsdata that would be great, I will add it to the Wiki. Thanks

[tobias-carlbom]

The build instructions is the same as before for client and server:

• cd ./server
• npm install
• cd ../client
• npm install
• npm run build

Then for the electron application

• cd ./app
• npm install
• npm install winston
• Paste this to index.js

const { app } = require('electron');
const path = require('node:path');
const fs = require('fs');
const winston = require('winston');

// Configure the logger.
const logger = winston.createLogger({
  level: 'info',
  format: winston.format.combine(
    winston.format.timestamp(),
    winston.format.printf(
      ({ timestamp, level, message }) => `${timestamp} [${level.toUpperCase()}] ${message}`
    )
  ),
  transports: [
    new winston.transports.File({ filename: 'app.log' }),
    new winston.transports.Console()
  ]
});

// Override global console methods to redirect logging via Winston.
// This will capture logs (from your main process and from the server module).
console.log = (...args) => logger.info(args.join(' '));
console.error = (...args) => logger.error(args.join(' '));
console.warn = (...args) => logger.warn(args.join(' '));

// Single instance check.
const gotTheLock = app.requestSingleInstanceLock();
if (!gotTheLock) {
  logger.info('Another instance is already running. Exiting...');
  app.quit();
} else {
  app.on('second-instance', () => {
    logger.info('A second instance was attempted. Exiting the new instance.');
  });

  // Set up server entry.
  let serverEntry = path.join(__dirname, 'server/main.js');
  if (!fs.existsSync(serverEntry)) {
    serverEntry = path.join(__dirname, '../server/main.js');
  }

  // Determine application data directory.
  const appData =
    process.env.APPDATA ||
    (process.platform === 'darwin'
      ? process.env.HOME + '/Library/Application Support'
      : process.env.HOME + '/.local/share');
  const userDataDir = path.join(appData, 'fuxa-app', 'data');

  if (!fs.existsSync(userDataDir)) {
    fs.mkdirSync(userDataDir, { recursive: true });
  }

  // Set the environment variable for the fuxa server.
  process.env.userDir = userDataDir;

  // Require and start the server logic.
  require(serverEntry);

  // No GUI window will be created since the app is strictly headless.
  app.whenReady().then(() => {
    logger.info('Running in headless mode. No GUI window will be created.');
    // Insert any additional headless-specific initialization here.
  });
}

Now build the application with:

• npm run package

Btw i have only tested this on Windows 11 and on Windows Server 2019. The app.log might not be nessesary since one can look at the server log file while in the fuxa frontend. But i like it :)
Also there is a check so that only one application can be spawned.

Thanks :)

[jingshui127]

使用pm2等启动

[jingshui127]

[tobias-carlbom]

I think its better to create a separate discussion with your question. And also provide as much info as you can :)