Skip to content
Eric Vaandering edited this page Jan 2, 2018 · 2 revisions

Installing DocDB

These instructions assume that you have a working knowledge of unix and the apache web server.

    • DocDB is available under the terms of the GNU Public License

    • How DocDB works

      DocDB maintains a versioned list of documents in a MySQL database. Information maintained in the database includes, author(s), title, topic(s), document date, revision number, abstract, keywords, document type, pointers to the actual document files, and access restriction information.

      Access to DocDB is controlled by cgi scripts that run on your web server.

      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 several files.

      Please see BTeV-doc-140 for a complete description of DocDB.

    • identify resources

    • security considerations

    • install MySQL and start mysqld

    • get DocDB as a .zip file from the releases section of GitHub. We strongly recommend that you use the latest release. The head of the repository may be unstable and likely to cause disfunction. Other branches of the code are used only for development purposes.

    • create a MySQL DocDB database

    • customize DocDB

    • test DocDB

      At this point DocDB should be ready to test. We recommend maintaining a test database separate from the official database so that you can add dummy documents and test database options.

    • Common Problems

    • Migrating from one version to another is done using the migration scripts. The DocDB schema has not changed in years, so no further instructions are provided.

    • Send questions to docdb-users@fnal.gov