catalina.md
... ...
@@ -0,0 +1,169 @@
1
+# Using SBGrid with MacOS 10.15 'Catalina'
2
+SBGrid works with MacOS Catalina but the installation process requires a work-around to handle new filesystem controls.
3
+These controls impact the 'activation' process of our installation client and also the ability to install the software.
4
+Once the activation process is completed following the procedure below, the client can be used normally. The SBGrid software is then functional, though [32-bit applications](https://docs.google.com/spreadsheets/d/e/2PACX-1vSZEEdZhYIdRq0BoY-Aq8XFO1QSR6idkO72N2UeACWSG8-84gLlPqE_v9NrFO9na66gZ3_6PCSDUXGI/pubhtml?gid=1974952972&single=true) are not supported on 10.15 Catalina.
5
+
6
+Note that macOS now uses the z-shell (zsh) by default.
7
+This shell is also supported in SBGrid using the standard sbgrid.shrc file.
8
+
9
+## Installation : the easy way with the latest command line client, sbgrid-cli.
10
+Activation with our latest command-line install client is possible in 3 steps, but a reboot is required to add the '/programs' path.
11
+
12
+### 1. Download the client, sbgrid-cli :
13
+First, download the latest install client from here
14
+
15
+[sbgrid-cli version 2.0.43](downloads/sbgrid-cli_2.0.43_macOS.tar.gz)
16
+
17
+You can use *curl* to download the tarball directly in your terminal.
18
+This approach has the added benefit of not triggering the macOS "unidentified developer" Gatekeeper response which requires the *xattr* step below.
19
+```
20
+curl -LO https://sbgrid.org/wiki/downloads/sbgrid-cli_2.0.43_macOS.tar.gz
21
+```
22
+
23
+
24
+Untar and run the application to test.
25
+Untar :
26
+```
27
+tar -zxf sbgrid-cli_2.0.43_macOS.tar.gz
28
+```
29
+
30
+then run :
31
+
32
+```
33
+cd sbgrid-cli
34
+
35
+./sbgrid-cli
36
+```
37
+
38
+You should see the application usage info.
39
+
40
+If you see a pop-up warning about "unidentified developer", you may need to strip apple's quartine extended attribute.
41
+Cancel the dialog and then run this in your terminal:
42
+```
43
+xattr -d com.apple.quarantine sbgrid-cli
44
+```
45
+
46
+You should then be able to run the application normally.
47
+
48
+### 2. Activate your installation :
49
+To activate, use the credentials provided by email after [https://sbgrid.org/registration/register/](registration).
50
+```
51
+./sbgrid-cli activate <your site> <your username> <your key>
52
+```
53
+
54
+### 3. Create link at /programs :
55
+The lastest MacOS provides the option to create links in the root partion via the */etc/synthetic.conf* file.
56
+This file has the following format:
57
+```
58
+#link target
59
+/programs /opt/sbgrid
60
+```
61
+
62
+Note that the whitespace MUST be a tab character. Spaces will not work.
63
+Here is a file for reference : [synthetic.conf](downloads/synthetic.conf).
64
+Thanks to Ron Rock at University of Chicago for pointing this out.
65
+
66
+### 4. Reboot
67
+
68
+You should then see this in your root partition (/) :
69
+
70
+```
71
+key@key-mbp2:~/ $ ls -l /
72
+total 9
73
+drwxrwxr-x+ 37 root admin 1184 Apr 19 00:56 Applications
74
+drwxr-xr-x 68 root wheel 2176 Apr 11 21:25 Library
75
+drwxr-xr-x@ 8 root wheel 256 Apr 6 15:46 System
76
+drwxr-xr-x 7 root admin 224 Apr 6 15:45 Users
77
+drwxr-xr-x 3 root wheel 96 Apr 18 11:13 Volumes
78
+drwxr-xr-x@ 38 root wheel 1216 Apr 6 15:52 bin
79
+drwxr-xr-x 2 root wheel 64 Feb 29 01:11 cores
80
+dr-xr-xr-x 3 root wheel 4544 Apr 12 17:27 dev
81
+lrwxr-xr-x@ 1 root admin 11 Apr 11 12:31 etc -> private/etc
82
+lrwxr-xr-x 1 root wheel 25 Apr 12 17:27 home -> /System/Volumes/Data/home
83
+drwxr-xr-x 5 root wheel 160 Apr 20 13:35 opt
84
+drwxr-xr-x 6 root wheel 192 Apr 11 12:40 private
85
+lrwxr-xr-x 1 root wheel 11 Apr 12 17:27 programs -> /opt/sbgrid
86
+drwxr-xr-x@ 63 root wheel 2016 Apr 11 12:38 sbin
87
+lrwxr-xr-x@ 1 root admin 11 Apr 11 12:38 tmp -> private/tmp
88
+drwxr-xr-x@ 11 root wheel 352 Apr 11 12:38 usr
89
+lrwxr-xr-x@ 1 root admin 11 Apr 11 12:38 var -> private/var
90
+```
91
+
92
+From there, you can continue to install software with the installation client, or use the [https://sbgrid.org/wiki/client_install](GUI).
93
+They are not mutually exclusive.
94
+
95
+## Method 2, SBGrid graphical client, the not-so-easy way to activate. Requires 3 reboots.
96
+Activation with our graphical client is not compatible with MacOS 10.15 "Catalina" without temporarily disabling System Integrity Protection (SIP)
97
+While the approach above is easier and recommended, it is possible to activate with the GUI by following the process below.
98
+
99
+To create the /programs symlink in Catalina without using the /etc/synthetic.conf file, the system filesystem must be remounted as read/write.
100
+To do that in Catalina, system integrity protection (SIP) must be disabled.
101
+
102
+### 1. Disable SIP from Recovery mode
103
+- Restart your Mac.
104
+- Before macOS starts up, hold down Command-R and keep it held down until you see an Apple icon and a progress bar. Release. This boots you into Recovery.
105
+- From the Utilities menu, select Terminal.
106
+- At the prompt run the following and then press Return:
107
+
108
+```
109
+csrutil disable
110
+```
111
+
112
+- Terminal should display a message that SIP was disabled.
113
+- From the  menu, select Restart.
114
+
115
+### 2. Remount root filesystem as read/write to create /programs
116
+ To remount the disk as read/write, run :
117
+
118
+```
119
+sudo mount -uw /
120
+```
121
+
122
+To create the SBGrid /programs link, run :
123
+
124
+```
125
+sudo ln -s /opt/sbgrid /programs
126
+```
127
+
128
+To install the software, you can use the install client normally. It will create the required paths and install the software. After the initial installation, you can use the install client as in previous MacOS releases, even after the steps below.
129
+
130
+### 3. Re-enable SIP (optional)
131
+- Restart your Mac.
132
+- Before macOS starts up, hold down Command-R and keep it held down until you see an Apple icon and a progress bar. Release. This boots you into Recovery.
133
+- From the Utilities menu, select Terminal.
134
+- At the prompt, re-enbale SIP with :
135
+
136
+```
137
+csrutil enable
138
+```
139
+
140
+- Terminal should display a message that SIP was enabled.
141
+- From the  menu, select Restart.
142
+
143
+## How to stop nagging macOS update alerts
144
+It is possible to turn off the nagging pop ups.
145
+
146
+- Open System Preferences.
147
+- Click on Software Update.
148
+- Deselect Automatically keep my Mac up to date
149
+
150
+## How to ignore macOS Catalina update on your mac
151
+```
152
+ $ sudo softwareupdate --ignore "macOS Catalina"
153
+
154
+```
155
+
156
+You will see :
157
+
158
+```
159
+Ignored updates:
160
+(
161
+ "macOS Catalina"
162
+)
163
+```
164
+
165
+You can reverse this later by running :
166
+
167
+```
168
+sudo softwareupdate --reset-ignored
169
+```