MusicBrainz Server/Setup: Difference between revisions
RobertKaye (talk | contribs) 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) |
||
(99 intermediate revisions by 22 users not shown) | |||
Line 1: | Line 1: | ||
== Setup from Docker Compose == |
|||
<small>[[Products]] > [[MusicBrainz Server]] > Server Setup</small> |
|||
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. |
|||
== Next Generation MusicBrainz Server (2011 onward) == |
|||
It can be used to: |
|||
This page gives instructions for setting up the old Mason based MusicBrainz server in use from 2000 until 2011. For information on setting up a new [[Next Generation Schema]] MusicBrainz server, please see [[NGS Server Setup]]. |
|||
* Replicate the MusicBrainz website/web service/database, |
|||
* Test your own app that queries MusicBrainz web service, |
|||
⚫ | |||
See [https://github.com/metabrainz/musicbrainz-docker MusicBrainz Docker] and its [https://github.com/metabrainz/musicbrainz-docker/releases release notes]. |
|||
⚫ | |||
== Setup from source code == |
|||
The [[MusicBrainz Server]] is not available as an executable application. Setting up the server will require you to checkout the <code>mb_server</code> code from Subversion and manually follow the INSTALL file's directions. |
|||
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: |
|||
You can browse the <code>mb_server</code> Subversion repository directly using the [http://bugs.musicbrainz.org/browser/mb_server/branches/RELEASE_20090524-BRANCH source browser]. |
|||
git clone --recursive https://github.com/metabrainz/musicbrainz-server.git musicbrainz-server |
|||
cd musicbrainz-server |
|||
And follow the instructions in the [https://github.com/metabrainz/musicbrainz-server/blob/master/INSTALL.md INSTALL] file. |
|||
== |
=== Support === |
||
# If you are a MusicBrainz developer follow [http://git.musicbrainz.org/gitweb/?p=musicbrainz-server/core.git;a=blob;f=INSTALL;hb=HEAD INSTALL] from our [[Git]] repository ''(potentially unstable)''. |
|||
# For everyone else, follow [http://bugs.musicbrainz.org/browser/mb_server/branches/RELEASE_20090524-BRANCH/INSTALL INSTALL] from our 20090524 release branch ''(latest stable release)''. |
|||
# If you just want a running database (i.e. 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>, use the <code>search_server</code> [http://bugs.musicbrainz.org/browser/search_server/trunk/README README]. |
|||
⚫ | 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. |
||
An alternate option is to install a [[Virtual MusicBrainz Server|virtual MusicBrainz server]]. The virtual image comes fully configured with a Linux environment and the latest stable release of the <code>mb_server</code> source code. |
|||
⚫ | The |
||
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. |
||
* |
* 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 [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: |
||
* |
* 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 |
|||
The <code>mb_server</code> is licensed under the [http://www.gnu.org/copyleft/gpl.html GPL (Gnu Public License)]. |
|||
** 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
- MusicBrainz Server on GitHub
- List of MusicBrainz Server updates on the MetaBrainz blog
- List of supplemental instructions on the MetaBrainz blog
- MusicBrainz Docker on GitHub
- List of MusicBrainzB Virtual Machine releases on the MetaBrainz blog
- List of MusicBrainz Docker releases on GitHub