Skip to content
This repository has been archived by the owner on Mar 24, 2023. It is now read-only.

Latest commit

 

History

History
39 lines (21 loc) · 1.81 KB

File metadata and controls

39 lines (21 loc) · 1.81 KB

Journal Transporter - Plugin for Janeway 1.4

A plugin for the Janeway publishing platform that handles imports (and eventually maybe exports) from Journal Transporter.

Installation

Clone this repository into {JANEWAY_ROOT}/src/plugins on your Janeway server and rename the resulting directory to journal_transporter.

In the Janeway Django admin interface, go to Utils -> Plugins and click "Add Plugin". Name it journal_transporter, assign the current version number, and ensure that the "Enabled" and "Press wide" checkboxes are selected.

Restart your Janeway server.

Usage

This plugin adds API routes needed to interface with Journal Transporter.

Setting up the server in Journal Transporter

See the Journal Transporter documentation for instructions on connecting Journal Transporter to your Janeway instance. If you followed the installation instructions above, the server host will be:

{JANEWAY_URL}/plugins/journal-transporter/

Adjust as needed, if you provided the plugin a different name.

Viewing API data

You can also access the endpoints directly in a browser or REST client. In a browser, you must be logged into Janeway. In a REST client, provide credentials as basic auth.

License

This Janeway plugin is available under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE (Version 3, 19 November 2007).

See the LICENCE file for full details.

Contributing

Contributions to improve this plugin are welcome. Please see the contributing.md file for guidelines.