The following NPM package may be included in this product:

 - outline-manager@1.9.0

This package contains the following license and notice below:

# Outline Manager

## Running

To run the Outline Manager Electron app:
```
npm run action server_manager/electron_app/start
```

To run the Outline Manager Electron app with a development build (code not minified):
```
BUILD_ENV=development npm run action server_manager/electron_app/start
```

## Development Server

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

```
npm run action server_manager/web_app/start
```

## Gallery Server for UI Development

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

```
npm run action server_manager/web_app/start_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:
```
npm run action 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](https://www.winehq.org/download) installed.
- Linux: tar.gz files.
- macOS: dmg files if built from macOS, zip files otherwise.

## Releases

To perform a release, use
```
npm run action 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](https://sentry.io/) for local builds, run:
``` bash
export SENTRY_DSN=[Sentry development API key]
npm run action server_manager/electron_app/start
```

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

-----------

This file was generated with generate-license-file! https://www.npmjs.com/package/generate-license-file------

IP Geolocation by DB-IP (https://db-ip.com)

This database is licensed under a Creative Commons Attribution 4.0 International License (https://creativecommons.org/licenses/by/4.0/)