Museum Help - Repositories

Repositories

Museum supports multiple repositories. A repository is a set of documents with an associated set of users. The number of repositories is only limited by the capacity of your server machine and the number of documents indexed.

Multiple repositories allows you to customise the access of documents to specified users. (See the User Permissions section)

When you click the "Repositories" link in the administration menu, you are presented with a list of current repositories and also given an option to create a new one:

Creating a New Repository

Click the "Add New Repository" button shown above.

You are presented with a form to enter the new repository details:

Specify the URL on which the repository search page will be found.

Specify the description, this appears as the search page heading (top left of the search screen).

Specify the file path to an index directory and a document directory. A copy of each file indexed is stored in the document directory. The document directory can be a subdirectory of the index directory.

Specify the stemming language according to the language of documents to be stored in the repository. Stemming is the process of reducing words to their root form which is useful for 'imprecise' word matching. e.g. The words "computer", "computing", "computed" are all stemmed to "comput". The stemming language must be the same for all documents in the repository, so this must not change once documents have been submitted.

Edit Repository Settings

To change the settings for a repository, first select the "edit" link on one of the rows of the repository list.

Changes made to the url and description text will update through the system instantly.

The index directory is where Museum keeps all the data files necessary to perform a search for documents. The document directory is where Museum stores a copy of the documents indexed. When you click on a document in a search result, you view the document stored in the document directory.

Editing the index and document directory fields, results in the current repository closing (it does not get deleted) and a repository opening in those new directories. If the new index directory already contains an existing index, that index will be opened and resumed (ie it is not cleared out). If there is nothing in the directory, a new index will be created. If you are reopening an existing index, make sure the document directory matches the files indexed in the index directory.

Submitting Documents to a Repository From a Server Accessible File Path

Files can be added to the repository via the "Add files" link. Other ways to submit documents include via the Client Software or via email (POP3 email account monitoring).

When using the "Add files" link, you will be asked to enter a file path that can be accessed from the server. Museum will then recursively index all files at that path. Your web browser updates to show indexing progress.

Recreating a Repository In Case of Emergency

If the index directory is ever lost or corrupted due to some unforseen circumstance, it is always possible to recreate your index. This process simply re creates the index from scratch by re indexing all the documents in the document directory. Select "Recreate repository from document directory" to recreate your index.