sbgrid-cli-admin.md
... ...
@@ -1,4 +1,9 @@
1
-## SBGrid installation manager admin mode
1
+## SBGrid recommended installation
2
+
3
+One of the primary benefits of an SBGrid software installation is that it is a managed software stack. New titles are added, obsolete versions are removed, and updates happen automatically.
4
+New software and bug fixes are an email away (bugs@sbgrid.org) without requiring local administrators or system admistration expertise. While there are other modes available (GUI, granular versions, titles, etc), this is the recommended mode of installation for most sites.
5
+
6
+### SBGrid installation manager admin mode
2 7
3 8
sbgrid-cli admin mode replaces the sbgrid-admin script installation method used previously to install and automatically update SBGrid installations. `sbgrid-cli admin` offers a some advantages:
4 9
- parallel updates for fast, more efficient transfers
... ...
@@ -11,6 +16,8 @@ The `sbgrid-cli admin` command will:
11 16
- Update existing versions when newer versions are added to SBGrid
12 17
- Remove obsolete verisons that are no longer supported
13 18
19
+An SBGrid installation manager account is required. [Please register here for an account https://sbgrid.org/registration/register/](https://sbgrid.org/registration/register/).
20
+Accounts are available for lab members and IT support staff.
14 21
## Installation Steps:
15 22
16 23
1. Create an 'sbgrid' user on the machine that will host your software installation.
... ...
@@ -21,12 +28,14 @@ adduser sbgrid
21 28
```
22 29
23 30
`sbgrid-cli` will attempt to use sudo to create the install path and symlink at `/programs` that is required to run the software.
24
-The sudo requirement can be skipped with the `--target` and `--no-link flags` (details below). If you would prefer the sbgrid-cli create `/programs` and the installation path, add the sbgrid user to sudo with this command:
31
+The sudo requirement can be skipped with the `--target` and `--no-link flags` ([detailed here](https://sbgrid.org//wiki/sbgrid-cli#activation)).
32
+If you would prefer the sbgrid-cli create `/programs` and the installation path, add the sbgrid user to sudo with this command:
25 33
26 34
```
27 35
echo 'sbgrid ALL=(ALL) ALL' > /etc/sudoers.d/sbgrid
28 36
```
29
-This is only required for activation and can be removed anytime after the installation is activated.
37
+
38
+This is only required for the activation step. '/etc/sudoers.d/sbgrid' can be removed anytime after the installation is activated.
30 39
31 40
2. Log in as this 'sbgrid' user
32 41
... ...
@@ -39,17 +48,17 @@ su sbgrid
39 48
40 49
For Linux:
41 50
```
42
-curl -LO https://sbgrid-installation-manager.s3.amazonaws.com/2.2.29/sbgrid-cli_2.2.29-linux.tar.gz
51
+curl -LO https://sbgrid-installation-manager.s3.amazonaws.com/2.4.0/sbgrid-cli_2.4.0-linux.tar.gz
43 52
```
44 53
For Mac:
45 54
```
46
-curl -LO https://sbgrid-installation-manager.s3.amazonaws.com/2.2.29/sbgrid-cli_2.2.29-macos.tar.gz
55
+curl -LO https://sbgrid-installation-manager.s3.amazonaws.com/2.4.0/sbgrid-cli_2.4.0-macos.tar.gz
47 56
```
48 57
49 58
4. Untar the archive and make it executable by running 'chmod +x sbgrid-cli'
50 59
51 60
```
52
-tar -zxvf sbgrid-cli_2.2.29-linux.tar.gz && chmod +x sbgrid-cli
61
+tar -zxvf sbgrid-cli_2.4.0-linux.tar.gz && chmod +x sbgrid-cli
53 62
```
54 63
55 64
5. Activate the installation
... ...
@@ -94,12 +103,12 @@ Post-Install Steps:
94 103
95 104
### Examples :
96 105
97
-To install all default versions of all titles, add new, update existing, remove obsolete, run :
106
+To install all default versions of all titles, add new titles when available, update all installed when available and remove obsolete versions, run :
98 107
```
99 108
$ sbgrid-cli admin
100 109
```
101 110
102
-To do the same for all versions of all titles :
111
+To do the same but to include all versions of all titles :
103 112
```
104 113
$ sbgrid-cli admin --all-versions
105 114
```