NetKAN indexing service
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3c735a6 Nov 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin
init
lib/App
t
.gitignore
.travis.yml Fix spelling, add to testing Jul 13, 2016
README.md Update install instructions Aug 23, 2018
dist.ini
perlcritic.rc

README.md

App::KSP-CKAN Build Status Coverage Status

Non Perl Dependencies

apt-get install liblocal-lib-perl cpanminus build-essential mono-complete libcurl4-openssl-dev python-jsonschema libdist-zilla-perl

NetKAN will need certs for mono

mozroots --import --ask-remove

Configure local::lib if you haven't already done so:

$ perl -Mlocal::lib >> ~/.bashrc
$ eval $(perl -Mlocal::lib)

Installation

Install from git, you can then use:

$ touch Changes
$ dzil authordeps | cpanm
$ dzil listdeps   | cpanm
$ dzil install

or cpanm via the tar.gz on the GitHub Release page

cpanm App-KSP_CKAN-0.001.tar.gz

Configuration

An ini file with the following contents will need to created at ~/.ksp-ckan

CKAN_meta=git@github.com:KSP-CKAN/CKAN-meta.git
NetKAN=git@github.com:KSP-CKAN/NetKAN-bot.git
netkan_exe=https://ckan-travis.s3.amazonaws.com/netkan.exe
ckan_validate=https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/bin/ckan-validate.py
ckan_schema=https://raw.githubusercontent.com/KSP-CKAN/CKAN/master/CKAN.schema
working=/home/NetKAN/NetKAN

If you have a GitHub token, add the following line (helpful for prevent expending the GitHub public API limits):

GH_token=1234567890

Running

Completing a full index is as straight forward as:

netkan-indexer

Debugging will print debug messages to the logfile and to the screen. It is enabled with

netkan-indexer --debug

Enable it in cron with (crontab -e as the netkan user):

# Run full index every 3 hours
00 */3 * * * PERL5LIB=/home/netkan/perl5/lib/perl5/ netkan-indexer

There is a 'lite' cli option is not implemented. It's a future concept to allow 'lite' skimming of metadata API endpoints without performing a full metadata inflation.

License

Dist::Zilla handles the generation of the license file.

However this project is covered by The MIT License (MIT)