This project is in experimental stage. It works, but there are a lot of things

to be done better. Please use it and create Issues with your problems.

* [Install Docker](https://docs.docker.com/installation/)

* Clone this repo

* Build all images with the comands like:

`cd cpan-api; docker build --tag cpan-api .`

The system consists of serverl microservices that live in docker containes:

* `cpan_volume` — data volume container that shares directory `/cpan` with

all other containers

* `elasticsearch` — database

* `cpan-api` — the main server — it uses `elasticsearch` and `/cpan`

directory

* `metacpan-web` — the web interface — it works with `cpan-api`

Eveything starts from the volume `/cpan`.

First you need to create data volume contaner:

docker run --name cpan_volume --volume=/cpan ubuntu:14.04

Then it is possible to add some files to that volume. The simplest way is to

use `orepan2` image. But there can be other ways to populate the `/cpan`

volume. Here is a sample command that adds module from the big cpan to your

`/cpan` volume:

docker run \

--rm \

--volumes-from=cpan_volume \

orepan2 \

orepan2-inject --author BESSARABV App::Stopwatch /cpan

One can inspect the content of the volume with one-shot container:

docker run \

--rm \

--volumes-from=cpan_volume \

ubuntu:14.04 \

find /cpan

The output will be something like:

/cpan

/cpan/modules

/cpan/modules/02packages.details.txt.gz

/cpan/orepan2-cache.json

/cpan/authors

/cpan/authors/id

/cpan/authors/id/B

/cpan/authors/id/B/BE

/cpan/authors/id/B/BE/BESSARABV

/cpan/authors/id/B/BE/BESSARABV/App-Stopwatch-1.2.0.tar.gz

You also need to generate `00whois.xml` file. If you use logins from big cpan

you can get that file from cpan:

docker run \

--rm \

--volumes-from=cpan_volume \

orepan2 \

curl -o /cpan/authors/00whois.xml cpan.cpantesters.org/authors/00whois.xml

After we have some data in `/cpan` it is possible to add webinterface to it.

First you need to run container with elasticsearch:

docker run \

--detach \

--publish 9200:9200 \

--name elasticsearch \

elasticsearch

You can check that you have elasticsearch running with the comand:

curl 127.0.0.1:9200

PS If you run docker on mac or windows you should change `127.0.0.1` to the ip

address of our docker virtual machinge (you can find out this ip with the

`boot2docker ip`).

Here is the output you are expecred to see:

{

"ok" : true,

"status" : 200,

"name" : "Cage, Luke",

"version" : {

"number" : "0.90.7",

"build_hash" : "36897d07dadcb70886db7f149e645ed3d44eb5f2",

"build_timestamp" : "2013-11-13T12:06:54Z",

"build_snapshot" : false,

"lucene_version" : "4.5.1"

},

"tagline" : "You Know, for Search"

}

Next you need to run cpan-api server. This can be done with the command:

docker run \

--detach \

--volumes-from=cpan_volume \

--link=elasticsearch:elasticsearch \

--volume=$(pwd)/configs/cpan-api/metacpan.pl:/cpan-api/etc/metacpan.pl \

--volume=$(pwd)/configs/cpan-api/metacpan_server.conf:/cpan-api/metacpan_server.conf \

--env MINICPAN=/cpan \

--publish 5000:5000 \

--name cpan-api \

cpan-api

So the server is running but you also need to run some scripts to index data.

To do it you can create ineractive container:

docker run \

-it \

--rm \

--volumes-from=cpan_volume \

--link=elasticsearch:elasticsearch \

--volume=$(pwd)/configs/cpan-api/metacpan.pl:/cpan-api/etc/metacpan.pl \

--volume=$(pwd)/configs/cpan-api/metacpan_server.conf:/cpan-api/metacpan_server.conf \

--env MINICPAN=/cpan \

cpan-api \

bash

And then execute all the needed scripts:

carton exec bin/metacpan mapping --delete

carton exec bin/metacpan release /cpan/authors/id/

carton exec bin/metacpan latest --cpan /cpan/

carton exec bin/metacpan author --cpan /cpan/

Then you need to run metacpan-web:

docker run \

--detach \

--publish 5001:5001 \

--link=cpan-api:cpan-api \

--volume=$(pwd)/configs/metacpan-web/metacpan_web.conf:/root/metacpan-web/metacpan_web.conf \

--name metacpan-web \

metacpan-web

Open your browser at http://127.0.0.1:5001 and you will see metacpan web

interface.

use FindBin;

{

# ElasticSearch instance, can be either a single server

# or an arrayref of servers

es => 'elasticsearch:9200',

# the port of the api server

port => '5000',

# log level

level => 'info',

# appender for Log4perl

# default layout is "%d %p{1} %c: %m{chomp}%n"

# can be overridden using the layout key

# defining logger in metacpan_local.pl will

# override and not append to this configuration

logger => [{

class => 'Log::Log4perl::Appender::File',

filename => $FindBin::RealBin . '/../var/log/metacpan.log',

syswrite => 1,

}]

}

git /usr/bin/git

cpan /cpan

<model CPAN>

servers elasticsearch:9200

</model CPAN>

<model User>

servers elasticsearch:9200

</model User>

<plugin Session>

servers elasticsearch:9200

</plugin>

<controller User::Turing>

# required for server startup -- override this in metacpan_server_local.conf

private_key 59125ffc09413eed3f2a2c07a37c7a44b95633e2

</controller>

# rename this file to metacpan::web.yml and put a ':' after 'name' if

# you want to use YAML like in old versions of Catalyst

name MetaCPAN::Web

default_view HTML

api = http://cpan-api:5000

api_external = http://cpan-api:5000

api_secure = http://cpan-api:5000

api_external_secure = http://cpan-api:5000

consumer_key = metacpan.dev

cookie_secret = seekrit

consumer_secret = ClearAirTurbulence

mark_unauthorized_releases = 0

#site_alert_message = The sky is falling.

<view HTML>

INCLUDE_PATH root/

TAG_STYLE asp

PRE_PROCESS preprocess.html

WRAPPER wrapper.html

TEMPLATE_EXTENSION .html

ENCODING utf8

AUTO_FILTER html

STAT_TTL 1

COMPILE_PERL 2

COMPILE_DIR var/tmp/templates

</view>

<view Raw>

WRAPPER ""

</view>

<controller Account::Turing>

public_key 6LeH2MsSAAAAANwz3AA73Gw5OjCVjT6I51Ev-ior

</controller>

FROM ubuntu:14.04

ENV UPDATED_AT 2014-11-17

RUN apt-get update

RUN apt-get install -y \

curl \

gcc \

git \

libcurl4-openssl-dev \

libexpat1-dev \

libxml2-dev \

make

RUN curl -L http://cpanmin.us | perl - App::cpanminus

RUN cpanm Carton

RUN git clone https://github.com/CPAN-API/cpan-api.git /cpan-api/

WORKDIR /cpan-api/

RUN carton install

CMD ["carton", "exec", "plackup", "-p", "5000", "-r"]

You can build a docker image with command:

docker build --tag cpan-api .

And then run it:

docker run -it cpan-api /bin/bash