Skip to content

Latest commit

 

History

History

server_manager

README.md

Outline Manager Logo  Outline Manager

Build and Test

Running

To run the Outline Manager Electron app:

npm run action server_manager/electron/start ${PLATFORM}

To run the Outline Manager Electron app with a development build (code not minified):

BUILD_ENV=development npm run action server_manager/electron/start ${PLATFORM}

Where ${PLATFORM} is one of linux, macos, windows.

Development Server

To run the Outline Manager as a web app on the browser and listen for changes:

npm run action server_manager/www/start

Debug an existing binary

You can run an existing binary in debug mode by setting OUTLINE_DEBUG=true. This will enable the Developer menu on the application window.

Packaging

To build the app binary:

npm run action server_manager/electron/build ${PLATFORM} -- --buildMode=[debug,release]

Where ${PLATFORM} is one of linux, macos, windows.

The per-platform standalone apps will be at output/build/server_manager/electron/static/dist.

  • Windows: zip files. Only generated if you have wine installed.
  • Linux: tar.gz files.
  • macOS: dmg files if built from macOS, zip files otherwise.

NOTE: If you are building for macOS, you may need to run security unlock-keychain login.keychain so electron-builder has access to your certificates.

Error reporting

To enable error reporting through Sentry for local builds, run:

export SENTRY_DSN=[Sentry development API key]
npm run action server_manager/electron/start ${PLATFORM}