Skip to content
This repository has been archived by the owner on Jan 25, 2022. It is now read-only.

Commit

Permalink
Added an example devel.cfg; updated README.md with better build/run i…
Browse files Browse the repository at this point in the history
…nstructions
  • Loading branch information
ocharles committed Feb 15, 2013
1 parent 654406f commit f81344d
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 5 deletions.
34 changes: 29 additions & 5 deletions README.md
Expand Up @@ -11,13 +11,14 @@ repository with the `--recursive` flag:


git clone --recursive git://github.com/metabrainz/musicbrainz-data-service.git git clone --recursive git://github.com/metabrainz/musicbrainz-data-service.git


# Preliminary: Install `musicbrainz-data` # Preliminary: Install dependencies


Before you can build or install `musicbrainz-data-service`, you will need to Before you can build or install `musicbrainz-data-service`, you will need to
install `musicbrainz-data`. To do so, run the following commands from inside install dependencies. It's recommended to do this upfront, so you install
your `musicbrainz-data-service` checkout: dependencies for both `musicbrainz-data` *and* `musicbrainz-data-service` in one
step.


cd musicbrainz-data cd . ./musicbrainz-data
cabal install cabal install
cd .. cd ..


Expand All @@ -34,7 +35,12 @@ You also need access to a PostgreSQL database server with the `cube` and
`uuid-ossp` extensions, on Ubuntu 12.04 and 12.10 these extensions are in the `uuid-ossp` extensions, on Ubuntu 12.04 and 12.10 these extensions are in the
postgresql-contrib-9.1 package. postgresql-contrib-9.1 package.


Also, make sure you have installed `musicbrainz-data`, as mentioned above. You will also need to have `musicbrainz-data` installed. To install this, simply
run:

cd musicbrainz-data
cabal install
cd ..


Once you have met those requirements, you can now run: Once you have met those requirements, you can now run:


Expand Down Expand Up @@ -105,3 +111,21 @@ running:


Check the output of `cabal test --help` for various things that can also be done Check the output of `cabal test --help` for various things that can also be done
while you run tests. while you run tests.

# Running the Service

To run the service, you will need a `devel.cfg` file - this repository has an
example in [devel.cfg.example](devel.cfg.example). This file should be placed in
the working directory you plan to run the binary from.

If you have installed `musicbrainz-data-service` with `cabal install` you can
now simply run:

musicbrainz-data-service

If you used `cabal build`, the binary will be in `dist/build`, so you run the
service with:

./dist/build/musicbrainz-data-service/musicbrainz-data-service

Run the binary with `--help` to see supported command line options.
8 changes: 8 additions & 0 deletions devel.cfg.example
@@ -0,0 +1,8 @@
# The PostgreSQL database to connect
database = "musicbrainz"

# The database user
username = "musicbrainz"

# The database password
password = ""

0 comments on commit f81344d

Please sign in to comment.