MusicBrainz Server/Setup: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
(Removed mention of Gentoo Server Setup & Development To Do List; generally cleaned up page.)
(Specified both /trunk and /branches INSTALL links; replaced Lucene search server with link to svn README)
Line 3: Line 3:
==Introduction==
==Introduction==


In order to set up a running '''mb_server''' on your machine you will need the following:
In order to set up a running MusicBrainz server on your machine you will need the following:
* A linux box, preferably Ubuntu, that is a PIII-700 or better, with 256MB RAM and 2Gb of free disk space.
* A linux box, preferably Ubuntu, that is a PIII-700 or better, with 256MB RAM and 2Gb of free disk space.
* A knowledge of Apache, Perl, mod_perl, PostgreSQL and a number of perl modules.
* A knowledge of Apache, Perl, mod_perl, PostgreSQL and a number of perl modules.
* [[Subversion]] knowledge which will enable you to check out the source code.
* [[Subversion]] knowledge which will enable you to check out the source code.
* A knowledge of how to compile and install packages from source on a Linux box.
* A knowledge of how to compile and install packages from source on a Linux box.
* A knowledge of how to patch existing packages is helpful, although we can help you out if you have questions about that. (''[[Contact Us|contact us]]'')
* A knowledge of how to patch existing packages is helpful, although we can help you out if you have questions about that.

An alternative option to the above is to install a [[Virtual MusicBrainz Server|virtual MusicBrainz server]] that comes with a Linux environment fully configured with the latest release of the '''mb_server''' source code.


Some additional notes to keep in mind:
Some additional notes to keep in mind:
Line 16: Line 14:
* The server has ''never been ported to Windows'', and we suspect that it would be a fair amount of work to make that happen.
* The server has ''never been ported to Windows'', and we suspect that it would be a fair amount of work to make that happen.


An alternative option to the above is to install a [[Virtual MusicBrainz Server|virtual MusicBrainz server]] that comes fully configured with a Linux environment and the latest release of the '''mb_server''' source code.
If you are considering helping out with [[Server|MusicBrainz server]] development, thank you! Otherwise, happy hacking!

If you are considering helping out with [[Development|server development]], thank you! Otherwise, happy hacking!


==Installation instructions==
==Installation instructions==
:''If you just want a running database, use the [[Database Setup|database setup]] instead.''

If you meet the above requirements read the [http://bugs.musicbrainz.org/browser/mb_server/trunk/INSTALL INSTALL] for complete installation instructions. If you are not familiar with all the requirements above, but are serious about '''mb_server''' development, join us in the [[Contact Us#IRC|IRC channel]] and/or post questions to the [[Developers Mailing List|developers mailing list]] and we will attempt to help you out if you get stuck.

==Don't be discouraged by the steep learning curve==


# If you are a MusicBrainz developer working on the next server release use [http://bugs.musicbrainz.org/browser/mb_server/trunk/INSTALL /trunk/INSTALL].
We realize that this is a stiff set of requirements to get started, but please don't let this discourage you. The [http://bugs.musicbrainz.org/browser/mb_server/trunk/INSTALL INSTALL] file is thorough and contains a lot of information, and thus also looks daunting. 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. Once you get the MusicBrainz server running, take a look at the [[Help Wanted|help wanted]] page so see how you can contribute.
# For everyone else use the latest stable release, [http://bugs.musicbrainz.org/browser/mb_server/branches/RELEASE_20090524-BRANCH/INSTALL /branches/RELEASE_20090524-BRANCH/INSTALL].
# If you just want a running database (no website frontend) see the [[Database Setup|database setup]] guide instead.
# Additionally, if you want to setup your own search server instead of having to query <code>search.musicbrainz.org</code>, there is a [http://bugs.musicbrainz.org/browser/search_server/trunk/README README] for that.


The requirements may look daunting, but please don't let this discourage you; the INSTALL/README files are thorough and contain 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 #musicbrainz IRC channel] or post a question on the [[Developers Mailing List|developers mailing list]] and we will attempt to help you out.
==Related HowTo's==


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!
* [[Lucene Server Setup|Lucene server setup]] - if you want to setup your own search server instead of having to query search.musicbrainz.org.


[[Category:WikiDocs Page]] [[Category:Development]] [[Category:Server]]
[[Category:WikiDocs Page]] [[Category:Development]] [[Category:Server]]

Revision as of 18:33, 4 January 2010

Products > Server > Server development > Server setup

Introduction

In order to set up a running MusicBrainz server on your machine you will need the following:

  • A linux box, preferably Ubuntu, that is a PIII-700 or better, with 256MB RAM and 2Gb of free disk space.
  • A knowledge of Apache, Perl, mod_perl, PostgreSQL and a number of perl modules.
  • Subversion knowledge which will enable you to check out the source code.
  • A knowledge of how to compile and install packages from source on a Linux box.
  • A knowledge of how to patch existing packages is helpful, although we can help you out if you have questions about that.

Some additional notes to keep in mind:

  • You do not actually need to know SQL/Perl to setup the server, but if you plan on adding features to MusicBrainz it will help to have experience in those areas.
  • The server has never been ported to Windows, and we suspect that it would be a fair amount of work to make that happen.

An alternative option to the above is to install a virtual MusicBrainz server that comes fully configured with a Linux environment and the latest release of the mb_server source code.

If you are considering helping out with server development, thank you! Otherwise, happy hacking!

Installation instructions

  1. If you are a MusicBrainz developer working on the next server release use /trunk/INSTALL.
  2. For everyone else use the latest stable release, /branches/RELEASE_20090524-BRANCH/INSTALL.
  3. If you just want a running database (no website frontend) see the database setup guide instead.
  4. Additionally, if you want to setup your own search server instead of having to query search.musicbrainz.org, there is a README for that.

The requirements may look daunting, but please don't let this discourage you; the INSTALL/README files are thorough and contain a lot of information, and we are willing to provide assistance. If you have questions about installing, join us in the #musicbrainz IRC channel or post a question on the developers mailing list 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!