Difference between revisions of "MusicBrainz Server/Setup"

From MusicBrainz Wiki
(MusicBrainz Server Docker container: Officially recommend MusicBrainz Docker for setup)
(External Links: Update links for MusicBrainz Docker and to blog.metabrainz.org (some categories and tags still need to be fixed))
Line 41: Line 41:
==External Links==
==External Links==
* [https://github.com/metabrainz/musicbrainz-server MusicBrainz Server] on GitHub
* [https://github.com/metabrainz/musicbrainz-server MusicBrainz Server] on GitHub
* List of [http://blog.musicbrainz.org/category/server/?tag=changelog server updates] on the MusicBrainz blog
* List of [https://blog.metabrainz.org/category/musicbrainz+server/?tag=changelog MusicBrainz Server updates] on the MetaBrainz blog
* List of supplemental [http://blog.musicbrainz.org/category/server/?tag=instructions instructions] on the MusicBrainz blog
* List of supplemental [http://blog.musicbrainz.org/category/musicbrainz+server/?tag=instructions instructions] on the MetaBrainz blog
* List of [http://blog.musicbrainz.org/category/virtual-machine/ VM releases] on the MusicBrainz blog
* [https://github.com/metabrainz/musicbrainz-server MusicBrainz Docker] on GitHub
* List of [https://blog.metabrainz.org/category/musicbrainz+virtual-machine/ MusicBrainzB Virtual Machine releases] on the MusicBrainz blog
* List of [https://github.com/metabrainz/musicbrainz-server/releases MusicBrainz Docker releases] on GitHub
[[Category:WikiDocs Page]] [[Category:Download]] [[Category:Development]] [[Category:Server]]
[[Category:WikiDocs Page]] [[Category:Download]] [[Category:Development]] [[Category:Server]]

Revision as of 15:33, 15 May 2020

Setup from Docker Compose

This method is recommended as it makes install, setup, and maintenance much easier for you, to the cost of a small overhead compared to the size of the database.

It can be used to:

  • Replicate the MusicBrainz website/web service/database,
  • Test your own app that queries MusicBrainz web service,
  • Develop MusicBrainz Server itself.

See MusicBrainz Docker and its release notes.

Setup MusicBrainz Server from source code

This can potentially be a very laborious and time consuming method of getting a functioning MusicBrainz server. Using the virtual machine is recommended, except for development purpose.

Get a copy of musicbrainz-server from git:

git clone --recursive https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server
cd musicbrainz-server

And follow the instructions in the INSTALL file.


The setup process may look daunting, but please don't let this discourage you; the INSTALL is thorough and contains a lot of information, and we are willing to provide assistance. If you have questions about installing, join us in the #metabrainz IRC channel or post a question on the community forum and we will attempt to help you out.

We recommend that you dive in and give it a try - who knows how far you'll get and what you might learn along the way!


In order to set up a running MusicBrainz server with the full database you will need:

  • A linux box, preferably Ubuntu.
  • 20GB+ of free disk space, (if you are a developer and only want the server code and database structure somewhat less should do).
  • Git knowledge which will enable you to check out the source code.
  • PostgreSQL 9.5 or later (and some other dependencies)

As a developer the following knowledge/skills are beneficial:

  • Perl and a number of perl modules, PostgreSQL, nginx.
  • How to compile and install packages from source on a Linux box.
  • How to patch existing packages, although we can help you out if you have questions about that.

Note: The server has never been ported to Windows, and we suspect that it would be a fair amount of work to make that happen.

External Links