Public | Automated Build

Last pushed: 7 months ago
Short Description
Builds for listenbrainz server
Full Description

listenbrainz-server

Server for the ListenBrainz project.

Installation

These instructions are meant to get you started quickly with development
process. Installation process in production environment might be different.

Prerequisites

In order to install ListenBrainz onto your machine or a VM, you will
need to install:

Configuration file

Copy the file config.py.sample to config.py:

$ cp config.py.sample config.py

Next, register for a MusicBrainz application:

https://musicbrainz.org/account/applications

During registration set the callback url to

http://<your_host>/login/musicbrainz/post

Where <your_host> is the DNS name or IP address of the machine running ListenBrainz.

Then set the MUSICBRAINZ_CLIENT_ID and MUSICBRAINZ_CLIENT_SECRET in
config.py to the OAuth Client ID and OAuth Client Secret of your application.

Start the services

$ ./develop.sh

This will automatically download all the needed software and build and start the necessary
containers needed to run ListenBrainz.

Database initialization

To initialize the database (create user, tables, etc.) run these commands:

$ docker exec -it listenbrainz_web_1 python manage.py init_db --create-db
$ docker exec -it listenbrainz_web_1 python manage.py init_msb_db --create-db
$ docker exec -it listenbrainz_influx_writer_1 python admin/influx/create_db.py

After that server should be ready to go. Go to http://localhost:8000 and load the
ListenBrainz home page.

Running tests

In order to run the tests for ListenBrainz, simply run:

$ ./test.sh

This will build and run the containers needed to run the tests. Each of these containers will not use volumes
that link to data outside of the containers and thus will not interfere with production databases.

Documentation

Documentation for the ListenBrainz API is available at https://listenbrainz.readthedocs.org.
You can build the documentation yourself:

$ cd ~/listenbrainz/docs
$ make clean html
Docker Pull Command
Owner
metabrainzdocker
Source Repository

Comments (0)