summaryrefslogtreecommitdiffstats
path: root/docs/README
blob: d9847ad8f0b9beb5853cc77d5c96a462c073a580 (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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
-------------------------------------------------------------------------------
---------                    README - Ampache v.3.4                 -----------
-------------------------------------------------------------------------------

Contents:
 
 1. Intro
     a) Supported File-Types
     b) Supported Stream Methods
     c) Current Translations
     d) Thanx
 2. Getting all the components
 3. Setting Up
     a) Upgrading
 4. License
 5. Contact info

1. Intro:

  Ampache is a PHP-based interface to a MySQL database 
  where information about your audio files are stored.  The songs 
  are streamed using PHP; older versions required mod_mp3 but this
  version no longer does.  The songs are cataloged via PHP
  scripts.

  These tools are heavily dependent on quality tags in your audio
  files and or the file system organization. If you've kept them 
  up-to-date or organized this is the tool for you.  
  
  See CHANGELOG for version information.

  A) Supported File-Types

     Ampache currently supports the following audio file types. If
     you would like ampache to support an additional file type please
     contact us on irc, or the forums and we will investigate adding 
     them. Thanks

     	- MP3 (id3v1 && id3v2)
	- OGG
	- WMA/ASF
	- FLAC
	- RM
	- AAC/M4A/MP4
	- MPC
	- WV
	- SHN
	- APE
	- SPX

  B) Supported Stream Methods

     Ampache currently supports the following different methods for
     streaming your audio files. Please contact us if you would like
     to see additional methods. 

	- Single Stream 
		- extended m3u
		- simple m3u
		- standard pls
		- ASX
		- RAM
		- XSPF
	- Realtime Downsampled
	- XSPF Based Flash Player
	- Automatic Downsampling based on load
	- Local/Remote network definition based downsampling
	- On the Fly Transcoding
	- Localplay
		- Music Player Daemon (MPD)
		- Winamp using (HTTPQ)
	- Democratic Vote based play
	- 3rd Party clients using API (Amarok)
	
  C) Current Translations

     Ampache is currently translated into the following languages. If
     you are interested in updating an existing translation or adding
     a new one please contact us at translation@ampache.org or see
     /locale/base/TRANSLATIONS for more instructions. 

     	- English	(en_US)
	- German	(de_DE)
	- Turkish	(tr_TR)
	- Spanish	(es_ES)
	- Dutch		(nl_NL)
	- Chinese	(zh_CN)
	- UK English	(en_GB)
	- Italian	(it_IT)
	- French	(fr_FR) 

  D) A Special Thanks:
     Thanx to those who've helped us make Ampache so useable:
	 Scott Kveton - Head Nacho, inventer of all that is Ampache
	 Robert Hopson - Libglue, Playlists, Ogg support.. and much more
	 Andy Morgan - Protagonist
	 RosenSama - Previous Developer
	 Ben Shields - Ampache Logo
	 Randall Ehren (Initial XML-RPC)
	 s1amson (lots of beta testing)
	 Caleb Crome (bug fixes and enhancements)
         Mike Payson 
         Jon Disnard 
         Adriaan Peters (numerous patches and bug fixes)
         Rob Kaandorp (time calculation fix)
         Ian Cote (MP3.php tweaks)
         Kurt Lieber (random fixes)
         Maan Bsat (random fixes)
         latka (from media.tangent.org site) for orphaned song ideas
	 Lamar Hansford (README/INSTALL improvements) & Upload
	 Lacy Morrow (Flash Player)
	 And many many more...

2. Getting all the components

  Apache >= 1.3.x http://www.apache.org OR other webserver
  PHP >= 5.1.x http://www.php.net
  	PHP5-Mysql
	PHP5-Session
	PHP5-gd (recommended)
	PHP5 ICONV 
	PHP5 ZLIB support (recommended)
  MySQL >= 4.1+ http://www.mysql.com

3. Setting Up

  Ampache:
    If you're upgrading from 3.0 to 3.1 you will not be able to re-use
    your database or config.php files.  You will need to follow the entire 
    Ampache install guidelines oultined in the INSTALL file.  

3a. Upgrading Your Ampache Install

  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. All database updates
  will be handled by the /update.php script. There is no need to insert
  the /sql/ampache.sql if you have an existing installation.

4. License

  This Application falls under the Standard GPL v2. See Licence 
  included with this tar file

5. Contact Info

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

  Public SVN: https://svn.ampache.org/
  IRC: irc.ampache.org #ampache (Freenode)
  Forums: http://ampache.org/forums
  Bugs: http://trac.ampache.org/
  Wiki: http://trac.ampache.org/wiki
  Demo: http://ampache.org/demo

  Ampache Development Team
  vollmer@ampache.org