MusicBrainz Server/Setup: Difference between revisions

From MusicBrainz Wiki
Jump to navigationJump to search
m (Removing the second H1.)
(Removed mention of Gentoo Server Setup & Development To Do List; generally cleaned up page.)
Line 3: Line 3:
==Introduction==
==Introduction==


Thank you for considering helping out with [[Server|MusicBrainz server]] development! The first thing you will need is to set up a running '''mb_server''' on your own machine. You will need to following things for this:
In order to set up a running '''mb_server''' on your machine you will need the following:
* A linux box: 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.
* 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.
* Knowledge on 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.
* Knowledge on how to patch existing packages is also helpful - we can help you out if you have questions about that.
* 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 less painful option''' is to install VMWare (or the VMWare player) and run a copy of the [[Virtual MusicBrainz Server|VirtualMusicBrainzServer]].
⚫
** The server has '''never been ported to Windows''', and we suspect that it would be a fair amount of work to make that happen.
⚫
** You '''do not actually need to know SQL/Perl to setup the server'''. But if you plan on adding features to [[MusicBrainz]], you will need Perl, and probably also SQL experience.


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.
⚫
==Installation instructions==


Some additional notes to keep in mind:
⚫
If you meet the above requirements you should read the [http://bugs.musicbrainz.org/browser/mb_server/trunk/INSTALL complete installation instuctions]. Even if you are not familiar with all the requirements above, but are serious about '''mb_server''' development, join us in the [[Contact Us|IRC channel]] or post questions to the [[Developers Mailing List|DevelopersMailingList]], and we will attempt to help out if you get stuck. There is more information on how to install the server and load the correct dataset listed in [[Server Installation FAQ|ServerInstallationFAQ]] - make sure to read this page before asking questions.
⚫
* 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.


If you are considering helping out with [[Server|MusicBrainz server]] development, thank you! Otherwise, happy hacking!
==Which flavour of Linux should I use for mb_server?==


⚫
==Installation instructions==
We use [[WikiPedia:Ubuntu|Ubuntu]] as our Linux flavour of choice, however it is possible to setup the mb_server on other distributions as well.
⚫
:''If you just want a running database, use the [[Database Setup|database setup]] instead.''

Instructions for other distributions (may be sparse):
* [[Gentoo Server Setup|GentooServerSetup]]


⚫
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.
⚫
If you just want a running database, there is a guideline in [[Database Setup|DatabaseSetup]] which helps setting up just the database.


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


We realize that this is a stiff set of requirements to get started, but please don't let this discourage you. The 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, dive in and tackle a task on the [[Development To Do List|DevelopmentToDoList]] or send us mail via the [[Help Wanted|HelpWanted]] page.
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.


==Related HowTo's==
==Related HowTo's==


* [[Lucene Server Setup|Lucene server setup]] - if you want to setup your own search server instead of having to query search.musicbrainz.org.
* [[Lucene Server Setup|LuceneServerSetup]]
<ul><li style="list-style-type:none">If you want to setup your own search server ([[Lucene Server|LuceneServer]]) instead of querying the one of MusicBrainz (search.musicbrainz.org).
</ul>


[[Category:To Be Reviewed]] [[Category:WikiDocs Page]] [[Category:Development]] [[Category:Server]]
[[Category:WikiDocs Page]] [[Category:Development]] [[Category:Server]]

Revision as of 06:49, 12 December 2009

Products > Server > Server development > Server setup

Introduction

In order to set up a running mb_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. (contact us)

An alternative option to the above is to install a 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:

  • 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.

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

Installation instructions

If you just want a running database, use the database setup instead.

If you meet the above requirements read the 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 IRC channel and/or post questions to the developers mailing list and we will attempt to help you out if you get stuck.

Don't be discouraged by the steep learning curve

We realize that this is a stiff set of requirements to get started, but please don't let this discourage you. The 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 page so see how you can contribute.

Related HowTo's

  • Lucene server setup - if you want to setup your own search server instead of having to query search.musicbrainz.org.
Retrieved from "https://wiki.musicbrainz.org/index.php?title=MusicBrainz_Server/Setup&oldid=32854"