mirror of
https://github.com/OutlineFoundation/outline-server.git
synced 2026-10-25 14:00:56 +00:00
07ff4524b5
* Add a new section for the 'Create your Server' directions * Adjust step numbers depending on which cloud provider is selected. * Add GCP account creation instructions Screenshots and i18n will wait until the instructions themselves have been reviewed and finalized. * Add directions for creating a new VM isntance. There is still no recommendation for machine type, and i18n won't be finished until the directions are reviewed and approved by the team * Specify f1-micro machine type Looking at Prometheus for some large servers showed that we never get above a few hundred megabytes in memory usage and don't go anywhere near the 10 GB of disk space's worth of virtual memory + persistence. * Re-order instructions to create the firewall rule before the VM This way there is no separate assignment step * Format with Prettier * Respond to code review Most importantly, removes the recommendation of CoreOS to instead use the default Debian image. * Respond to review comments Use a CSS class to select the correct dropdowns to clear Rewrite a ternary statement * Consolidate the GCP-specific instructions in to a single dropdown * Internationalize new messages * Revert accidental message change * Removed unused messages * Use computed properties for the step numbers * Make the translation instructions consistent with that of pre-existing messages. * Replace placeholder assets * Respond to review comments * Remove a spurious comment * Use single quotes in messages |
||
|---|---|---|
| .. | ||
| cloud | ||
| electron_app | ||
| images | ||
| infrastructure | ||
| install_scripts | ||
| messages | ||
| model | ||
| types | ||
| ui_components | ||
| web_app | ||
| .prettierignore | ||
| bower.json | ||
| index.html | ||
| package.json | ||
| README.md | ||
| test_action.sh | ||
Outline Manager
Running
To run the Outline Manager:
yarn do server_manager/electron_app/run
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.