lodex v0.9.8

LODEX

LODEX is an experimentation aiming to link ISTEX data to the web of data.

Installation

See the Installation instructions page.

Start

To start lodex:

$ lodex

Settings

files

You can put your settings in any of these paths:

• ./.lodexrc (or any upper level repository: ../, ../../, etc.)
• $HOME/.lodexrc
• $HOME/.lodex/config
• $HOME/.config/lodex
• $HOME/.config/lodex/config
• /etc/lodexrc
• /etc/lodex/config

Or you can pass it:

• in command line arguments,
• in variables prefixed with lodex,
• via an option --config file, then from that file.

Or you can put your settings in a JSON file besides your data repository.

For example, if you run lodex /path/to/repository, the file will be /path/to/repository.json.

Wherever the settings file is, it is a JSON file.

parameters

• connectionURI: URI to connect to mongoDB (by default: mongodb://localhost:27017/lodex)
• port: the port the web application will listen (default: 3000)
• title: title of the application (default: Change title)
• description: description for the application (default: Change description)
• themeName: identifier of the template/CSS theme used (default: default, other possible:istex`)
• baseURL: base URL for the URIs (by default: 127.0.0.1)
• access: array of objects containing:
  • login
  • plain: password in plain text
  • display: real name, as displayed in the application
• strategies: TODO
• ...

Use

First copy config.sample.js into config.local.js, and put the file(s) to load in the data directory.

As the backoffice no more works (after version 0.8.5), you have to configure the fields in the config.local.js.

fields

• datasetFields describe the fields applying to all collections of the dataset
• collectionFields describe the fields applying only to the collection (formerly called table)

Each field should contain:

• title: a free title for the field
• scheme: the URI of a property (maybe found on the LoV)
• type: the URI of an XML Schema type (string, boolean, decimal, float, double, duration, dateTime, time, date, ...)
• content<: the JBJ stylesheet allowing to set the content of the field (from the raw document)

baseURL

To generate non-local URI, you need to set the baseURL field in the config.local.js, which will replace the http://127.0.0.1:3000 part of the URIs.

themeName

The name of the theme used (see views/themes).

Example of minimal config.local.js (lacking datasetFields and collectionFields configuration):

'use strict';
module.exports =
{
  themeName : 'istex',
  baseURL: 'http://example.lod.istex.fr',
  heartrate: 100,
  access: [
    {
      login: 'francois',
      plain: 'c0mpL3XPassW0rD',
      display: 'François Parmentier'
    }
  ]
};

Contribute

Here are few indicators of the quality of the code, they can be used as indications on what can be improved:

To run lodex, use:

$ DEBUG=castor*,console* ./lodex /datas/lodex/empty/

To understand, see:

• General specifications