https://github.com/gbv/gbvdoc

https://github.com/gbv/gbvdoc

Last synced: 3 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/gbv/gbvdoc
• Owner: gbv
• Created: 2011-11-07T16:02:44.000Z (about 13 years ago)
• Default Branch: master
• Last Pushed: 2024-10-29T08:38:47.000Z (2 months ago)
• Last Synced: 2024-11-10T03:17:12.432Z (2 months ago)
• Language: Perl
• Homepage: http://uri.gbv.de/document/
• Size: 229 KB
• Stars: 1
• Watchers: 22
• Forks: 0
• Open Issues: 10
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# SYNOPSIS

The application is automatically started as service, listening on port 6012.

    sudo service gbvdoc {status|start|stop|restart}

# INSTALLATION

The software is released as Debian package for Ubuntu 14.04 LTS. Other Debian

based distributions *might* work too. Releases can be found at

To install required dependencies either use a package manager such as `gdebi`,

manually install dependencies (inspectable via `dpkg -I gbvdoc_*.deb`):

    sudo dpkg -i ...                       # install dependencies

    sudo dpkg -i gbvdoc_X.Y.Z_amd64.deb    # change X.Y.Z

After installation the service is available at localhost on port 6012. Better

put the service behind a reverse proxy to enable SSL and nice URLs! In the

following a reverse proxy mapping  to

 is assumed.

# USAGE

GBV Documents provides an interface with links to APIs for access of

metadata from databases used and/or provided by VZG.

# ADMINISTRATION

## Configuration

Config file `/etc/default/gbvdoc` only contains basic server configuration

in form of simple key-values pairs:

* `PORT`    - port number (required, 6012 by default)

* `WORKERS` - number of parallel connections (required, 5 by default).

## Logging

Log files are located at `/var/log/gbvdoc/`:

* `error.log`

* `access.log`

# CHANGES

See `debian/changelog`.

# DEVELOPMENT

Install dependencies:

    sudo make dependencies

    make local

Run local instance:

    make run

Run unit tests:

    make tests

# SEE ALSO

The source code of gbvdoc is managed in a public git repository at

. Please report bugs and feature request at

!

The Changelog is located in file `debian/changelog`.