Difference between revisions of "MusicBrainz Server/Setup"

From MusicBrainz Wiki
(Update the instructions to be correct for the 2012-04-11 ova)
(Setup MusicBrainz Server from source code: Update after MusicBrainz Docker became officially recommended)
 
(83 intermediate revisions by 19 users not shown)
Line 1: Line 1:
<small>[[Products]] > [[MusicBrainz Server]] > Server Setup</small>
+
== Setup from Docker Compose ==
  
== MusicBrainz Server virtual machine ==
+
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.
  
Running an NGS virtual machine requires some Linux knowledge, but it vastly simpler than installing NGS from scratch. The pre built virtual image can be imported into either VirtualBox or VMware. If you are using Amazon EC2 you can not use this virtual image and will instead have to follow the steps outlined in the source code [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL INSTALL]. To use the virtual machine instance, follow these steps:
+
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.
  
# Start downloading the latest [http://ftp.musicbrainz.org/pub/musicbrainz/vm/MusicBrainz%20NGS%202012-04-11.ova virtual machine instance] ([http://ftp.uk.musicbrainz.org/pub/musicbrainz/vm/MusicBrainz%20NGS%202012-04-11.ova UK mirror]). Beware: This is a large (5.4GB) download!
+
See [https://github.com/metabrainz/musicbrainz-docker MusicBrainz Docker] and its [https://github.com/metabrainz/musicbrainz-docker/releases release notes].
# Download and install [http://virtualbox.org Virtual Box] on your machine.
 
# Start Virtual Box and choose ''Import Appliance'' from the File menu. Select the downloaded file.
 
# Once Virtual Box has imported the appliance, select the imported virtual machine from the list of virtual machines and click on Start.
 
# Once the instance has started up, log in on the console using the username ''musicbrainz'' and password ''musicbrainz''. This account has sudo privileges -- if you would like to set a root passwd, you can do that via sudo.
 
# Get the IP address of your virtual machine. Note this down from "inet addr" with this command: <pre>ifconfig | grep eth0 -A 1</pre> NOTE: if eth0 is not configured correctly, perhaps you've encountered [http://superuser.com/questions/90584/network-interface-missing-in-ubuntu-after-changing-mac-address this problem].
 
# Optional: The console for Virtual Box is very slow. It may be faster to SSH into the virtual box with a good terminal program.
 
# To start the NGS server, enter these commands <pre>cd ~/musicbraiz-server&#10;carton exec -- plackup -Ilib -r</pre> Now you can reach the MusicBrainz server by pointing your browser to port 5000 of the IP address in step 6.
 
#* e.g If your IP address from step 6 was: 10.1.1.104, then point your browser to http://10.1.1.104:5000
 
#* If the server looks like it started correctly and you cannot connect in your browser, try pinging it from your '''host''' operating system command line <pre>ping <inet addr></pre> If you cannot ping it, you may have a VirtualBox network configuation problem. Try the instructions [http://askubuntu.com/questions/56434/cant-ping-from-virtualbox-ubuntu-server-nat-connection here] to switch your VM to using a ''bridged connection'' rather than ''NAT''. Restart the virtual machine and find the new IP address in step 6 again. Start the MusicBrainz server again.
 
  
=== Troubleshooting ===
+
== Setup from source code ==
 +
This can potentially be a very laborious and time consuming method of getting a functioning MusicBrainz server. Use it only if you cannot use MusicBrainz Docker for some reason (disk space, development, …).
  
If you update the code base in an early version of the virtual server, you may encounter an error that complains about DEVELOPMENT_SERVER not being defined, please add this line to your lib/DBDefs.pm file:
+
Get a copy of musicbrainz-server from git:
 
+
  git clone --recursive https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server
sub DEVELOPMENT_SERVER { 1 }
 
 
 
And then start the server.
 
 
 
=== Running Replication ===
 
 
 
This VM comes "replication ready". To enable replication, and have the database catch up with the latest replication packets, do this:
 
 
 
* Start replication
 
cd ~/musicbrainz-server/admin/replication
 
./LoadReplicationChanges
 
 
 
This will load all of the changes to the database since the VM update. To automate this, add this script to a cron job that fires off 10 minutes after each hour. NOTE: Loading replication changes might take a long time. If the VM is more than a couple of weeks old, it might be better for you to import a [[MusicBrainz Database/Download|fresh data set]]. Check [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL the INSTALL file] for how to import new data.
 
 
 
=== Accessing the database ===
 
 
 
To access the main postgres database, you can do this:
 
 
 
cd ~/musicbrainz-server/admin
 
./psql READWRITE
 
 
 
to accces the RAWDATA database (that also contains edits), use RAWDATA, instead of READWRITE. If you would like to access the DB from outside the virtual box, take a look at [http://www.cyberciti.biz/tips/postgres-allow-remote-access-tcp-connection.html how to change postgres connection settings].
 
 
 
=== Turning the VM into development box ===
 
 
 
If you would like to use the VM to do development instead of using it as a simple database slave, you'll need to edit lib/DBDefs.pm and set REPLICATION_TYPE to RT_STANDALONE and run admin/psql READWRITE and execute the following queries:
 
 
 
DELETE FROM annotation WHERE editor > (SELECT max(id) FROM editor);
 
DELETE FROM release_annotation WHERE NOT EXISTS (SELECT 1 FROM annotation WHERE annotation.id = release_annotation.annotation);
 
 
 
then from the command line execute:
 
 
# run admin/psql READWRITE < admin/sql/CreateFKConstraints.sql
 
# run admin/psql READWRITE < admin/sql/CreateFunctions.sql
 
 
 
TODO: The server will probably run out of disk space during this process. We need to add instructions on how to move the DB to a new partition.
 
 
 
== 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.
 
 
 
Get a copy of musicbrainz-server from git:  
 
  git clone git://git.musicbrainz.org/musicbrainz-server.git musicbrainz-server
 
 
  cd musicbrainz-server
 
  cd musicbrainz-server
And follow the instructions in the [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL INSTALL] file.
+
And follow the instructions in the [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL.md INSTALL] file.
  
== Support ==
+
=== Support ===
  
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 [http://webchat.freenode.net/?channels=musicbrainz-devel #musicbrainz-devel IRC channel] or post a question on the [[Developers Mailing List|developers mailing list]] and we will attempt to help you out.
+
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 [http://webchat.freenode.net/?channels=metabrainz #metabrainz IRC channel] or post a question on the [https://community.metabrainz.org/tags/musicbrainz-server 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!
 
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!
  
==Requirements==
+
===Requirements===
  
 
In order to set up a running MusicBrainz server with the full database you will need:
 
In order to set up a running MusicBrainz server with the full database you will need:
 
* A linux box, preferably Ubuntu.
 
* A linux box, preferably Ubuntu.
* 8GB of free disk space, (if you are a developer and only want the server code and database structure 2GB is more than enough).
+
* 60GB+ of free disk space, (if you are a developer and only want the server code and database structure 2GB+ should do, count 6GB+ if you want sample data).
* [[Git]] knowledge which will enable you to check out the source code.  
+
* [[Git]] knowledge which will enable you to check out the source code.
 +
* PostgreSQL 9.5 or later (and some [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL.md#prerequisites other dependencies])
  
 
As a developer the following knowledge/skills are beneficial:
 
As a developer the following knowledge/skills are beneficial:
* Apache, Perl, mod_perl, PostgreSQL and a number of perl modules.
+
* Perl and a number of perl modules, PostgreSQL, React/JSX.
* How to compile and install packages from source on a Linux box.  
+
* 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.
 
* 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.
 
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==
 +
* [https://github.com/metabrainz/musicbrainz-server MusicBrainz Server] on GitHub
 +
** 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/musicbrainz+server/?tag=instructions instructions] on the MetaBrainz 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 MetaBrainz 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]]

Latest revision as of 15:55, 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 from source code

This can potentially be a very laborious and time consuming method of getting a functioning MusicBrainz server. Use it only if you cannot use MusicBrainz Docker for some reason (disk space, development, …).

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.

Support

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!

Requirements

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

  • A linux box, preferably Ubuntu.
  • 60GB+ of free disk space, (if you are a developer and only want the server code and database structure 2GB+ should do, count 6GB+ if you want sample data).
  • 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, React/JSX.
  • 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