|
| 1 | +# About DocDB |
| 2 | + |
| 3 | +DocDB is a powerful and flexible collaborative document server. It was originally developed for use by the BTeV collaboration |
| 4 | +at Fermilab and is now used by twenty or more other experiments, Fermilab divisions, organizations, national laboratories, |
| 5 | +and companies (a partial list). DocDB is well suited for managing and sharing documents (not just official publications) |
| 6 | +among groups of up to several hundred people. |
| 7 | + |
| 8 | +A DocDB installation consists of three parts: 1) a relational database which stores information about the documents, |
| 9 | +2) a file system hierarchy used for storing the documents themselves, |
| 10 | +and 3) a suite of CGI scripts which provide coherent access to both sets of information. |
| 11 | + |
| 12 | + * DocDB maintains a versioned list of documents in a MySQL database. Information maintained in the database includes, |
| 13 | +author(s), title, topic(s), events(s), creation on modification dates, revision number, abstract, keywords, document type, |
| 14 | +pointers to the actual document files, and access restriction information. |
| 15 | + * Access to DocDB is controlled by cgi scripts that run on your web server. |
| 16 | + * When a document is submitted to DocDB, the document is copied (from either local disk or an html address) to a directory located on the web server. Documents may be composed of many files. |
| 17 | + * Documents are copied to a central location so that they will not "disappear" when someone rearranges or deletes files. This also enables centralized backup. |
| 18 | + * Changes to a document result in a new version of the document. Old versions remain available, providing historical archiving. Different versions allow different access restrictions, so documents can be developed in private and then released. |
| 19 | + * DocDB contains an event and agenda management system which allows documents to be associated with meetings of all sizes. |
| 20 | + |
| 21 | +Please see BTeV-doc-140 for a somewhat outdated description of DocDB. |
| 22 | + |
| 23 | +DocDB is available under the terms of the GNU Public License (GPL), version 2. |
| 24 | + |
| 25 | +To obtain DocDB, please see the files section of our project management page for a zip file. |
| 26 | +For the very latest code, see the developers GitHub repository. Installation instructions are maintained at Fermilab. |
| 27 | + |
| 28 | +Send questions about installing DocDB to docdb-users@fnal.gov |
| 29 | +The docdb-users mailing list is archived at http://listserv.fnal.gov/archives/docdb-users.html. |
| 30 | + |
| 31 | +If you have questions about using a particular DocDB implementation, please send mail to the administrators of that |
| 32 | +implementation. You should find a link labeled Document Database Administrators at the bottom of every DocDB page. |
| 33 | + |
| 34 | + |
0 commit comments