Skip to content

mitchray/ample

Repository files navigation

Ample: A web browser client for Ampache v6+

Ample screenshot

Demo

View demo

Installing

  1. Download Ample
    • Either from a prebuilt release
    • or compile yourself from Git repository (see Developing)
  2. Place it anywhere on your server
    • Even on a different server from Ampache, just be mindful that the remote Ampache server will need configuring
  3. Set up the config file

Translations

Edit or add new languages via Inlang Fink

Config file

Save as config/ample.json, must be valid JSON (i.e. no trailing comma on the last item)

Key Type Description
ampacheURL Required Full URL to the Ampache server
guestUserAPIKey Optional Login with this user's API key (use lowest Guest level permissions, this is public)
loginMessage Optional Will be displayed on the login screen
logo Optional Use custom image on the login screen (full URL or relative path to Ample folder)

Example

{
  "ampacheURL": "https://example.com", 
  "guestUserAPIKey": "123456789", 
  "loginMessage": "There's no place like 127.0.0.1", 
  "logo": "./config/logo.svg" 
}

Developing

  • Clone the Ample repository and from the ample directory cd ample
  • Install packages npm install
  • For development and hot reloading npm run dev
  • For building npm run build, and see the contents of dist

Additional console logging can be enabled by setting debugMode true in src/stores/state.js