Shiva-Server documentation

Contents:

• Intro
• Installation
  • Prerequisites
  • Installing from source
  • Installing using pip
• Configuration
  • SECRET_KEY
  • DEBUG mode
• Indexing your music
  • Restricting extensions
  • Scanning directories
• Shiva client
  • Wish you were here
• Base Resources
  • /artists
  • /albums
  • /tracks
  • Track creation
  • /tracks/<int:id>/lyrics
  • The fulltree modifier
  • Pagination
  • Using slugs instead of IDs
• Meta Resources
  • /random
  • /whatsnew
• Format conversion
  • Absolute paths
  • Your converter sucks
  • The MimeType class
  • The MIMETYPES config
• Cross Origin Resource Sharing
• Users
  • User creation
  • Authentication
• Role-based Access Control
• Playlists
  • /playlists
  • Adding tracks
  • Removing tracks
• Admin utility
• Want to contribute?
  • Sending code
  • Reporting bugs
• Wish list
  • Assumptions

Indices and tables

• Index
• Module Index
• Search Page

What is Shiva?

The Mozilla Hacks blog kindly published a nice article that explains the ideas that inspire this software: Shiva: More than a RESTful API to your music collection.

Why Shiva?

Shiva is the name of the crater that would have been created by the K-Pg event that extincted the dinosaurs.

License

Please read the LICENSE file distributed with this software.

Disclaimer

Remember that when using this software you must comply with your country’s laws. You and only you will be held responsible for any law infringement resulting from the misuse of this software.

That said, have fun.