admin_overrides.md
... ...
@@ -1,4 +1,6 @@
1
-### Administrator Software Blacklist
1
+## Site Administrator Overrides
2
+
3
+### Software Blacklist
2 4
Site administrators can prevent the shell initialization files from configuring software on a host by creating an empty file at
3 5
4 6
**/programs/local/conf/disabled-hosts/<hostname>**
developers.md
... ...
@@ -1,4 +1,4 @@
1
-### SBGrid Developer Support Program
1
+## SBGrid Developer Support Program
2 2
In an effort to show our appreciation for their hard work and to encourage the continuing development and support of cutting edge structural biology software, SBGrid offers a Developer Support Program featuring a wide array of benefits for structural biology software developers.
3 3
4 4
### Developer Network
help.md
... ...
@@ -1,5 +1,4 @@
1 1
## Software Help
2
-### Getting Software Help
3 2
4 3
If you are having a problem with software included in the SBGrid suite or think you've discovered an application bug, please use the [SBGrid](http://sbgrid.org/bugs) to alert us to the problem. You can also email bugs@sbgrid.org with details on the problem, but the web form is the preferred method.
5 4
laptopinstall.md
... ...
@@ -4,7 +4,83 @@ If you run a machine that is frequently disconnected from the network, like a la
4 4
5 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.
6 6
7
-### Laptop Script
7
+### Laptop installation
8
+
9
+We have two options for installation of selected applications from the SBGrid software tree.
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.
14
+
15
+
16
+ * *laptop-sync*
17
+ - This script installs software from your own local installation.
18
+ - This script requires an account on a local machine with access to the SBGrid softare collection.
19
+
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 ](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
+
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
77
+
78
+ source /programs/sbgrid.shrc
79
+
80
+to get started.
81
+
82
+
83
+### laptop-sync
8 84
You can create a customized local installation of the software using the ''sbgrid-laptop'' script located at ''/programs/share/bin/sbgrid-laptop''. This script requires you to have an SSH login to a computer that has access to an SBGrid software installation and will let you specify which packages you want to install.
9 85
10 86
```