opencultureconsulting
/
simple-oai-pmh
mirror of https://github.com/opencultureconsulting/simple-oai-pmh.git
2
0
Fork 0
Code Issues Releases Activity

Update documentation

This commit is contained in:
Sebastian Meyer 2020-01-24 01:15:04 +01:00
parent f07a71e7ea
commit f5af7eff80
2 changed files with 8 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Configuration/Main.php
View File

@ -59,7 +59,9 @@ $config = [
// Directory containing the records
//
// Make sure the given path is readable and there is a subdirectory for every
// 'metadataPrefix' you specified above.
// 'metadataPrefix' you specified above. Although the given example points to
// a directory inside the document root it is highly recommended to place the
// data directory somewhere else. This will make upgrading so much easier!
'dataDirectory' => './Data/',
// Maximum number of records to return before giving a resumption token

10
README.md
View File

@ -10,7 +10,7 @@ A demo installation can be found [here](https://demo.opencultureconsulting.com/o
## Installation
1. Deploy all the files to a webserver.
1. Run `composer create-project opencultureconsulting/oai_pmh <path>`.
2. Edit `Configuration/Main.php` and adjust the settings according to your preferences.
@ -22,13 +22,13 @@ A demo installation can be found [here](https://demo.opencultureconsulting.com/o
## Upgrading
1. Backup all data (especially `Configuration/Main.php`)!
1. Backup `Configuration/Main.php` and your data directory!
2. Replace all files except your data directory with the new release.
2. Delete everything and re-install by running `composer create-project opencultureconsulting/oai_pmh <path>`.
3. Move your configuration back into `Configuration/Main.php`.
3. Move your configuration back into `Configuration/Main.php` and restore your data directory.
4. Congratulations! Now you are running a new version of the Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser.
4. Congratulations! Now you are running the newest version of the Simple OAI-PMH 2.0 Data Provider. You can access the entry point by calling `index.php?verb=Identify` in your browser.
## Updating