Auto Update Custom Provider Example

[devinhaughey]

electron-builder: 20.38.5
electron-updater: 4.0.14
Target: Windows_64

I am trying to use the auto-updater to contact a custom server using authentication and bearer tokens, but it appears that there isn't an option for the generic server to pass http headers or any sort of authentication to a server. I looked into the source code and saw that it is possible to pass the http headers, but the libraries aren't exposed for usage in the generic server provider code or custom.

In researching this, I came across this post about custom providers #3261 which describes what I would like to, but there isn't any documentation on how to use it besides a comment to look at the test as an example.

Has anyone used the custom provider to pass http headers or authentication like I would like to do?
Could someone provide an example or update the documentation for usage of custom provider for auto-updater?

[W1M0R]

You can look at these files for usage ideas:
https://github.com/electron-userland/electron-builder/blob/master/packages/electron-publish/src/publisher.ts
https://github.com/electron-userland/electron-builder/blob/master/test/src/PublishManagerTest.ts

For an electron-builder configuration in your package.json that looks like this:

  "build": {
    "directories": {
      "buildResources": "resources",
      "output": "release"
    },
    "publish": {
      "provider": "custom"
    }
  },

Put the following file in your buildResources folder, e.g. resources/electron-publisher-custom.js:

const electronPublish = require('electron-publish');
class Publisher extends electronPublish.Publisher {
  async upload(task) {
    console.log('electron-publisher-custom', task.file);
  }
};
module.exports = Publisher;

Run electron-builder --publish always to see the output of the custom provider.

[stale]

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.