Electron Forge
  • Getting Started
  • Importing an Existing Project
  • CLI
  • Core Concepts
    • Why Electron Forge?
    • Build Lifecycle
  • Configuration
    • Configuration Overview
    • TypeScript Setup
    • Plugins
      • Webpack Plugin
      • Vite Plugin
      • Electronegativity Plugin
      • Auto Unpack Native Modules Plugin
      • Local Electron Plugin
      • Fuses Plugin
    • Makers
      • AppX
      • deb
      • DMG
      • Flatpak
      • pkg
      • RPM
      • Snapcraft
      • Squirrel.Windows
      • WiX MSI
      • ZIP
    • Publishers
      • Bitbucket
      • Electron Release Server
      • GitHub
      • Google Cloud Storage
      • Nucleus
      • S3
      • Snapcraft
    • Hooks
  • Built-in Templates
    • Webpack
    • Webpack + Typescript
    • Vite
    • Vite + TypeScript
  • Guides
    • Code Signing
      • Signing a Windows app
      • Signing a macOS app
    • Custom App Icons
    • Framework Integration
      • React
      • React with TypeScript
      • Vue 3
    • Developing with WSL
  • Advanced
    • Auto Update
    • Debugging
    • Extending Electron Forge
      • Writing Plugins
      • Writing Templates
      • Writing Makers
      • Writing Publishers
    • API Docs
Powered by GitBook
On this page

Was this helpful?

Edit on GitHub
  1. Configuration

Publishers

PreviousZIPNextBitbucket

Last updated 10 months ago

Was this helpful?

Publishers are Electron Forge's way of taking the artifacts generated by the and sending them to a service somewhere for you to distribute or . This could be your update server or an S3 bucket.

Each publisher has to be configured in the publishers section of your Forge configuration with which platforms to run for and the publisher specific config. For example:

forge.config.js
module.exports = {
  publishers: [
    {
      name: '@electron-forge/publisher-s3',
      platforms: ['darwin', 'linux'],
      config: {
        bucket: 'my-bucket',
        folder: 'my/key/prefix'
      }
    }
  ]
};

Please note that all publishers default to publishing all platforms, so you only need to specify the platforms key if you don't want that default.

make command
use as updates