summaryrefslogtreecommitdiffstats
path: root/README.md
blob: a42173dcc79ab1428df0cbe3fea66ab5a348a250 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
Ampache
=======

Basics
------

Ampache is a web based audio/video streaming application and file
manager allowing you to access your music & videos from anywhere,
using almost any internet enabled device.

Ampache's usefulness is heavily dependent on being able to extract
correct metadata from embedded tags in your files and/or the filename.
Ampache is not a media organiser; it is meant to be a tool which
presents an already organised collection in a useful way. It assumes
that you know best how to manage your files and are capable of
choosing a suitable method for doing so.

Recommended Version
-------------------

Currently, the recommended version is [git HEAD](https://github.com/ampache/ampache/archive/master.tar.gz).

Requirements
------------

* A web server. All of the following have been used, though Apache
receives the most testing:
    * Apache
    * lighttpd
    * nginx
    * IIS

* PHP 5.3 or greater.

* PHP modules:
    * PDO
    * PDO_MYSQL
    * hash
    * session
    * json

* MySQL 5.x

Installation
------------

Please see [the wiki](https://github.com/ampache/ampache/wiki/Installation)

Upgrading
---------

If you are upgrading from an older version of Ampache we recommend
moving the old directory out of the way, extracting the new copy in
its place and then copying the old config file into config/. All
database updates will be handled by Ampache.

License
-------

Ampache is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License v2
as published by the Free Software Foundation.

Ampache includes some external modules that carry their own licensing.

* [getID3()](http://getid3.sourceforge.net/): GPL v2
* [Horde_Browser](http://www.horde.org/): LGPL v2.1
* [PHP-gettext](https://launchpad.net/php-gettext): GPL v2
* php_musicbrainz: LGPL v2.1
* PHP MPD interface: GPL v2
* [PHPMailer](https://github.com/PHPMailer/PHPMailer): LGPL v2.1
* [Prototype](http://www.prototypejs.org/): MIT
* [Snoopy](http://snoopy.sourceforge.net/): LGPL v2.1
* [Whatever:hover](http://www.xs4all.nl/~peterned): LGPL v2.1
* [xbmc-php-rpc](https://github.com/karlrixon/xbmc-php-rpc): GPL v3

Translations
------------

Ampache is currently translated (at least partially) into the
following languages. If you are interested in updating an existing
translation or adding a new one please see /locale/base/TRANSLATIONS
for more instructions.

* English	(en_US)
* German	(de_DE)
* Spanish	(es_ES)
* Dutch		(nl_NL)
* Norwegian	(nb_NO)
* UK English	(en_GB)
* Italian	(it_IT)
* French	(fr_FR)
* Swedish	(sv_SE)
* Japanese	(ja_JP) 
* Catalan	(ca_ES)
* Russian	(ru_RU)
* Czech (cs_CZ)

Credits
-------

Thanks to all those who have helped make Ampache awesome:

* Scott Kveton: Original creator of Ampache, 2001 - 2003
* Robert Hopson
* Andy Morgan
* RosenSama
* latka
* Lamar Hansford
* Lacy Morrow
* Karl Vollmer (vollmerk)
* Paul Arthur MacIain (flowerysong)
* Chris Slamar (cslamar)
* Holger Brunn
* Kevin Purdy (purdyk)
* Charlie Smotherman (porthose)


Contact Us
----------

Hate it? Love it? Let us know. Also let us know if you think of any
more features, encounter bugs, etc.

* [Public Repository](http://github.com/ampache)
* IRC: chat.freenode.net #ampache
* [Issue Tracker](https://github.com/ampache/ampache/issues)
* [Documentation](https://github.com/ampache/ampache/wiki)