Skip to content

Commit

Permalink
Prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
asmecher committed Jul 21, 2020
1 parent bbe003c commit c55938f
Showing 1 changed file with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions README
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
================================================================
=== OJS Private LOCKSS Network Plugin
=== PKP Preservation Network Plugin for OJS
=== Version: (see version.xml)
=== Author: Chris MacDonald <[email protected]>
=== Author: Michael Joyce <[email protected]>
Expand All @@ -8,10 +8,10 @@

About
-----
This plugin provides a means for OJS to preserve content on a private LOCKSS
network. The plugin checks for new and modified content and provided the PLN's
terms of use are met, will communicate with the PLN's staging server to preserve
your published content automatically.
This plugin provides a means for OJS to preserve content in the PKP
Preservation Network (PKP|PN). The plugin checks for new and modified content
and provided the PN's terms of use are met, will communicate with the PN's
staging server to preserve your published content automatically.

License
-------
Expand All @@ -20,21 +20,21 @@ file LICENSE for the complete terms of this license.

System Requirements
-------------------
OJS 3.2.0 or greater.
CURL support for PHP.
ZipArchive support for PHP.
- OJS 3.2.1-x.
- CURL support for PHP.
- ZipArchive support for PHP.

Note
----
The primary difference between this plugin and the existing LOCKSS preservation
mechanism present in OJS is the PLN requires no registration or involvement with
mechanism present in OJS is the PN requires no registration or involvement with
the network - as long as you agree with the network's terms of use, you can
preserve your journal's content.

Contact/Support
---------------
Please use the PKP support forum (http://forum.pkp.sfu.ca/), PKP issue
tracker (https://github.com/pkp/pkp-lib#issues) or email the authors for
tracker (https://github.com/pkp/pkp-lib/issues) or email the authors for
support, bugfixes, or comments.

Setting a default
Expand Down Expand Up @@ -87,9 +87,24 @@ installed before installing the plugin.

Other useful hints / Troubleshooting hints
------------------------------------------------
- The pln plugin depends on 2 database tables, namely the 'pln_deposits' and 'pln_deposit_objects' tables. If those tables are not in your database, you may not have installed the plugin properly.
- The 'plugins.generic.pln.classes.tasks.Depositor' task must be inside the 'scheduled_tasks' database table. If not, try 'Reload Scheduled Tasks' from the Plugins gallery area, under the Acron plugin.
- Search the plugin's logs in the 'scheduledTaskLogs' folder within the OJS files directory. Files named 'PKPPLNDepositorTask-*id*-*datestamp*' should be found there.
- In the scheduled task log files, if an entry like '[*date time*] [Notice] Task process stopped.' is found, then the process seems to have exited as it should. Otherwise please check the PHP logs for more info/errors.
- If an issue fails to be packaged, it may be useful to try and export the issue from the native import/export plugin. Possible export problems may cause the PLN Plugin to fail to send the failed content, and the native import/export plugin may display some hints on why the failure occured.
- The pln plugin depends on 2 database tables, namely the 'pln_deposits' and
'pln_deposit_objects' tables. If those tables are not in your database, you
may not have installed the plugin properly.

- The 'plugins.generic.pln.classes.tasks.Depositor' task must be inside the
'scheduled_tasks' database table. If not, try 'Reload Scheduled Tasks' from
the Plugins gallery area, under the Acron plugin.

- Search the plugin's logs in the 'scheduledTaskLogs' folder within the OJS
files directory. Files named 'PKPPLNDepositorTask-*id*-*datestamp*' should
be found there.

- In the scheduled task log files, if an entry like '[*date time*] [Notice] Task
process stopped.' is found, then the process seems to have exited as it
should. Otherwise please check the PHP logs for more info/errors.

- If an issue fails to be packaged, it may be useful to try and export the issue
from the native import/export plugin. Possible export problems may cause the
PLN Plugin to fail to send the failed content, and the native import/export
plugin may display some hints on why the failure occured.

0 comments on commit c55938f

Please sign in to comment.