mirror of https://github.com/OutlineFoundation/outline-server.git synced 2026-05-13 13:58:57 +00:00

History

J. Yi 494389944e chore(manager): 📄 re-generate dependency licenses (#1305 ) Our [`licenses.txt`](`508a5a2af5/src/server_manager/web_app/ui_components/licenses/licenses.txt`) file for Outline Manager is not correct, it is just a simple duplication of the [`README.md`](`508a5a2af5/src/server_manager/README.md`). In this PR, I re-generate the `licenses.txt` file with all dependencies and update the steps in order to correctly generate it.		2023-03-09 00:05:02 -05:00
..
cloud	fix(manager): specify a higher per_page for DigitalOcean API call (#1113 )	2022-10-05 04:11:37 -04:00
electron_app	build(devtools/build): 👷 exclude jsign.jar from the repository (#1263 )	2023-01-06 19:07:40 -05:00
images	fix(manager): removes special case for manager connection key (#1138 )	2022-08-16 10:05:31 -04:00
infrastructure	chore(manager): clean up Manager errors (#1151 )	2022-08-23 20:19:05 -04:00
install_scripts	Add icanhazip.com as IP source (#1207 )	2022-10-24 15:37:55 -05:00
messages	feat(manager): 🌐 support 11 more languages (#1285 )	2023-02-06 18:05:52 -05:00
model	feat: add getAccessKey method to the management API(#1142 )	2023-01-18 12:04:36 -06:00
scripts	refactor(manager): ♻️ change electron-updater's url to S3 (#1135 )	2022-08-03 12:54:23 -04:00
types	Refactor	2022-05-13 11:58:52 -04:00
web_app	chore(manager): 📄 re-generate dependency licenses (#1305 )	2023-03-09 00:05:02 -05:00
base.webpack.js	Show the GCP magic flow by default	2022-06-27 11:43:23 -04:00
browser.webpack.js	Migrate to eslint	2022-03-10 01:50:59 +00:00
css-in-js-rtl-loader.js	Format remaining files	2022-03-10 02:25:48 +00:00
electron_and_karma_chromium.spec.ts	build(devtools/build): 👷 exclude jsign.jar from the repository (#1263 )	2023-01-06 19:07:40 -05:00
electron_renderer.webpack.js	Migrate to eslint	2022-03-10 01:50:59 +00:00
gallery.webpack.js	Format remaining files	2022-03-10 02:25:48 +00:00
index.html	Convert to Polymer 3	2020-04-30 01:16:56 -04:00
package.json	chore(manager): 🎉 release v1.14.0 for all platforms (#1286 )	2023-02-08 15:23:24 -05:00
README.md	feat(manager): upgrade DigitalOcean image (#1148 )	2022-08-22 15:00:16 -04:00
test.action.sh	Migrate from Yarn to Node lts/gallium (#1004 )	2021-11-05 16:40:34 -04:00
tsconfig.json	Avoid passing objects across the boundary	2022-03-25 13:44:36 -04:00

README.md

Outline Manager

Running

To run the Outline Manager Electron app:

npm run action server_manager/electron_app/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_app/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/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/build ${PLATFORM} -- --buildMode=[debug,release]

Where ${PLATFORM} is one of linux, macos, 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.

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_app/start ${PLATFORM}