https://github.com/zotero/arkivo

https://github.com/zotero/arkivo

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/zotero/arkivo
• Owner: zotero
• Created: 2014-07-11T14:25:33.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2017-07-13T16:52:48.000Z (almost 9 years ago)
• Last Synced: 2024-11-10T10:42:04.650Z (over 1 year ago)
• Language: JavaScript
• Size: 323 KB
• Stars: 8
• Watchers: 7
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Arkivo

======

[![Build Status](https://travis-ci.org/inukshuk/arkivo.svg?branch=master)](https://travis-ci.org/inukshuk/arkivo)

[![Coverage Status](https://img.shields.io/coveralls/inukshuk/arkivo.svg)](https://coveralls.io/r/inukshuk/arkivo?branch=master)

Arkivo is a Zotero subscription service. Whenever your Zotero library or

collection changes, Arkivo will fetch those changes from Zotero and dispatch

them to any number of Arkivo plugins for further processing.

Requirements

------------

* Node.js (>= 0.12, ideally > 4.0)

* Redis

When using Arkivo with Node.js 0.12 you need enable the harmony flag

for generator support, or, alternatively, `npm install gnode` and Arkivo

will use it to transpile the generator code on the fly.

Quickstart

----------

Install `arkivo` using NPM:

    $ npm install arkivo

This will install the `arkivo` executable  locally or globally if

you use the `-g` switch; when installed globally, you can leave out

the `$(npm bin)` in the examples below, as the Arkivo executables

should be in your global path already.

    $ $(npm bin)/arkivo -h

    # Prints out the list of command-line options

    $ $(npm bin)/arkivo up

    # Starts the Arkivo service

    $ $(npm bin)/arkivo sync [subscriptions]

    # Manually triggers synchronization of given (or all) subscriptions

    $ $(npm bin)/arkivo --redis localhost:4242 up

    # Starts the Arkivo service using a different Redis connection

    $ $(npm bin)/arkivo-subscriptions -h

    # Prints out the list of subscription managemend

    # command-line options

    $ $(npm bin)/arkivo-subscriptions list

    # Prints out a list of all subscriptions

    $ $(npm bin)/arkivo-subscriptions --redis localhost:4242 list

    # Prints out a list of subscriptions using

    # a different Redis connection

To enable debug output you can set a filter for each component in the

`DEBUG` environment variable:

    $ DEBUG=arkivo:* arkivo up

    # Enables debug output of all Arkivo components

    $ DEBUG=arkivo:http arkivo up

    # Enables debug output of only the Arkivo HTTP component

    $ DEBUG=arkivo:*,zotero:* arkivo up

    # Enables debug output of all Arkivo and Zotero components

The available components for which debug output can be enabled individually

include: `controller`, `db`, `http`, `listener`, `q` `subscription`, and

`sync`. To see stack traces after errors, enable the `arkivo:trace` output.

By running `arkivo up` you start all Arkivo services, including

the web monitor and API at http://localhost:8888/api.

Configuration

-------------

Arkivo uses the Node module [config](https://github.com/lorenwest/node-config)

to load configuration files. You can use the environment variable `NODE_CONFIG`

to override the configuration directly, or set `NODE_CONFIG_DIR` to specify

from where Arkivo should load additional configuration files.

By default Arkivo will look for a `config` folder in your current working

directory, i.e., the directory where you started the Arkivo process; in your

config folder you can place configuration files for different Node environments.

To see which configuration options are available, consult the

[default configuration](https://github.com/inukshuk/arkivo/blob/master/config/default.json).

Plugins

-------

Each Arkivo subscription defines a list of plugins to which all synchronized

data from Zotero will be passed. The list of available plugins is managed

via the `arkivo.plugins` configuration option.

For plugins installed via NPM, simply add the plugin's package name to the

list; for local plugins you need to specify the full path to the file exposing

you plugin description. For example, the following configuration would enable

the `arkivo-kindle` plugin (installed via NPM) and a local plugin:

    {

      "arkivo": {

        "plugins": ["arkivo-kindle", "/opt/arkivo/plugins/libnotify"]

      }

    }