laptopinstall.md
... ...
@@ -1,83 +1,36 @@
1
-## Copying the Software Installation
1
+## SBGrid Software Installation : Laptops and Desktops without shared network storage
2 2
3
-If you run a machine that is frequently disconnected from the network, like a laptop, or don't want to set up an NFS-shared software installation, it is possible to install the software to the hard disk on your local machine.
3
+If you would like to install SBGrid tools on a machine that is frequently disconnected from the network, like a laptop, or don't want to set up an NFS-shared software installation, it is possible to install the software to the hard disk on your local machine.
4 4
5
-There are two scripts in the programs tree that can be used to create a copy of the software on your local hard disk. The ''sbgrid-laptop'' script allows you to select individual applications from the software distribution for installation on your laptop. By default only the latest version of the selected applications will be installed. The ''localsync'' script allows you to copy an entire operating system software branch to your local machine. This script can be used on laptops, but each branch is quite large in terms of disk space usage.
5
+We have a GUI-based installation client for MacOS that allows software to be selected, installed, and updated on demand from SBGrid servers. There is also a command-line client for MacOS and Linux that will allow installation and upgrade of individual titles from the command line.
6 6
7
-### Laptop installation
7
+ - [Information on installation of our MacOS GUI.](client_install)
8 8
9
-We have two options for installation of selected applications from the SBGrid software tree.
9
+ - [Information on installation of our command-line tools for MacOS and Linux](client_CLI_install).
10 10
11
- * *sbgrid-sync*
12
- - This script installs software from SBGrid's servers.
13
- - an account on SBGrid's server is required. To request one, email accounts@sbgrid.org.
11
+### Script-based installation tools
12
+
13
+While we recommend the software tools above, if you would like to install your software from a local source, there are script-based tools in the SBGrid programs tree that will create a copy of the software on your local hard disk.
14
+
15
+The 'sbgrid-laptop' script allows you to select individual applications from the software distribution for installation on your laptop. By default only the latest version of the selected applications will be installed. The 'localsync' script allows you to copy an entire operating system software branch to your local machine. This script can be used on laptops, but each branch is quite large in terms of disk space usage. Finally, the 'sbgrid-sync' script will allow you to install software from SBGrid servers. This script is deprecated in favor of the better CLI tools above and its use is discouraged.
14 16
15 17
16 18
* *laptop-sync*
17 19
- This script installs software from your own **local** installation.
18 20
- This script requires an account on a local machine with access to the SBGrid softare collection.
21
+ - Only latest versions will be installed.
19 22
20
-### sbgrid-sync
21
-
22
-This script can be found in the programs installation at */programs/share/bin/sbgrid-sync*.
23
-
24
-```
25
-sbgrid-sync: install or update the SBGrid Consortium software
26
- collection on your laptop or workstation.
27
-
28
-You will need a Consortium UNIX account to install and update your
29
-installation. If you don't have an account or don't remember your password,
30
-please email <accounts@sbgrid.org> for assistance.
31
-
32
-This script will create an SSH key and run an SSH agent process to handle
33
-authentication for the file transfers. Unless otherwise configured only the
34
-default version of the software titles will be installed.
35
-
36
-Usage: sbgrid-sync [-iesudt]
37
-
38
-Install/Configure Options:
39
-
40
- -i Initial set up and installation of the SBGrid software.
41
- -e Edit the software download list.
42
-
43
-Update Options:
44
-
45
- -u Update an existing installation using the current
46
- configuration.
47
-
48
-Troubleshooting Options:
49
-
50
- -d Debug mode creates a log file for troubleshooting purposes.
51
- -t Test your current configuration.
52
-
53
-```
54
-
55
-Once an account has be created at SBGrid, the software can be installed with for a username (at SBGrid) and a path for the software installation. the -i flag. The user will be prompted with a list of software to add.
56
-
57
-![sync software list ](images/sbgrid-sync_software_list.png "sbgrid-sync software list")
58
-
59
-```
60
-| We need to create a list of software you want included in the local
61
-| installation. We will start with a list of all the software titles.
62
-| Remove the leading hash mark (#) to _include_ a software title.
63
-```
64
-Any titles NOT preceded with a '#' character will be installed.
65
-```
66
-| Save and _QUIT_ the text editor after making your changes. If you are
67
-| using TextEdit on a Mac, you must completely quit (Apple-Q) the
68
-| application to continue.
69
-```
70
-Once the editor has quit, software installation will start.
71 23
72
-```
73
-| Creating an rsync include list to download files.
74
-| Running rsync to download the latest software.
75
-```
76
-Once installation is completed, open a new terminal and
24
+ * *localsync*
25
+ - This script installs software from your own **local** installation.
26
+ - This script requires an account on a local machine with access to the SBGrid softare collection.
27
+ - All versions of the software will be installed.
77 28
78
- source /programs/sbgrid.shrc
79 29
80
-to get started.
30
+ * *sbgrid-sync (deprecated)*
31
+ - This script installs software from SBGrid's servers.
32
+ - an account on SBGrid's server is required.
33
+ - THIS INSTALL METHOD WILL NO LONGER BE SUPPORTED IN A FUTURE RELEASE.
81 34
82 35
83 36
### laptop-sync
... ...
@@ -104,10 +57,10 @@ You can create a customized local installation of the software using the ''sbgri
104 57
to use this script. The script will create an SSH key and run an SSH
105 58
agent process to handle authentication for the file transfers.
106 59
107
-
108 60
Copy the script the machine you want to install the software on, and then run it in install mode: ''./sbgrid-laptop -i''. Follow the prompts on the screen to create your configuration file, your software installation list and to enable logins using an SSH key for authentication.
109 61
110
-### Sync Script
62
+
63
+### localsync Sync Script
111 64
There is a script in the programs tree that can be used to copy the appropriate branch from a shared installation to your laptop or workstation.
112 65
113 66
Copy /programs/share/bin/localsync from the machine that has the software to your home directory on the standalone machine:
... ...
@@ -140,7 +93,7 @@ This will copy the entire branch for your architecture to your local hard drive.
140 93
141 94
You should use a network cable for the initial download, since the download is fairly large. Subsequent runs of the 'localsync' script are differential; they will only copy new or changed files, so they can be run over a wireless connection. The script can be run at any time to make your local installation match the installation on your local server.
142 95
143
-# Sharing a Software Installation without NFS
96
+### Sharing a 'localsync' Software Installation without NFS
144 97
145 98
While we recommend that sites export their software installation via NFS to their workstations, it is possible to use rsync to copy the master installation to each workstation. This method has the drawback that it requires manual intervention on the part of the local sysadmin, and updates will not be instantaneous or simultaneous for all machines.
146 99
... ...
@@ -230,5 +183,67 @@ bash
230 183
231 184
crontab -l
232 185
233
-
234 186
You're done!
187
+
188
+
189
+### sbgrid-sync (DEPRECATED)
190
+
191
+This script can be found in the programs installation at */programs/share/bin/sbgrid-sync*.
192
+
193
+```
194
+sbgrid-sync: install or update the SBGrid Consortium software
195
+ collection on your laptop or workstation.
196
+
197
+You will need a Consortium UNIX account to install and update your
198
+installation. If you don't have an account or don't remember your password,
199
+please email <accounts@sbgrid.org> for assistance.
200
+
201
+This script will create an SSH key and run an SSH agent process to handle
202
+authentication for the file transfers. Unless otherwise configured only the
203
+default version of the software titles will be installed.
204
+
205
+Usage: sbgrid-sync [-iesudt]
206
+
207
+Install/Configure Options:
208
+
209
+ -i Initial set up and installation of the SBGrid software.
210
+ -e Edit the software download list.
211
+
212
+Update Options:
213
+
214
+ -u Update an existing installation using the current
215
+ configuration.
216
+
217
+Troubleshooting Options:
218
+
219
+ -d Debug mode creates a log file for troubleshooting purposes.
220
+ -t Test your current configuration.
221
+
222
+```
223
+
224
+Once an account has be created at SBGrid, the software can be installed with for a username (at SBGrid) and a path for the software installation. the -i flag. The user will be prompted with a list of software to add.
225
+
226
+![sync software list ](images/sbgrid-sync_software_list.png "sbgrid-sync software list")
227
+
228
+```
229
+| We need to create a list of software you want included in the local
230
+| installation. We will start with a list of all the software titles.
231
+| Remove the leading hash mark (#) to _include_ a software title.
232
+```
233
+Any titles NOT preceded with a '#' character will be installed.
234
+```
235
+| Save and _QUIT_ the text editor after making your changes. If you are
236
+| using TextEdit on a Mac, you must completely quit (Apple-Q) the
237
+| application to continue.
238
+```
239
+Once the editor has quit, software installation will start.
240
+
241
+```
242
+| Creating an rsync include list to download files.
243
+| Running rsync to download the latest software.
244
+```
245
+Once installation is completed, open a new terminal and
246
+
247
+ source /programs/sbgrid.shrc
248
+
249
+to get started.