diff options
Diffstat (limited to 'docs')
| -rwxr-xr-x | docs/CHANGELOG | 771 | ||||
| -rwxr-xr-x | docs/GPL-LICENSE | 280 | ||||
| -rwxr-xr-x | docs/INSTALL | 189 | ||||
| -rw-r--r-- | docs/INSTALL.de | 252 | ||||
| -rwxr-xr-x | docs/MIGRATION | 39 | ||||
| -rw-r--r-- | docs/MIGRATION.de | 31 | ||||
| -rwxr-xr-x | docs/README | 149 | ||||
| -rw-r--r-- | docs/README.de | 114 |
8 files changed, 1825 insertions, 0 deletions
diff --git a/docs/CHANGELOG b/docs/CHANGELOG new file mode 100755 index 00000000..e0c00ac6 --- /dev/null +++ b/docs/CHANGELOG @@ -0,0 +1,771 @@ +-------------------------------------------------------------------------- +--------- Ampache -- CHANGELOG --------- +-------------------------------------------------------------------------- + +-------------------------------------------------------------------------- + v.3.3.1: + - Fixed hardcoded HTTP reference in list_header.inc + (Thx hongyi_gao) + - Fixed refresh javascript for main page. + - Fixed <html lang=> tag so that it validates (Thx XGizzmo) + + +-------------------------------------------------------------------------- + v.3.3.1-Beta2 05/22/2005: + - Included new Greyblock Theme (Thx Shieldb) + - Fixed playlists if use_auth == FALSE + - Tweaked CSS classing in an attempt to improve themeing. This + breaks all previous themes. (Thx mkeadle) + - Fixed problem with Color Boxes in IE (Thx rperkins) + - Tweaked the Main page adding most popular albums as well as + spliting out the mpd control and now playing. + (Thx Nedko and reflous) + - Fixed a problem with directories named '0' (Thx Protagonist) + - Fixed lack of seeding of RAND() which would cause Pre PHP 4.2 + to not really have random playlists. + - Fixed a bug where guests could change their own password and + control MPD + - Fixed a ton of class formating inconsistencies as well as tweaked + a few tables. (Thx Rperkins) + - Fixed some consistency issues with where the A-Z listing was + between Albums and Artists, Added Bolding of currently + selected Letter/Number (Thx Rperkins) + - Fixed a problem with the admin preferences where the theme + colors wouldn't reset, if the target theme is the current + one of the user setting it (Thx Nedko) + - Fixed a problem with the CHARSET not being passed correctly + (Thx Nedko) + + +-------------------------------------------------------------------------- + v.3.3.1-Beta1 05/01/2005: + - Added Random Play for Playlists + - Added Per User config option to set ellipse thresholds as well + as some index.php tweaks (Thx Nedko) + - Added support for SPX files. + - Fixed a problem that occurred when a userfield contained a single + quote (username,fullname etc) + - Turkish Translation, Charset iso-8859-9 added (Thx vireas) + - Flipped Actions on MPD Control, clicking on the title now skips + to the song, clicking on number removes it (Thx rastan) + - Tweaked Preferences look, adding color boxes showing the color + of the preference, and misc html/spelling fixes + (Thx Rperkins) + - Added Random On/Off to MPD controls and truncated songs with ... + (Thx Orion88) + - Added ability to pass a URL to MPD allowing it to be on a + different computer than the MP3's this also makes setup of + MPD a lot easier. + - Fixed Connected User Count. + - Fixed random HTML errors that caused custom themes to look wrong + + +-------------------------------------------------------------------------- + v.3.3.1-Alpha2 04/23/2005: + - Added ability to import M3U's as playlists on catalog build and + from the playlist screen, note the m3u must exist on the + server. Uploading from client is not working + - Fixed a bug that caused it always to generate a m3u file when + using downsampling + - Added support for .mpc files + - Added .htaccess and renamed all /bin files to .php.inc so that + the webserver, even if it ignores the .htaccess won't try + to run the scripts + - Fixed ampache.cfg and /docs references in /install.php + (Thx rperkins) + - Fixed a typo that caused ASX playlists to not be populated with + the user_id as they should (Thx weidercs) + - Fixed a problem where when creating a new user it wouldn't take + the values from "Admin Preferences" as it should. + - Fixed catalog toolbox so it uses the classes rather than a + hardcoded color + - Fixed Installer which still had ../ references (Thx fakenick) + - Fixed a few more ../ references + - Fixed redirect to update.php on login after you've already + done the update. (Thx Orion88) + - Fixed login.php so that it loads the theme that is set in the + admin preferences correctly + +-------------------------------------------------------------------------- + v.3.3.1-Alpha1 04/21/2005: + - Added Themeing Ability to Ampache, see /themes/classic for an + example of how to do it + - Added Burgundy Theme (Thx s1amson) + - Moved everything into / instead of /docs you should now be able + to extract ampache directly into your webroot and have it + work perfectly :-) + - Added Config file compare to test.php + - Added config values to control allowed playback methods + - Added SlimServer class *Not Finished + - Tweaked catalog "Total Time" so it's a little more consistent + (Thx Andy Morgan) + - Fixed playback problem with Windows Media Player caused by a + misplaced Partial-Content header entry. + - Renamed ampache.cfg --> ampache.cfg.php and added <?php exit(); ?> + to prevent display of config file in web interface. this is + the first step towards moving away from the /docs style + (Thx s1amson) + +-------------------------------------------------------------------------- + v.3.3 04/17/2005: + - Fixed seeking and lack of http headers during normal playback + (Thx Nikk) + - Fixed random play bug where it wouldn't return any songs due + to a malformed sql statement. (Thx J) + - Fixed a typo that caused the song format to be ignored by play.php + (Thx Nikk) + - Fixed lack of an error message if amazon album art was a search + method, but no developer key was specified + - Fixed the memory allocation code. + - Fixed a lack of status reporting during the album art searches + now prints out Searched 100. . . like all other catalog + functions. + - Added User Registration (Thx Terry) *Not Finished! + - Fixed problem where an error would occur if only one album + art gathering method was selected. + - Fixed problem where it would continue to search for album art + when updating multiple songs from the same album where art + has already been found. + - Added Debug Script for Amazon Album Art search (in /bin) + - Cleaned up some dirty HTML, and redudant functions + - Fixed lack of redirect to the Install page if no config file is + found + - Fixed login page so it respects the values set in the database + for background color etc + - Fixed lack of cookie deletion on logout, and lack of session + removal... + - Added forced Garbage Collection at least 20% of the time. + - Fixed Installation Script, admin/changeme is no longer the + default username/password. Installation script creates + initial admin user + - Fixed html, and lack of web_path definitions on the account + page, also spruced up the look a little bit + - Switched all short tags to long tags (<? --> <?php) + - Fixed preferences so that it doesn't display an input field + if you don't have access to change said preference + - Fixed album art saying it's found when it really wasn't + - Fixed problem where changes to preferences weren't respected + if use_auth = false + - Fixed download, and direct link, both were not respecting + the song->type + - Tweaked m3u generation removing the \ before the filename to + prevent mp3blaster from failing (Thx Rubin) + - Added command line script /bin/compare_config looks at + ampache.cfg.dist and compares it to the ampache.cfg looking + for missing config values. + - Tweaked db update check so it does it on every page load, rather + than just on login.php (so use_auth=no gets checked) + - Fixed problem with user create and user edit where it wasn't doing + any really good error checking, or notifying you when it + failed to update/create + - Tweaked now playing in an attempt to allivate some now playing + floods that people were seeing + +-------------------------------------------------------------------------- + v.3.3-Beta4 03/27/2005: + - Added Batch Download functions (Thx RosenSama) + - Tweaked Main Page format (Thx Nedko Arnaudov) + - Added Full Album/Full Artist option to Random Play + - Fixed Amazon Album Art gathering, changed from SOAP + method to REST method, now works with PHP5 and PHP4! + - Fixed problem with ' being escaped one to many times in a + playlist name + - Tweaked MPD play so it uses the playlist_type and is accessed + by simply selecting the "Play" action + + +-------------------------------------------------------------------------- + v.3.3-Beta3 03/17/2005: + - Fixed a problem with the preferences and display of the logout + button and inability to edit/disable songs/playlists when + use_auth = no + - Added volume controls to local play (Thx Vlad) + - Fixed a problem of importing comments from mp3 files (Thx Cucumber) + - Fixed a typo that caused the account you were logged in as to be + deleted rather then the account you wanted to delete. + - Added pulling missing song info from filename based upon the catalogs + file patterns. + - Improved error logging and handling. + - Added album art dump from database to file system (Thx Cucumber) + - Added show albums with no art on Albums browse page (Thx Cucumber) + - Fixed a problem where Localplay wouldn't return to index as it + should (Thx Jason) + - Added Installation Script (/install.php) + - Fixed lack of an sql_escape on comment which could break inserts + if comment contained " or ' + - Added default log_path and better error message if unable to write + to the file + - Removed _SERVER['PHP_SELF'] reference on alphabet function due + to the fact it doesn't always get passed. + - Removed old setup.php in favor of new install.php + - Upgraded Moosic from 1.2.5 --> 1.5.1 which fixes some playback + issues (Thx soloport) + - Added Prev button to localplay and send the song name to the player + rather than simply song.mp3 (Thx jason) + - Added Customizable Stream Format, see config (Thx Cucumber) + - Added sort by Year on album page. + - Fixed some minor issues with the XMLRPC code. + - Fixed typo in style-sheet (Thx Nedko Arnaudov) + - Added cleaned up favicon (Thx Nedko Arnaudov) + - Added paging and sort by username/fullname & last_seen on + admin user page + - Fixed issue with non-us chr when truncating using ... on + global popular and album/artist views (Thx Nedko Arnaudov) + - Fixed importing of non-us chr from OGG files (Thx Nedko Arnaudov) + - Fixed an issue were duplicate headers would be sent during + downsampling, also remove extra db connection in play/index.php + - Fixed problem where now playing wouldn't show a username if use_auth + was disabled + - Fixed a problem which prevented you from updating a user + - Fixed an error in the logic that caused all art methods to be + searched regardless of config settings + - Added ASX playlists (Thx Samir Kuthiala) + - Added check for Iconv in /test.php + +-------------------------------------------------------------------------- + v.3.3-Beta2 02/09/2005: + - Added config option for site charset defaults to iso-8859-1 + (Thx Nedko Arnaudov) + - Fixed unhandled soapclient errors with PHP5 - Note Amazon + album art search still doesn't work. It just doesn't + return an error. + - Fixed problem with winamp playback on .oggs + - Added "Remember Me" button that overrides local length setting + and sets a 1 year cookie + - Added new RSS page (Thx Speedy B) + - Changed how preferences are handled once again. In the process + fixed numerous bugs with preferences. + - Added Apply To All in admin preferences, letting a full admin + reset a specific pref for all users at once. + - Update Catalog no longer overwrites changes made in the interface + - Added MPD patch (Thx RosenSama) + - Suppress Error in /docs/play/index.php if fopen fails + - Fixed Random playback, it is now actually a random number of songs + in a random order from said artist/album + - Fixed Comment not getting set during song flag (Thx RosenSama) + - Added gimped support for m4a (ITunes) files, Genre and Track # + aren't imported due to getid3() limitations + - Fixed some XML-RPC issues that cropped up with newer versions + of PHP + - Improved fix for Mysql 4.1 PASSWORD function, should always + work now. + - Added basic logging functions (for debug) + - Fixed downsample so it actually looks at the ampache.cfg for the + command to run instead of being hardcoded in + - Added ability to set preferred filename for folder album art search + along with ability to set order of search methods (Thx Mike) + - Started tweaking MPD patch so that it can be accessed as a + play type + + +-------------------------------------------------------------------------- + v.3.3-Beta1 12/26/2004: + - Fixed problem with download not detecting mime types and not seeing + true/false value of preference + - Added Patch from Shine with a _ton_ of gettext updates and an almost + complete German translation! + - Fixed automatic detection of server port (Thx Corsin) + - Fixed missing prefix on Albums by Artist page (Thx ianneub) + - Removed a large chunk of unneeded code from Main page + - Fixed some preferences problems which were allowing users to define + download/upload etc + - Fixed Upload functions created by Lamar to account for other changes + I've made to ampache, upload now shows up in menu bar + if you have upload enabled + - Added CLI catalog_update.php file in /bin that updates all local + catalogs + - Updated nusoap library to newest version (12/15/2004) + - Fixed upload, now requires a readable upload dir before even attempting + to upload, and correctly inserts/quarantines files + - Fixed a problem where the catalog clean wasn't removing files from + playlists when they were removed from the catalog + - Added 'pretty' count of songs checked during catalog clean + - Added simple m3u playlist format and fixed a small typo in the pls + playlists + - Added Direct Link that can be drug to winamp to "append" to + playlists (Thx jason) + - Fixed incorrect redirect on Disable/Enable of songs + - Fixed login problems due to change in HASH style with Mysql 4.1 + - Fixed Albums with multiple artist giving incorrect song count and showing + single artist, rather than "Various" + +-------------------------------------------------------------------------- + v.3.3-Alpha3.1 11/29/2004: + - Fixed two typo's in /docs/playlist.php (Thx smichaelis) + - Added a or die to the table drop in /update.php to prevent silent + failure of update. + - Added check for session support on /test.php + +-------------------------------------------------------------------------- + v.3.3-Alpha3 11/28/2004: + - Fixed duplicate web_path entry in preferences (Thx KlaasVaag) + - Fixed some problems with the flagging single quotes and genre + should now work (Thx Cocobu) + - Added WMA support (Thx Ldary) + - Added new Getid3 version + - Fixed typo that prevented play selected on artist page from + working (Thx tPassive) + - Added WMA Album Art support... maybe + - Fixed problem with [Prev] & [Next] wrapping to a new line + - Added filename used for songs with no title + - Fixed ability to disable last account, or remove last admin account + - Added year to "Albums" view + - Fixed inability to delete playlists + - Fixed a problem introduced while cleaning up /lib/album.php + - Added new Stream class to make adding play types easier + - Added correct PLS file support. Set via a config option + - Added Favicon (Thx Rubin) + - Added German README/INSTALL/MIGRATION/ampache.cfg.dist (Thx phil) + - Added French Translation (Thx Cocobu) + - Removed defunct "findfile" script that was completely broken + - Added 1000 songs & All to random play (Thx clouser) + - Added Folder based search for any .jpg or .gif as album art only + works on catalog update & build (Thx dromio && roark) + - Added config options that define where ampache looks for art + - Fixed logic error on album art page, and redundant checks + - Fixed Non-Us CHR on ogg && id3v1 tags files importing incorrectly + - Fixed some web_path and prefix problems + - Fixed single quotes in folder names preventing the entire directory + from being indexed + - Added New Blank Album Image (Thx Aaron La'gere) + - Added Per Artist & Per Album Update From Tags + - Added GetText to albums.php, playlist.php, lib.php, index.php and + ui.php as well as new messages file. (Thx Shine) + - Added Album art shown on Now Playing (Thx Rubin/Shine) turned on by + setting play_album_art = "true" in ampache.cfg + - Fixed problem where flagged table wasn't getting cleared when you + deleted the song that it referenced + - Added "Guest" user level which can view, but not play or change + anything + - Added user_catalog table for future catalog access control, this + feature is not yet implemented. + - Added FLAC file support + +-------------------------------------------------------------------------- + v.3.3-Alpha2 11/08/2004: + - Improved error checking on Mysql connection it now redirects to + /test.php on failure rather than just throwing an error + - Added upload.php play/pupload.php & templates/show_upload.inc + for upload functionality (Thx Lamar!) + - Fixed a $dbh --> dbh() problem (Thx phil) + - Fixed the preferences requirement on update.php (Thx phil) + - Fixed "Fuzzy Counting" in the README file index. + - Fixed a typo in playlist that caused the header redirect + not to work + - Fixed setting of song->played value (Thx Mkeadle) + - Fixed Admin preferences for user 0 (what new users get) + - Added initial GetText, translation, support + - Added some of the initial French translation using to babblefish + - Fixed a problem with the album art clearing from the db correctly + - Added initial DE translation (Thx Phil) + - Fixed a problem with single-quotes in filenames breaking catalog + builds (Thx Naund) + - Added initial IceCast Support (Thx Thomas) + - Fixed incorrect naming of Local Play variable which caused it + not to work at all (Thx jpolansky) + - Added Valid Session Checking to play code that, if require_session + is set prevents anyone without a valid sid from playing music + - Added Album Year to Albums by Artist View and album table in db + +-------------------------------------------------------------------------- + v.3.3-Alpha1 10/04/2004: + - Fixed non-us chr showing up incorrectly + - Fixed session garbage collection + - Added check for function_exists iconv + - Added check for existence of mysql_query function to test.php + - Fixed a problem with verify single catalog (Thx Framercy) + - Reworked the Preferences, adding most of the non-critical + preferences from the config file and putting them into + the web interface + - Tweaked the DB to work with the new preferences + - Update.php now has a font size and bgcolor (defaults) + - Force short_tag = on in init.php + - Show Albums by Artist only checks DB for album art (faster) + - Added View Full Album Art (click on art on single album page) + - Removed dead code from /modules/lib.php + - Tweaked Personal Stats page. Moved out of lib.php into user + functions and cleaned them up a bit + - Removed extra , from Mail function and fixed From address + http://bugs.ampache.org/bug_update_page.php?bug_id=1 + - Fast Update on Update Catalog function has some "Fuzzy" logic + - If Fast Update isn't checked, Update Catalog looks for album art + in the id3 tags + - Update Catalog now has "Checked 100...." messages like the + add to catalog function + - Added check for soapclient class already existing. (Thx Hopson) + - Tweaked Album Art on Albums by Artist Page (Thx clader) + - Added Play Random & Play All links to Albums By Artist Page + - Removed extra queries from Albumart.php + - Fixed Playlist Delete (Thx kellin) + - use_auth = "no" works as advertised + - Ability to import Album Art on catalog build from id3v2 tags + +-------------------------------------------------------------------------- + v.3.2 08/11/2004: + - Fixed XMLRPC duplicate function problems + - Fixed getid3() issues by manually setting memory limit for php + if current setting is below 16M + - Suppressed errors that occurred when PHP-GD tried to read a gif + image. + - Added auto refresh of index.php (Thx vireas) + - Fixed a problem where saying no to a user delete deleted it + anyway. (Thx Dogsbody) + - Fixed a problem with admins updating users preferences + - Removed Edit button from delete confirmation for playlists + - Improved /test.php a tiny bit + +-------------------------------------------------------------------------- + v.3.2-Beta2 07/12/2004: + - Yet more improvements to album art code, now checks for 1x1 + images if you have GD installed (Thx mikej) + - Fixed a problem where \n or other whitespace would get into + album name + - Fixed catalog update destroying tags on ogg and rm files + - Added RSS feed page (thx speedyb) see /rss.php + - Fixed a problem with libglue that cropped up with 4.3.8 + - Added install.pl (initial release) + - Fixed last seen again.... + - Fixed up the test.php to it actually works correctly + - Added get album art from url Thx gwynnebaer + - Added config option to set default search type Thx gwynnebaer + - Tweaked headers to make them nicer with large numbers Thx gwynnebaer + - Tweaked preferences code so it works as advertised. + - Updated to GETID3() 1.7.1-b1 Woohooo! + +-------------------------------------------------------------------------- + v.3.2-Beta1 07/02/2004: + - Tweaked getid3 library in an attempt to prevent non-fatal + foreach error + - Replaced "no album art" image (thx Gargamale) + - Last Seen now actually works, can be viewed on the user + screen in the admin section + - Fixed a Artist catalog problem introduced with the new + getid3 library + - Now takes into account https vs http using _SERVER['https'] + variable + - Added force_http_play which ignores https and always forms the + urls in the m3u as http, default is on + - Added http_port in case your http server isn't running on port 80 + - Fixed a typo that caused clean_artist not to work with mysql 3.x + - Logical Random play query (Thx Famercry and mikepell) + - Updated the XMLRPC library and hopefully improved it a little :) + - Improved Ampache.pm no longer requires secrets file and automatically + find path information (ignore errors :P) + - Added rename_all & sort_all to fileupdate.pl in /bin + - Fixed a problem where play_type == 'local_play' wouldn't actually + do anything + - Added sweet new album art code from MikeJ that searches Amazon + (Requires Developer Key, see config file) + - Applied some fixes to the album art (Thx gwynnebaer!) + - Added MOTD on the login page (see README) + - Fixed another seek problem (Thx gwynnebaer) + + +-------------------------------------------------------------------------- + v.3.2-Alpha3 06/13/2004: + - Added last_seen to user table now tracks when they last + visited ampache + - Changed the preferences table to key,value pairs makes it + easier to add new preferences without having to update + the database again + - Put in initial down-sampling work + - Updated Ampache.pm and fileupdate.pl (Thanks Matt Shaffer and Nikk) + - Fixed a problem with the play count when you tried to seek + a file. + - Made the single album view a little nicer looking + - Added "Reset Album Art" action that removes the album art from the + database and re-querys the mp3s + - You can now select multiple genres when using Play Random + - Changed default action for albums/artists to browse per Alphi's + recommendation. + - Fixed a bug introduced into the config file. + - Finally fixed web_path so that you only need to define the path + to ampache (ie /music) rather than the full URL such as + http://localhost/music. + - Added another fix so that it takes into account the port when + logging in (was ignoring it before) Thx DogsBody + - Fixed a playback problem where song would reset after the + php max execution time Thx Nicolas Savoret + - Fix for some web_path vs web_host problems Thx Nick Wilson + - Fixed it so that disabling a user actually works now + - Playback now pays attention to disabled status and make sure + uid ends up being a valid user + - Reworked preferences, adding play_type in place of multi-cast + down-sample and local_play + - Down-sampling should now work if play_type is set to down-sample + and you do a little manual configuration + - Tweaked filename passed to players so that oggs work a little + better - Thx Dale Cooper and Gwynnebaer. + - Upgrade to newest GetID3 library - Thx Gwynnebaer! + - Initial support for RM files (Not Tested) + +-------------------------------------------------------------------------- + v.3.2-Alpha2.1 04/27/2004: + - Fixed a problem with the user functions which was handling + passwords in a _very_ bad way. + - Updated the title tag on now_playing + +-------------------------------------------------------------------------- + v.3.2-Alpha2 04/24/2004: + - Put Prefix back in Artist name + - Fixed Text echoed out during a catalog update, and made the + catalog update actually work! + - Fixed Prefix problems on album view and simplified the code + for displaying albums. + - Albums by Artist page now shows all of the Album art. (Thx MrBlahh) + - New Blank Album Image + - Weighted Random Play (Thx Mikepell) + - Fixed a the removal of disabled songs. + - Cleaned up and fixed basic user functions + - Reorganized the Main Page moving recently added albums/artists + on to the front page. + - Fixed Catalog Functions so that it removes old stats when + you clean/update/delete. + - Updated Database getting ready for XML-RPC + - Reintroduced Access Lists allowing for XML-RPC permissions + and stream/download permissions + - Added XML-RPC code back in (Experimental & DANGEROUS!!) + must be turned on in ampache.cfg + - Moved Config File to $ampache/config from $ampache/modules + makes more sense there.... + - First step towards quick time playback capabilities (Thx Nick) + - Fixed a problem with catalog genre names that put an extra + slash in genres with " or '. + - Added Clear Now Playing under catalog tools in case you get some + funky data stuck in the now playing queue. + - Fixed user deletion. Preferences and stats were being left behind + - Hopefully fixed Album/Artist/Song Cleaning so that it works with + Mysql 3.23 (We were using 4.0+ sql syntax) + - Updated Now Playing to show album link and shortened song title + if needed + - User functions should always return to the user page when done. + +-------------------------------------------------------------------------- + v.3.2-Alpha1 03/23/2004: + - Added Now Playing + - Updated the migration tool (update.php) + - Added ability to turn on/off ability to download songs + - First step towards upload capabilities + - Early version of "Local Play" + - Per User preferences + - "Legalize" option that only allows one copy of a song to be played + at any one time. + - Fixes for popular songs being incorrectly reported. + - Fixes to Play All Songs by Artist/Album + - Improvements to playlists. + - Many other minor bug fixes + +-------------------------------------------------------------------------- + v.3.1.3 01/11/2004: + - Fixed a link problem on the logout page + - Fixed Full Album not being displayed in the title tag on show_songs + - Doesn't try to show album art for Unknown Albums + - Fixed a config problem introduced in 3.1.2 + - Stops looking for album art after finding a single one (reduces load) + + +-------------------------------------------------------------------------- + v.3.1.2 12/30/2003: + - Fixed Single Song Per Album bug if the album title contained + a single-quote + - Fixed problems with quotes, and special chr in id3 tags + - Fixed a few html problems + - New version of Getid3() see www.getid3.org + - Fixed Connected user count looking incorrect + - Cleaned up HTML in show_songs. + - Now returns an error if adding a user fails + - Fixed Stat Clean and Catalog Delete still happening even if you + clicked no + - Removed Clean All Catalogs and Access link because those + features are currently broken + +-------------------------------------------------------------------------- + v.3.1.1 12/26/2003: + - Fixed a problem with the clean catalog function not actually + working correctly, also added a check-box to auto delete + dead songs + - Fixed a problem with readconfig not working on windows + - Fixed a problem where dead songs would get added to a playlist + - Added a missing break in the case function of admin/catalog.php + - Removed preferences tab because it doesn't actually work + - Made Catalog Update not display errors if it can't find the file + - Catalog Update should no longer time out + - Added in some escaping for single quotes in some extra id3 + fields + +-------------------------------------------------------------------------- + v.3.1, 12/23/2003: + - Fixed problem with quick search on artist only allowing 1 chr + - Fixed broken image on albums with no art + - General HTML cleanup + - Changed link name to "Play" from m3u + - Ordered genre pull down by name rather than ID + - Make it not look for album art if it wasn't viewing an album + - Removed random play stuff from album page + +-------------------------------------------------------------------------- + v.3.1-Beta2, 12/16/2003: + - Fixed double http:// in a few places (Thx Lamar) + - Typo in Form variable (Thx Lamar) + - Album Playlist Fixes (Thx Lamar) + - Added trailing slash to admin links (Thx MrBlahh) + - Removed from register globals requirements + +-------------------------------------------------------------------------- + v.3.1-Beta1, 12/10/2003: + - Completed support for OGG files (Thx Hopson for original code) + - Fixed Viewing Albums + - Addtype no longer required in apache config. Headers + are now passed in that delicate grey zone where all the + browsers we can find seem to work.. (Thx Rubin) + - Fixed it so that you no longer have to edit init.php (Thx Rubin) + - Added view all songs from this artist + - Hopefully fixed libglue once and for all... + +-------------------------------------------------------------------------- + v.3.1-Alpha5, 11/29/2003: + - Added Duplicate song checker to catalog tools (Thx Alphi) + - Fixed missing Genre check when updating id3 tags + - Added Disable Option for Admins when showing songs + - Removed some un-needed files + - Fixed 'Fuzzy' Math in list_header (Thx Andy) + - Fixed stats on the main page (Thx Andy) + - General Code Cleanup (Thx Andy) + - Fixed double login problem + +-------------------------------------------------------------------------- + v.3.1-Alpha4, 11/27/2003: + - Yet more search options + - Fixed a few more admin tool issues + - Added a play via Genre + Catalog (Thx Rubin) + - Fixed Random Play (Rubin) + - Fixed catalog so that if file exists but isn't readable + it doesn't add it to the catalog empty (Thx Andy Morgan) + - Fixed update.php to check what version of the db is being run + and update accordingly (Rubin) + - Added bare bones for Album Art support from the mp3 files (Rubin) + - Fixed Play Selected from Albums/Artists + +-------------------------------------------------------------------------- + v.3.1-Alpha3, 11/25/2003: + - Fixed some installation problems + - Added a few new search options + - Fixed catalog delete, and other misc link problems + - Added migration tools (Thx Andy Morgan) + - Re-worked Genre + +-------------------------------------------------------------------------- + v.3.1-Alpha2, 11/24/2003: + - Start of complete re-write of ampache code + - Fixed register globals problem, should no longer be required to be on + - Added ID3V2 tag support + - Improved playlists, added track var + - New Looks and feel thanks to Ben Shields + - Completely rebuilt cataloging again... + - Fixed orphaned files + +========================================================================== + v.3.0, 04/05/2002: + - Added Randall Ehren to the "Ampache Development Team" :-) + - Completely rebuilt catalog mechanism + - Remote catalog updates via XML-RPC + - Fixed orphaned file interface + - New tools to update ID3 tags easier + - Changed admin interface to be easier to use + - Many bug fixes + +-------------------------------------------------------------------------- + v.2.5, 03/04/2002: + - Bug fixes and code cleanup + - Final mod_mp3 only version + + v.2.0, 02/05/2002: + - Added stats page to clean up "Home" + - Made default album/artist view start with match=A + - Cleaned up admin/users interface to show who's logged on + - Added ability to anonymously mail all users via admin + +-------------------------------------------------------------------------- + v.2.0rc2, 01/18/2002: + - Fixed update catalog tools to remove songs that have changed + - Added support for the mod_mp3 MySQL dispatch -> you no longer need + to restart apache for new songs + - Minor interface fixes (spelling, wording, etc) + - Added per-user statistics + - Made album/artist views easier to digest + +-------------------------------------------------------------------------- + v.1.21, 07/29/2001: + - Minor bug fixes from various users (see readme) + - Updated Album and Artist views + - Added play all songs from artist and randomize songs from artist + +-------------------------------------------------------------------------- + v.2.0rc1, 01/10/2002: + - User/session management for admin + - fix 'Greatest Hits' problem + - Wrote setup.php for initial setup of server + - Reworked administration pages + - Per user profile settings/updates + - Playlists stored per user + - Private/Public playlists + - Show most popular songs/artist + - Added play.php wrapper to track song play + - Added stats for number of times played for artist/album/song + - Add demo mode + - Tweak album view to show artist as well + - Change format/view of "Home" page + - show songs for an artist on album page + - fixed single song play + - select all feature for song view + - greatly enhanced search result capabilities + - Show how many users connected + +--------------------------------------------------------------------------- + v.1.20, 07/22/2001: + - Lots and Lots of bug fixes + - Replaced mp3.php class with Sandy McArthur, Jr's id3 class + - Song editor -> update DB and/or song file -> integrate with orphan files + - Add genre support and allow genre playback and stats + - Add track support ... now should order in album order + automatically if ID3v1.1 tags used + - ID3v1.1 support for writing/reading files + - Tweak filefind to make filename be name of orphaned songs + - Moved "Orphaned Files" into the admin section + +-------------------------------------------------------------------------- + v.1.10, 05/08/2001: + - PHP-only version now; can catalog all MP3's via PHP + - Tweaked perl script to not return SQL errors + - More interface tweaks to make site look purdy + +-------------------------------------------------------------------------- + v.1.07, 05/04/2001: + - Changed URL for mod_mp3 to media.tangent.org + - Tweaked interface even more and cleaned up build process even more. + +-------------------------------------------------------------------------- + v.1.06, 05/04/2001: + - Many more updates to the tools and interface. + +-------------------------------------------------------------------------- + v.1.04, 04/29/2001: + - Prettied up interface some more. + - Tweaked code for .pls support (added artist, album) + - Fixed filefind to work around .AppleDouble directories + +-------------------------------------------------------------------------- + v.1.03, 04/29/2001: + - All kinds of build changes. + - Added support for .pls + +-------------------------------------------------------------------------- + v.1.02, 04/29/2001: + - Minor build changes. + +-------------------------------------------------------------------------- + v.1.01, 04/29/2001: + - First version. +-------------------------------------------------------------------------- + + diff --git a/docs/GPL-LICENSE b/docs/GPL-LICENSE new file mode 100755 index 00000000..d65c21bb --- /dev/null +++ b/docs/GPL-LICENSE @@ -0,0 +1,280 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc. + 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Library General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) +^L +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + diff --git a/docs/INSTALL b/docs/INSTALL new file mode 100755 index 00000000..7efd24dc --- /dev/null +++ b/docs/INSTALL @@ -0,0 +1,189 @@ +------------------------------------------------------------------------------- +------------------ INSTALL - Ampache v.3.3 - 03/27/2005 ----------------------- +------------------------------------------------------------------------------- + + I'm assuming that you have Apache, PHP and MySQL running when you + get to this point. + + If you're upgrading from 3.0 to 3.1 please refer to the MIGRATION Notes. + Your database can't be re-used, but fear not the Ampache guys thoughtfully + included scripts to port the data from your old database to the new one. + (They get an extra beer for that one) + + If you're upgrading from 3.1 to a newer version refer to the MIGRATION Notes. + There should be an automated update script which will allow you to keep your + current database. + + If at any time during this install you can't figure out where you have gone + wrong check out /test.php for help. + + 1. Installing Using the Web Interface: + + As of 3.3-Beta3 Ampache includes an web based installation script. In order + for the script to work correctly you will need a user that has Database + create and modify rights for your mysql server. To use this script simply + visit /install.php. If you get a Access Denied make sure that your /config + directory does not contain an existing ampache.cfg + + Web Install: + Step 1 - Inserting the database, this requires you to enter + a username/pass for MySQL that is able to create + a brand new database and insert new tables. This does + not have to be the user you actually run ampache as + Step 2 - Creating the Config file, this step asks for a 'user' + level account for MySQL that has full access over + the newly created ampache database, this can be the + same as the last step, but it is not recommended. + Ampache will attempt to write the config file directly + to the /config directory, if it isn't able to it + should prompt you to download the ampache.cfg simply + put it into /config and then visit the login page. + Step 3 - Creating the Initial User Account, you will be asked + for a username and password for the administrator + account. + + Enjoy! If you have any problems with the web installer please report them + to vollmerk@ampache.org Thanks! + + + 2. The Long of Setting Up Ampache + + 2.1 Configuring Apache Server + There are really two choices here. You can either configure a virtual + server for the ampache services, or you can just configure a new directory + directive for ampache. There are advantages and disadvantages for both. + + If you configure a new virtual server, it has it's own log files which + could be useful for separating the ampache web traffic from the regular + web server traffic. + + If you configure a new directory directive for ampache, the ampache + statistics will be in with all the other web traffic, but it may be a + little easier (but not by much). + + We've included cronolog lines. These are not required, but for + troubleshooting we recommend them. + + for a separate virtual server httpd.conf reads: + + [snip] + + <VirtualHost 192.168.100.2:80> + ServerName tunes.ampache.org + + ServerAdmin webmaster@ampache.org + DocumentRoot /data/www/ampache + + DirectoryIndex index.php + + </VirtualHost> + + [snip] + + Now perform an 'apache restart' and apache should be configured. + + 2.2 Configuring Your MySQL Server + Setup a user and pass for your music db and create the music db. + + Run: 'mysql -u user -p musicdb < sql/ampache.sql' + to create the music db and tables. + + 2.3 Configuring Ampache + + 2.3.1 Configuring motd.php + + Copy config/motd.php.dist to config/motd.php + + Edit this file however you like, with either php code or straight html. + The output will be displayed below the login box on login.php. + + + 3. Running Ampache For The First Time + + Point your browser at your new ampache webpage and you should get + the installation page. It will run you through inserting your + database, creating your config file and setting up your first user + + Grab A Beer.... + + 3.1 Setting up a catalog + First, create your local catalogs. Do this my first clicking + `Add a catalog', and entering the path for the root of your + collection of MP3 files. There is no need to enter sub directories + since the update tool will recursively catalog all subdirectories. + + You can enter multiple paths, so this means that you can access + multiple directories, and hence multiple hard disks. I solved this + particular problem by patching the kernel to include logical volume + management, but that's a completely different story. + + 3.2 Updating your Catalog + If everything went correctly, you are now looking at an empty ampache. + In order to populate the database with all the tag information from + your MP3 files, you'll need to go to the `Admin' page, and select + the `Catalog' link. + + Finally, you want to click the `Update All Catalogs' button in the + middle of the Catalog page and go for coffee (or any other beverages + you like) as this will take a little bit of time. The web server + is now searching for and opening each of the MP3 files in your + collection, pulling the ID3 tag data out, and using these to populate + your ampache database. + + Final Note on MP3 Tags: + Since you the value of ampache is directly related to the data in the + database, and this data is obtained from the ID3 tags in your MP3 files, + it really pays to have all your tags populated and in order. + + One of the best tools that I've run across to do this is: + EasyTAG - Tag editor for MP3 and OGG files + http://easytag.sourceforge.net + + It runs right on the Linux machine, and is quite a bit faster at updating + tags than any PC based programs that have to access the MP3 across a + Samba share point. But this does not mean that you can't update tags + this way. Just that the local Linux program can access the MP3 faster. + + If you insist on using a windows version another good tool can also be + found on sourceforge at: http://massid3lib.sourceforge.net/ + + 3.3 Adding Users + To Add Users simply click admin->users->Add a new user and enter + the appropriate information + + + 3.4 Sorting and updating files (Under Development) + When updating catalog preferences new fields added in v3.1 include + ID3 set command + Filename pattern + Sort Pattern + + When these fields are populated a periodic update may be performed by scheduling + the fileupdate.pl program to run at timed intervals. This program will query the + database and attempt any requested updates. Before fileupdate.pl can be run, the + Ampache.pm file must be edited to reflect your archive information. + + Usage of fileupdate.pl is as follows: + + fileupdate [--id3|--rename|--sort|--all] [--help] [--pretend] [--verbose] + --pretend Display command taken, without actually doing anything. + --id3 Update id3 tags for all files flagged with 'id3' + --rename Rename files flagged with 'rename' + --sort Sort files flagged with 'sort' + --all Performs id3 update, rename, and sort + for all files flagged with 'id3' + --verbose Shows detailed information about what's happening. + --help This message + + + + An example usage would be to schedule a cron tab which will run fileupdate.pl with + the appropriate arguments which runs every 6 hours. + + EXAMPLE: + If you were to place the following line in your crontab: + * 24 * * * /apache/bin/fileupdate.pl -all + + any updates applied to the database would be applied at midnight everyday + + diff --git a/docs/INSTALL.de b/docs/INSTALL.de new file mode 100644 index 00000000..65123e23 --- /dev/null +++ b/docs/INSTALL.de @@ -0,0 +1,252 @@ +------------------------------------------------------------------------------- +------------------ INSTALL - Ampache v.3.2 - 08/11/2004 ----------------------- +------------------------------------------------------------------------------- + + Ich gehe davon aus, dass Apache, PHP und MySQL bereits laufen, wenn du hier + angelangt bist. + + Falls du von 3.0 auf 3.1 upgradest, schau dir bitte die MIGRATION Hinweise + an. Die Datenbank kann nicht weitergenutzt werden, aber glücklicherweise + haben wir einige Scripts entwickelt, um die Datenbank in das neue Format + zu konvertieren. (Dafür gibts ein extra Bier :P) + + Falls während der Installation irgendetwas schieflaufen sollte, schau dir + zunächst die /test.php an, um an Hilfe zu gelangen. + + 1. Schnellinstallation: + + mysql -u <Benutzername> -p <Datenbankname> < $root/ampache/sql/ampache.sql + + Editiere die /etc/apache/httpd.conf + Lass das Webroot auf $root/ampache/docs zeigen. + [snip] + Alias /ampache/ /usr/share/ampache/docs/ + + <Directory /usr/share/ampache/docs> + Options Indexes MultiViews + AllowOverride None + Order allow,deny + Allow from all + </Directory> + [snip] + Starte danach Apache neu. + + Verschiebe $root/ampache/config/ampache.cfg.dist nach + $root/ampache/config/ampache.cfg + Editiere $root/ampache/config/ampache.cfg + Besuche $web_adresse/login.php und melde dich mit den folgenden Daten an: + Benutzername: admin + Passwort: changeme + + + 2. Der längere Weg + + 2.1 Apache konfigurieren + An dieser Stelle gibt es zwei Möglichkeiten. Etnweder kannst du einen + Virtual Server für Ampache konfigurieren, oder du kannst Amapche einfach + in ein freies Verzeichnis installieren. Beide Wege besitzen Vor- und + Nachteile. + + Wenn du einen Virtual Server einrichtest, besitzt er seine eigenen + Logfiles, die hilfreich beim Berechnen des Traffics sein könnten + (Unterscheidung von Ampache- und normalem Traffic). + + Wenn du ein neues Verzeichnis für Ampache nutzt, wird der Traffic von + Ampache zusammen mit dem der anderen Anwendungen brechnet. Der Vorteil + hier ist, dass die Installation u.U. einfacher ist. + + We've included cronolog lines. These are not required, but for + troubleshooting we recommend them. + + Der Eintrag für einen eigenen Virtual Server lautet folgendermaßen: + + [snip] + + <VirtualHost 192.168.100.2:80> + ServerName tunes.ampache.org + + ServerAdmin webmaster@ampache.org + DocumentRoot /data/www/ampache/docs + + DirectoryIndex index.php + + </VirtualHost> + [snip] + + Nac einem Neustart sollte Ampache nun richtig konfiguriert sein. + + 2.2 MySQL konfigurieren + Wir legen an dieser Stelle einen eigenen User für Ampache an. + Dazu ist folgender Befehl erforderlich: + + 'mysql -u user -p pass < sql/ampache.sql' + + 2.3 Konfiguration von Ampache + + 2.3.1 Konfiguration der ampache.cfg + + Kopiere zuächst die config/ampache.cfg.dist nach + config/ampache.cfg. + Öffne dann die config/ampache.cfg.dist und editiere die + Vairablen: + + # Hostname des Datenbankservers + local_host = localhost + + # Datenbankname + local_db = ampache + + # Datenbank-Benutzername + local_username = <mysql_login_name> + + # Datenbank-Passwort + local_pass = <password> + + # Logindauer in Sekunden + local_length = 900 + + # Dies ist die Domain, fuer die das Cookie, in dem der Sessionkey gespeichert wird, + # ausgestellt wird. Diese Variable muss die Domain oder der Host des Systems sein. + # Andernfalls wird es unmoeglich sein, sich einzuloggen. + # Bitte ueberpruefe, ob zu Beginn ein . steht. (erforderlich!) + # Dies ist jedoch nicht notwendig, solange du die libglue fuer mehr als eine Seite + # nutzt. + # sess_domain = .yourwebsite.com + + # Name der Session/des Cookie, dass zum Browser geschickt wird. + sess_name = ampache + + # Lebenszeit des Cookies. 0 == Immer (bzw. bis der Browser geschlossen wird), + # andernfalls wird hier die Lebenszeit in Sekunden erwartet + sess_cookielife = 0 + + # Ist das Cookie ein "sicheres" Cookie? + sess_cookiesecure = 0 + + prefix = "/<ampache_root>" + # This should not include http:// or any part of the host name + # ampache detects hostname and port automaticly + # Hier sollte kein http:// oder irgendein Teil des Hostnames + # stehen. Hostname und Port werden automatisch erkannt. + web_path = "/<path to ampache>" + site_title = "Ampache!!!" + + # Sollte ausgeschaltet bleiben, ansonsten wird die Performance sehr drunter leiden. + do_mp3_md5 = "FALSE" + + # Hier wird das Interval angegeben, in dem der aktuelle Fortschritt + # beim Katalogisieren ausgegeben wird. Bei grossen Katalogen sollte + # diese Zahl moeglichst gering gehalten werden. + catalog_echo_count = "25" + + # Diese Option legt fest, welcher ID3 Tag bevorzugt wird. + # Diese Funktion wurde fuer diejenigen angelegt, die noch keine + # v2-Tags angelegt haben. Somit ist es bei manchen Nutzern hilfreich, + # v1 zu nutzen, bis die Kataloge auf v2 umgestellt sind. + id3tag_order = "id3v2" + id3tag_order = "id31v" + + # Kommentiere dies aus, wenn du nicht moechtest, dass Ampache + # symlinks folgt. + #no_symlinks = "true" + + # Benutze Login-/Authentifizierungssystem? + use_auth = "yes" + + # Kuenstler- & Album Zwischenspeicherlimit + # Um die Katalog-Aktualisierungen zu beschleunigen, und um die Last + # auf MySQL zu reduzieren nutzen wir eine Art Zwischenspeicher, wo + # anhand einer ID MySQL-Abfragen gespeichert werden. + # Du kannst diese Option frei nach deinem belieben abaendern ... + album_cache_limit = "25" + artist_cache_limit = "50" + + 2.3.2 Configuring motd.php + + Copy config/motd.php.dist to config/motd.php + + Edit this file however you like, with either php code or straight html. + The output will be displayed below the login box on login.php. + + + 3. Der erste Start von Ampache + + Besuche mit deinem Browser die frisch installierte Ampache-Seite, + und es sollte das Anmeldeformular erscheinen. + Das Passwort und der Benutzername für den ersten Login lauten: + Benutzer: admin + Passwort: changeme + + Jetzt kannst du dir ein Bier holen .. ;) + + 3.1 Einen Katalog einrichten + Zunächst gilt es, einen Katalog einzurichten. Dies geschieht, indem + man auf "Katalog hinzufügen" klickt, und dort den Pfad zur + MP3-Sammlung angibt. Es ist nicht notwendig, alle Unterverzeichnise + einzeln anzugeben, da die angegebenen Verzeichnise rekursiv + durchsucht werden. + + 3.2 Aktualisieren der Kataloge + Falls alles einwandfrei gelaufen, hast du nun einen leeren Ampache + vor dir. Um diesen Zustand zu veraendern, gehe unter der + Administrationsseite auf den Katalog-Link. + + Nun fehlt nur noch ein Klick auf "Alle Kataloge aktualisieren", und + die Datenbank wird gefuehlt. Dies kann eine Weile dauern, da der + Webserver nun jede einzelne Datei auf ihren ID3-Tag hin untersucht, + und diese Daten in die Datenbank einspeist. + + Final Note on MP3 Tags: + Abschliessende Bemerkung zu den ID3-Tags: + Da Ampache seine Daten aus den ID3-Tags bezieht, ist es wirklich + empfehlenswert, diese sauber und geordnet zu halten. + + Eines der besten Tools für diesen Zweck ist EasyTAG, ein Tageditor + für MP3- und OGG-Dateien: + http://easytag.sourceforge.net + + Es läuft direkt auf dem Linuxrechner, und ist somit ein wenig schneller, + als wenn man die ID3-Tags erst ueber Samba oder NFS aktualisiert. Das + heisst natuerlich nicht, dass dies geht .. Es geht lediglich darum, dass + dieses Programm schneller auf die ID3-Tags zugreifen kann. + + Falls du darauf bestehen solltest, Windows zu nutzen, findet sich unter + http://massid3lib.sourceforge.net/ eine weitere gute Software, für den + selben Zweck. + + 3.3 Benutzer hinzufügen + Um Benutzer hinzufügen, genügt es unter Administration -> Benutzer + -> Benutzer hinzufügen zu gehen, und das dortige Formular mit den + entsprechenden Informationen zu versehen. + + 3.4 Sortieren und Aktualisieren der Dateien (Wird noch entwickelt) + In Verbindung mit dem Update der Katalogeinstellungen, sind in v3.1 + folgende Felder hinzugekommen: + ID3-Kommando + Dateinamenmuster + Sortiermuster + + Nachdem diese Felder mit Werten versehen wurden, steht einem regelmäßigem + Update mithilfe von fileupdate.pl nichts mehr im Wege. + Dieses Programm fragt die Datenbank ab, und nimmt die neusten Aktualisierungen + vor. Bevor fileupdate.pl ausgeführt werden kann, muss die Ampache.pm editiert + werden, sodass sie die notwendigen Archivinformatioenen enthält. + + Benutzung von fileupdate.pl: + + fileupdate [--id3|--rename|--sort|--all] [--help] [--pretend] [--verbose] + --pretend Stelle das angegebene Kommando dar, ohne etwas zu machen. + --id3 Aktualisiere ID3-Tags von allen mit 'id3' markierten Dateien + --rename Benenne alle mit 'rename' markierten Dateien + --sort Sortiere alle mit 'sort' markierten Dateien + --all Nehme ID3-Update vor, bennene und sortiere alle Dateien um, + die mit 'id3' markiert wurden. + --verbose Zeige detailierte Informationen + --help Diese Nachricht + + + + Beispiel: + Folgender Eintrag nimmt regelmäßige um Mitternacht alle erforderlichen Updates + vor: + * 24 * * * /apache/bin/fileupdate.pl -all diff --git a/docs/MIGRATION b/docs/MIGRATION new file mode 100755 index 00000000..42449308 --- /dev/null +++ b/docs/MIGRATION @@ -0,0 +1,39 @@ +------------------------------------------------------------------------------- +--------- MIGRATION - Ampache v.3.3 ----------- +------------------------------------------------------------------------------- + + +- Migrating from Ampache 3.3 --> 3.3.X+ + + Rename your /config/ampache.cfg to /config/ampache.cfg.php + +- Migrating from Ampache-3.1.0 --> 3.3 + + Follow the instructions found in $yourwebsite/update.php + +- Migrating from Ampache-3.1-Alpha2 or Alpha --> Ampache 3.1-Alpha3 + + Please visit $yourwebsite/update.php to update the genre table. + If you are updating from Alpha2 to Alpha3 or higher. + This will invalidate your current catalog. + +- Migrating from Ampache-3.0 --> Ampache3.1 + + There are currently a few tools to help migrate your Users and your + playlists from Ampache 3.0 to Ampache 3.1. + + * Note these tools will _NOT_ work against 3.2 or 3.3 they are no + longer maintained. + + 1. Install and setup Ampache3.1 in a new Database. + + 2. Edit the approiate parameters in the following files + + /bin/migrate_user.pl + /bin/export_playlist.pl + /bin/import_playlist.pl + + 3. Run the desired script. + + These perl scripts were created by Andy Morgan + diff --git a/docs/MIGRATION.de b/docs/MIGRATION.de new file mode 100644 index 00000000..5dd6c8ce --- /dev/null +++ b/docs/MIGRATION.de @@ -0,0 +1,31 @@ +$CVSHeader: ampache/MIGRATION,v 1.2 2004/03/23 08:33:18 vollmerk Exp $ + +MIGRATION - Ampache v.3.1 - 11/26/2003 + +- Umwandlung von Ampache-3.1.X --> Ampache 3.3 + + Folge den Anweisungen unter $ampache/update.php + +- Umwandlung von Ampache-3.1-Alpha2 oder Alpha --> Ampache 3.1-Alpha3 + + Bitte besuche $ampache/update.php um die Genre-Tabelle zu + aktualisieren. + Falls du von Alpha2 auf Alpha3 aktualisierst, wird dein + Katalog jedoch ungültig, und muss neu angelegt werden. + +- Umwandeln von Ampache-3.0 --> Ampache3.1 + + Es gibt momentan einige Tools, um die Benutzer und Playlisten + von Ampache 3.0 auf Ampache 3.1 upzudaten. + + 1. Installiere und konfiguriere Ampache3.1 in einer neuen + Datenbank. + + 2. Editiere die entsprechenden Parameter in diesen Dateien: + /bin/migrate_user.pl + /bin/export_playlist.pl + /bin/import_playlist.pl + + 3. Führe das entsprechende Script aus. + + Die Perlskripte wurden von Andy Morgan erstellt. diff --git a/docs/README b/docs/README new file mode 100755 index 00000000..d33f798d --- /dev/null +++ b/docs/README @@ -0,0 +1,149 @@ +------------------------------------------------------------------------------- +--------- README - Ampache v.3.3 ----------- +------------------------------------------------------------------------------- + +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 + a) Donations (Beer!) + 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 + - FLAC + - RM + - AAC/M4A + - MPC + + 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 + - Realtime Downsampled + - Localplay using Moosic + - Localplay using MPD + - Icecast2 Stream + + 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) + - French (fr_FR) *Partial + + 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 - Developer + 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 + And many many more... + +2. Getting all the components + + Apache >= 1.3.19 http://www.apache.org OR other webserver + PHP >= 4.1.2 http://www.php.net + PHP4-Mysql + PHP4-Session + PHP4-gd (recommended) + PHP4 ICONV & ZLIB support (recommended) + MySQL >= 3.23 http://www.mysql.com + Perl >= 5 (Optional) + 16MB of Ram + +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 re-creating the 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. See Licence + included with this tar file + +4a. Donations + + We don't want your money but we will take your beer. If you + love ampache and want to encourage us to write more please + visit ampache.org for information on how to donate some beer + to our cause. If you can't send beer a postcard would also + be great. E-mail beer@ampache.org for shipping address + +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://bugs.ampache.org + Demo: http://ampache.org/demo + + Ampache Development Team + dev@ampache.org diff --git a/docs/README.de b/docs/README.de new file mode 100644 index 00000000..8e547c15 --- /dev/null +++ b/docs/README.de @@ -0,0 +1,114 @@ +------------------------------------------------------------------------------- +--------- README - Ampache v.3.2 - 06/07/2004 ----------- +------------------------------------------------------------------------------- + +Inhalt: + + 1. Einleitung + a) Danksagungen + 2. Komponenten herunterladen + 3. Einrichten + a) Upgraden + 4. Lizenz + a) Spenden (Bier!) + 5. Kontaktinformationen + +1. Einleitung: + + Ampache stellt eine PHP-basierte Oberfläche dar, die + ihre Informationen über MP3s in einer MySQL-Datenbank ablegt. + Die Lieder werden per PHP gestreamt. Ältere Versionen erfordern + mod_mp3, aber neuere Versionen arbeiten auch ohne mod_mp3. + Die Songs werden mit Hilfe von PHP-Skripten katalogisiert. + Mit dieser Version kommen viele neue Funktionen hinzu. Es wurden + die Katalogfunktionen überarbeitet, sodass diese insbesondere auf + größeren Systemen nun einfacher zu nutzen sind. Weiterhin wurden + erste Ansätze implementiert, die es ermöglichen, die eigenen + Kataloge mit denen von anderen Ampache-Systemen zu teilen oder + gemeinsam zu nutzen. Weitere Informationen hierzu kann man im + "Katalog" Bereich bei den Administratorwerkzeugen finden. + + Diese Kataloge basieren auf den ID3 Tags der MP3s. Wenn die Tags + regelmäßig gepflegt und aktuell sind, dann ist dies das geeignete + Werkzeug. + + Im CHANGELOG stehen weitere Informationen zu dieser Version. + + Danksagungen: + a) Dank an diejenigen, die dazu beigetragen haben, dass Ampache + das geworden ist, was es heute ist: + Scott Kveton - Hauptperson, der die Idee zu Ampache hatte + Robert Hopson - Libglue, Playlisten, Ogg Unterstützung & vieles mehr + Andy Morgan - Protagonist + Caleb Crome (Bugfixes und Verbesserungen) + Mike Payson + Jon Disnard + Adriaan Peters (Eine Vielzahl an Patches und Bugfixes) + Rob Kaandorp (Zeitberechnungsfix) + Ian Cote (MP3.php Verbesserungen) + Kurt Lieber (diverse Verbesserungen) + Maan Bsat (diverse Verbesserungen) + latka (von media.tangent.org) für die Vorschläge zur Behandlung von + Liedern ohne ID3-Tags (orphaned song) + Lamar Hansford (README/INSTALL Verbesserungen) & Upload + Und viele weitere ... + + +2. Komponenten herunterladen + + Apache >= 1.3.19 http://www.apache.org + PHP >= 4.1.2 http://www.php.net + MySQL >= 3.23 + Ampache nutzt die REPLACE Funktion von MySQL, was eine Version + von >= 3.23 erfordert. + http://www.mysql.com + 16MB RAM + +3. Einrichten + + Ampache: + Bei einem Upgrade von Version 3.0 auf 3.1 können vorhandenen + Datenbanktabellen und die config.php nicht mehr genutzt werden. + Diese müssen in das aktuelle Format konvertiert werden. Weitere + Informationen hierzu finden sich in der INSTALL Datei. + + +3a. Eine vorherige Ampache-Installation upgraden + + Für ein Upgrade empfiehlt sich die folgenden Vorgehenseweise: + - Eine Kopie dies alten Verzeichnisses anlegen. + - + (Falls du von einer älteren Ampache-Installation upgradest, empfehlen + wir dir, das alte Verzeichnis zu verschieben, das neue Archiv an + dieser Stelle zu entpacken und dann die config.php neu zu erstellen. + Alle Datenbankupgrades werden vom /update.php Skript erledigt. + Es ist also nicht notwendig die /sql/ampache.sql neu einzufügen, + falls bereits eine Ampache-Installation besteht.) + + +4. License + + Ampache steht unter der Standard GPL. Nähere Informationen finden + sich in der Datei, die in diesem Archiv mitgeliefert wird. + +4a. Spenden + + Wir wollen euer Geld nicht, aber wir nehmen gerne euer Bier an. + Wenn dir Ampache gefällt, und du uns ermutigenn willst, das Programm + weiter zu verbessern, dann besuche ampache.org um Informationen + darüber zu bekommen, wie du uns Bier spenden kannst. + Falls das nicht möglich ist, freuen wir uns auch über eine Postkarte. + +5. Kontaktinformationen + + Du hasst Ampache? Du liebst es? Lass es uns wissen. Lass es uns wissen, + wenn du an neuen Features interessiert bist, Bugs melden willst usw. + + IRC: irc.ampache.org #ampache (Freenode) + Foren: http://ampache.org/forums + Bugs: http://bugs.ampache.org + + Ampache Development Team + ampache-dev@lists.oregonstate.edu + + Karl Vollmer, Robert Hopson & Andy Morgan |