if/SymphonyElectron
1
0
Fork 0
mirror of https://github.com/finos/SymphonyElectron.git synced 2025-02-25 18:55:29 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: SDA-2702: generate install instructions pdf for macOS (#1148)

Browse Source 
* SDA-2702: generate install instructions

- Generate installation instructions for macOS builds

* SDA-2702: generate install instructions

- Generate installation instructions for macOS builds

* SDA-2702: fix build script issue

* SDA-2702: fix path and update documentation

* SDA-2702: unify documentation

* SDA-2702: create targets directory
This commit is contained in:
Vishwas Shashidhar
2020-12-14 19:15:37 +05:30
committed by GitHub
parent c547175d42
commit 538f2e92a0
3 changed files with 211 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

127
docs/features/silent-installation-macos.md
View File

@@ -1,73 +1,77 @@
# Intro
Electron supports silent installation on macOS using the standard "installer" command from the terminal
# Platforms Supported
macOS
SDA supports silent installation on macOS using the standard "installer" command from the terminal
# Purpose
To help admins push installation to their users' systems silently using "installer" command.
To help admins push installation to their users' systems silently using the "installer" command.
# Details
The Symphony Desktop Application can be automatically installed from the terminal. The process of customising the settings that appear in the installer is described below.
We have 2 distinct files that take user settings and permissions settings. These 2 files have to be created as "/tmp/sym_settings.txt" and "/tmp/sym_permissions.txt" respectively for the user settings and permissions settings.
SDA can be automatically installed from the terminal. The process of customizing the settings that appear in the installer is described below.
Both are plain text files containing values of corresponding settings that'll be read by a post-install script in the installer. So, both have to be set up cleanly in order to avoid installation issues.
- We have 2 distinct files that take user settings and permissions settings.
- These 2 files have to be created as "/tmp/sym_settings.txt" and "/tmp/sym_permissions.txt" respectively for the user settings and permissions settings.
- Both are plain text files containing values of corresponding settings that'll be read by a `post-install script` in the installer.
- So, both have to be set up correctly in order to avoid installation issues.
sym_settings.txt
The parameters that should be configured in "sym_settings.txt" are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
```
Pod Url
Minimize On Close
Launch On Startup
Always on Top
Bring to Front
Dev Tools Enabled
```
## sym_settings.txt
Below is a sample "sym_settings.txt" file.
The parameters that should be configured in `sym_settings.txt` are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
- Pod Url
- Minimize On Close
- Launch On Startup
- Always on Top
- Bring to Front
- Dev Tools Enabled
You can find a sample below:
```
https://corporate.symphony.com/login/sso/initsso
true
true
false
false
true
ENABLED
ENABLED
DISABLED
DISABLED
ENABLED
```
sym_permissions.txt
The parameters that should be configured in "sym_permissions.txt" are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
## sym_permissions.txt
The parameters that should be configured in `sym_permissions.txt` are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
- Media
- GeoLocation
- Notifications
- Midi Sysex
- Pointer Lock
- Full Screen
- Open External App
You can find a sample below:
```
Media
GeoLocation
Notifications
Midi Sysex
Pointer Lock
Full Screen
Open External App
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
```
Attached below is a sample "sym_permissions.txt" file
```
true
true
true
true
true
true
true
```
# Installation
## Installation Command
To install the package, use the below command with appropriate changes to the path where the app gets installed. It should ideally be in the "/" (root) volume.
```sudo installer -store -pkg /Users/johndoe/Downloads/SDA.pkg -target /```
Note: Since we are installing the package in the root volume, you need to run the above command as "sudo".
**Note:** Since we are installing the package in the root volume, you need to run the above command as `sudo`.
## Fully Packaged Script
We've also provisioned a shell script that can be used to cut out all of the above manual processes. You'll just need to edit the script to set appropriate values (for which we've added comments in the script) for the parameters which are self-explanatory. Attached below is the script.
# Fully Packaged Script
We've also provisioned a shell script that can be used to cut out all of the above manual processes. You'll just need to edit the script to set appropriate values (for which we've added comments in the script) for the parameters which are self-explanatory.
You can find the script below. Ensure that you copy the below content to a shell script and provide executable permissions.
```
#!/usr/bin/env bash
@@ -79,13 +83,13 @@ package_path=/Users/johndoe/Downloads/SDA.pkg
settings_temp_file="/tmp/sym_settings.txt"
## Set the POD URL and other user related settings.
## Note, all the user related settings should be either "true" or "false"
## Note, all the user related settings should be either "ENABLED", "DISABLED" or "NOT_SET"
pod_url="https://corporate.symphony.com/login/sso/initsso"
minimize_on_close="true"
launch_on_startup="true"
always_on_top="false"
bring_to_front="false"
dev_tools_enabled="true"
minimize_on_close="ENABLED"
launch_on_startup="ENABLED"
always_on_top="DISABLED"
bring_to_front="DISABLED"
dev_tools_enabled="ENABLED"
## DO NOT CHANGE THIS
sudo echo ${pod_url} > ${settings_temp_file}
@@ -98,14 +102,14 @@ sudo echo ${dev_tools_enabled} >> ${settings_temp_file}
## DO NOT CHANGE THIS
permissions_temp_file="/tmp/sym_permissions.txt"
## Set the permissions. By default, it should be true for all unless you know what you are doing
media="true"
geo_location="true"
notifications="true"
midi_sysex="true"
pointer_lock="true"
full_screen="true"
open_external_app="true"
## Set the permissions. By default, it should be "ENABLED" for all unless you know what you are doing
media="ENABLED"
geo_location="ENABLED"
notifications="ENABLED"
midi_sysex="ENABLED"
pointer_lock="ENABLED"
full_screen="ENABLED"
open_external_app="ENABLED"
## DO NOT CHANGE THIS
sudo echo ${media} > ${permissions_temp_file}
@@ -122,6 +126,3 @@ rm -rf ${settings_temp_file}
rm -rf ${permissions_temp_file}
```
# Other Info
N/A

128
installer/mac/install_instructions_mac.md Normal file
View File

@@ -0,0 +1,128 @@
# Intro
SDA supports silent installation on macOS using the standard "installer" command from the terminal
# Purpose
To help admins push installation to their users' systems silently using the "installer" command.
# Details
SDA can be automatically installed from the terminal. The process of customizing the settings that appear in the installer is described below.
- We have 2 distinct files that take user settings and permissions settings.
- These 2 files have to be created as "/tmp/sym_settings.txt" and "/tmp/sym_permissions.txt" respectively for the user settings and permissions settings.
- Both are plain text files containing values of corresponding settings that'll be read by a `post-install script` in the installer.
- So, both have to be set up correctly in order to avoid installation issues.
## sym_settings.txt
The parameters that should be configured in `sym_settings.txt` are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
- Pod Url
- Minimize On Close
- Launch On Startup
- Always on Top
- Bring to Front
- Dev Tools Enabled
You can find a sample below:
```
https://corporate.symphony.com/login/sso/initsso
ENABLED
ENABLED
DISABLED
DISABLED
ENABLED
```
## sym_permissions.txt
The parameters that should be configured in `sym_permissions.txt` are listed below. They need to be in the same order as they'll be picked up by the installer in the same order. Do not skip any parameters.
- Media
- GeoLocation
- Notifications
- Midi Sysex
- Pointer Lock
- Full Screen
- Open External App
You can find a sample below:
```
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
ENABLED
```
# Installation
To install the package, use the below command with appropriate changes to the path where the app gets installed. It should ideally be in the "/" (root) volume.
```sudo installer -store -pkg /Users/johndoe/Downloads/SDA.pkg -target /```
**Note:** Since we are installing the package in the root volume, you need to run the above command as `sudo`.
# Fully Packaged Script
We've also provisioned a shell script that can be used to cut out all of the above manual processes. You'll just need to edit the script to set appropriate values (for which we've added comments in the script) for the parameters which are self-explanatory.
You can find the script below. Ensure that you copy the below content to a shell script and provide executable permissions.
```
#!/usr/bin/env bash
## Set the path where the package file exists
package_path=/Users/johndoe/Downloads/SDA.pkg
## DO NOT CHANGE THIS
settings_temp_file="/tmp/sym_settings.txt"
## Set the POD URL and other user related settings.
## Note, all the user related settings should be either "ENABLED", "DISABLED" or "NOT_SET"
pod_url="https://corporate.symphony.com/login/sso/initsso"
minimize_on_close="ENABLED"
launch_on_startup="ENABLED"
always_on_top="DISABLED"
bring_to_front="DISABLED"
dev_tools_enabled="ENABLED"
## DO NOT CHANGE THIS
sudo echo ${pod_url} > ${settings_temp_file}
sudo echo ${minimize_on_close} >> ${settings_temp_file}
sudo echo ${launch_on_startup} >> ${settings_temp_file}
sudo echo ${always_on_top} >> ${settings_temp_file}
sudo echo ${bring_to_front} >> ${settings_temp_file}
sudo echo ${dev_tools_enabled} >> ${settings_temp_file}
## DO NOT CHANGE THIS
permissions_temp_file="/tmp/sym_permissions.txt"
## Set the permissions. By default, it should be "ENABLED" for all unless you know what you are doing
media="ENABLED"
geo_location="ENABLED"
notifications="ENABLED"
midi_sysex="ENABLED"
pointer_lock="ENABLED"
full_screen="ENABLED"
open_external_app="ENABLED"
## DO NOT CHANGE THIS
sudo echo ${media} > ${permissions_temp_file}
sudo echo ${geo_location} >> ${permissions_temp_file}
sudo echo ${notifications} >> ${permissions_temp_file}
sudo echo ${midi_sysex} >> ${permissions_temp_file}
sudo echo ${pointer_lock} >> ${permissions_temp_file}
sudo echo ${full_screen} >> ${permissions_temp_file}
sudo echo ${open_external_app} >> ${permissions_temp_file}
sudo installer -store -pkg ${package_path} -target /
rm -rf ${settings_temp_file}
rm -rf ${permissions_temp_file}
```

19
scripts/build-mac.sh
View File

@@ -115,3 +115,22 @@ npm run unpacked-mac
# Create .pkg installer
echo "Creating .pkg"
/usr/local/bin/packagesbuild -v installer/mac/symphony-mac-packager.pkgproj
if ! [ -x "$(command -v markdown-pdf)" ]; then
echo 'Markdown PDF does not exist! Installing it' >&2
npm install -g markdown-pdf
fi
ARCHIVE_NAME="${PKG_VERSION}_${PARENT_BUILD_VERSION}"
echo "Generating PDF for installation instructions"
markdown-pdf installer/mac/install_instructions_mac.md
# Create targets directory
mkdir -p targets
if [ "${EXPIRY_PERIOD}" != "0" ]; then
cp installer/mac/install_instructions_mac.pdf "targets/Install-Instructions-macOS-${PKG_VERSION}-${PARENT_BUILD_VERSION}-TTL-${EXPIRY_PERIOD}.pdf"
else
cp installer/mac/install_instructions_mac.pdf "targets/Install-Instructions-macOS-${PKG_VERSION}-${PARENT_BUILD_VERSION}.pdf"
fi