MusicBrainz Server/Setup: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
No edit summary
m (→‎Requirements: Remove the required version of PostgreSQL, which was outdated and would like become outdated again, mention some other key software requirements)
 
(47 intermediate revisions by 11 users not shown)
Line 1: Line 1:
== MusicBrainz Server virtual machine ==
== 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.
Running a MusicBrainz Server as a virtual machine requires some Linux knowledge, but it is vastly simpler than installing the server 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.md INSTALL.md]. To set up a virtual machine instance, download the torrent file and follow these steps:


It can be used to:
<div style="background-color:#FFFAF5; border: 1px solid #FFDAA4; padding:10px 20px; width: 400px; margin: 20px 20px 20px 0">
* Replicate the MusicBrainz website/web service/database,
'''MusicBrainz Server Virtual Machine <br />
* Test your own app that queries MusicBrainz web service,
BitTorrent Download: [ftp://mayhemchaos.org/pub/musicbrainz/vm/musicbrainz-server-2013-10-14.ova.torrent musicbrainz-server-2013-10-14.ova.torrent]<br />
* Develop MusicBrainz Server itself.
Size: 106Kb<br/>
Version: 2013-10-14<br />
</div>


See [https://github.com/metabrainz/musicbrainz-docker MusicBrainz Docker] and its [https://github.com/metabrainz/musicbrainz-docker/releases release notes].
<div style="background-color:#FFFAF5; border: 1px solid #FFDAA4; padding:10px 20px; width: 400px; margin: 20px 20px 20px 0">
'''MusicBrainz Server Virtual Machine <br />
FTP Download: [ftp://mayhemchaos.org/pub/musicbrainz/vm/musicbrainz-server-2013-10-14.ova musicbrainz-server-2013-10-14.ova]<br />
Size: 10GB Open Virtualization Archive (OVA)<br/>
(the extracted virtual drive is then 27 GB and can extend up to 40 GB)<br/>
Version: 2013-10-14<br />
MD5: <small>191871ea1ebb50284cb3b14061ebd064</small>
</div>


=== Running with VMware ===
== 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, …).
# Importing this VM into VMWare seems to fail. We plan to release a VMWare specific image later.


Get a copy of musicbrainz-server from git:
=== Running with VirtualBox ===
# Start VirtualBox and choose ''Import Appliance'' from the File menu. Select the downloaded file.</strike>
# Once VirtualBox has imported the appliance, select the imported virtual machine from the list of virtual machines and click on Start.

=== Running with QEMU/KVM ===

# Extract the disk image: <pre>tar -xf musicbrainz-server-2013-10-14.ova</pre>
# Covert it from VMWare format: <pre>qemu-img convert -O qcow2 musicbrainz-server-2013-10-14-disk1.vmdk /var/lib/libvirt/images/musicbrainz-server-2013-10-14-disk1.qcow2</pre>
# Create and start the new VM: <pre>virt-install --ram 1024 --os-type=linux --os-variant=ubuntuprecise --name musicbrainz-server-2013-10-14 --import --disk /var/lib/libvirt/images/musicbrainz-server-2013-10-14-disk1.qcow2</pre>

=== Using the VM with VirtalBox ===
# Once the instance has started up, log in on the console using the username ''vm'' and password ''musicbrainz''. This account has sudo privileges -- if you would like to set a root password, you can do that via sudo.
# You can SSH into the machine via the port 2222 on localhost of the host OS. (e.g. ssh -p 2222 localhost )
# To access the MusicBrainz web site and web service, go to: http://localhost:5000
# To access the Search Server web service, go to: http://localhost:8080

=== Tuning your VM ===

We recommend that you give your VM 2GB of ram, if that is possible. The more RAM you give to the VM, the faster it is going to run. To change the memory settings, you will need to shut down the VM, change the settings and then re-start the VM. The Postgres database will be automatically tuned based on the available RAM when the VM starts up.

=== Running Replication ===

This VM comes "replication ready". To enable replication, and have the database catch up with the latest replication packets, do this:
bin/replicate now

This will load all of the changes to the database since the VM update.

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]]. Drop pre-filled database using command <pre>dropdb musicbrainz_db</pre> and check [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL.md the INSTALL.md file] for how to import new data.

=== Automating Replication ===

To turn on background replication, run:

bin/replicate start

to turn it off:

bin/replicate stop

We recommend leaving replication off for the time being, until you've built search indexes for the VM.

=== Building search indexes ===

The VM comes with support to build search indexes. In order to build the indexes, log in to the account and then:

bin/reindex

Depending on your machine, this may take quite a long time. We recommend that you leave this running overnight. After the indexes are complete, you should be able to carry out indexed searches in your VM.

=== Accessing the database ===

To access the main postgres database, you can do this:

sudo su - musicbrainz
cd musicbrainz-server/admin
./psql 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:
admin/psql READWRITE < admin/sql/CreateFKConstraints.sql
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.

== Migrating the MusicBrainz Server from a Virtual Machine to a Physical Machine ==
Taken from [http://askubuntu.com/questions/32499/migrate-from-a-virtual-machine-vm-to-a-physical-system AskUbuntu].

It is possible to migrate the MusicBrainz Server image (or any virtual image) from a virtual machine onto bare metal, should you desire to.

=== Requirements ===
* A LiveCD or LiveUSB (this walkthrough will assume you are using a Ubuntu variant as that is what the image is based on.) '''If you are using an image from 2013-08-01 or earlier, you must have a Ubuntu 12.04.1 Live media.'''
* USB media large enough to store the raw disk image for writing on a new computer.
* Patience

=== Step 1: Converting the Disk to a Raw format ===
This step is included mostly for the sake of convenience. By doing some prep work on the image before writing, standard Linux tools can be used to write to and manipulate the disk afterwards. This can be done from your current host environment without booting to your LiveCD.
* Load a terminal
cd /path/to/image/
# for VMWare
sudo apt-get install qemu-kvm
qemu-img convert your-vmware-disk.vmdk -O raw disk.img
# For VirtualBox
VBoxManage internalcommands converttoraw your-virtualbox-disk.vdi disk.img

* Move <code>disk.img</code> to somewhere that you're not about to write to. If your target is another physical machine, then an external medium is probably the most convenient way to move the image. These instructions assume that you have moved it to <code>/media/external/disk.img</code>. Adjust accordingly.
* Before you do anything permanent, '''make sure you do backups'''. These instructions will erase anything on the target disk or partition. It's better to be safe than sorry.

=== Option 1: Write the Image to it's Own Disk ===
'''This assumes that you're going to overwrite an entire disk'''. This is the most ideal situation since the server will have an entire disk to work with. If you're looking to have the image installed along side an existing operating system, skip to Option 2.
* Boot into your LiveCD and Click Try Ubuntu.
* Mount the volume where <code>disk.img</code> resides to somewhere safe (like /media/external).
* Determine which volume is your target using a command like <code>lsblk</code> or <code>blkid</code>
* Then we copy the contents of the image to the drive Replace <code>sdX</code> with the correct destination disk. The password for <code>sudo</code> is blank.
sudo dd if=/media/external/disk.img of=/dev/sdX
* After this has finished, you can use <code>gparted</code> or another utility to manipulate the partition table to the desired layout. It is recommended to have a sizeable swap partition (see [http://www.cyberciti.biz/tips/linux-swap-space.html this article] for some recommendations on how big it should be) as well as expand the root partition to use all remaining available space on the disk. If you desire a seperate boot partition for the system as well, set aside some space here. (Steps for this can be found [https://help.ubuntu.com/community/BootPartition in the Ubuntu community documentation])
* '''If you are using an image from 2013-08-01 or earlier, please see [[ChangingKernelVersions|here]]'''.

=== Option 2: Installing the Image Alongside Another OS ===
This is potentially safer than the above method and is very similar. Your LiveCD '''must be the same Ubuntu version as the virtual image.'''
* Boot into the LiveCD and click Install Ubuntu.
* Follow the installer prompts, repartition things as you see fit. When the installer finishes, it will ask you to reboot. Do not reboot. You must be in the Live environment for the next instructions.
* Mount your new Ubuntu install (target) and your external disk where you stored <code>disk.img</code> earlier.
* Mount <code>disk.img</code>.
sudo mkdir /media/oldinstall
sudo mount -o loop /media/external/disk.img /media/oldinstall
* From there you can either cherry pick files or copy over everything on top of your target. For example, using <code>rsync</code>:
sudo rsync /media/oldinstall /media/newinstall
* Reboot and you ''should'' be greeted by your virtual machine, but on bare metal. If you have GRUB errors, see [https://help.ubuntu.com/community/Grub2#Reinstalling%20GRUB%202 this article from the Ubuntu community documentation]

=== <div id="ChangingKernelVersions">Changing Kernel Versions</div> ===
Parts taken from [https://help.ubuntu.com/community/Grub2/Installing#via_ChRoot the Ubuntu community documentation].

For images from 2013-08-01 and older, you will need to change the kernel flavour from -virtual to -generic. The -virtual kernel flavour is lighter, but only supports hardware typically seen in virtual environments while -generic provides support for a wider range of hardware, such as what you would see in a physical server. Both of these versions are provided in the default Ubuntu repositories.
* Boot into your LiveCD. Click "Try Ubuntu"
* Open a terminal.
* Determine which disk is yours using a command like <code>sudo lsblk</code> or <code>sudo blkid</code>.
* Mount your root partition. '''X''' is the drive letter and '''Y''' is the partition number:
sudo mount /dev/sdXY /mnt
** If you have a seperate boot partition, mount it as well ('''Z''' is the boot partition number):
sudo mount /dev/sdXZ /mnt/boot
* Mount the virtual filesystems using the following single command:
for i in /dev /dev/pts /proc /sys /run; do sudo mount -B $i /mnt$i; done
* Chroot into your installation
sudo chroot /mnt
* Install the latest -generic image and headers by installing the metapackage. This will regenerate GRUB's configuration.
sudo apt-get install linux-image-generic linux-header-generic
* Purge the -virtual image and headers. This should also regenerate GRUB's configuration:
sudo apt-get purge --auto-remove linux-image-virtual linux-header-virtual
* Check for leftover -virtual images in <code>/boot</code>. If you find any, remove them and then run <code>sudo update-grub</code>
* Reboot into your installation.

== 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 --recursive https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server
git clone --recursive https://github.com/metabrainz/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.md 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, Perl, Node.js, and some other dependencies (See [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL.md#prerequisites all software prerequisites])


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 19:58, 28 March 2023

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, Perl, Node.js, and some other dependencies (See all software prerequisites)

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