outline-server/src/server_manager

Outline Manager

Running

To run the Outline Manager Electron app:

yarn do server_manager/electron_app/run

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

BUILD_ENV=development yarn do server_manager/electron_app/run

Development Server

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

yarn do server_manager/web_app/run

Gallery Server for UI Development

We have a server app to for quickly iterating on UI components. To spin it up, run

yarn do server_manager/web_app/run_gallery

Changes to UI components will be hot reloaded into the gallery.

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:

yarn do server_manager/electron_app/package_${PLATFORM}

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

The per-platform standalone apps will be at build/electron_app/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.

Releases

To perform a release, use

yarn do server_manager/electron_app/release

This will perform a clean and reinstall all dependencies to make sure the build is not tainted.

Error reporting

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

export SENTRY_DSN=[Sentry development API key]
yarn do server_manager/electron_app/run

Release builds on CI are configured with a production Sentry API key.