Configuration Guide

By default, MousikóFídi looks for a configuration file at:

$HOME/.config/fidi/config.toml

An alternate file may be used by pointing the FIDI_CFG environment variable to the path of the desired alternate file.

A full example config file with comments is viewable here, and a complete file can be generated by simply renaming any existing file and starting MousikóFídi.

Each configuration file option for MousikóFídi is explained below:

→ library.dirs

• library.dirs: Array of strings. Each string should be a full path to a music directory. Ensure the fidi user can read these paths.

  [library]
  dirs = [
    "/home/hristos/music/flac",
    "/home/hristos/music/mp3",
    "/home/hristos/music/ogg",
    "/home/hristos/video/mp4",
    "/home/hristos/video/webm",
  ]

→ player.keyboard_controls

• player.keyboard_controls: Boolean. Enable or disable keyboard-driven controls for the audio and video players.

  [player]
  keyboard_controls = true

→ Key Bindings

This setting enables the following key bindings:

• Left Arrow Key: Skip to the previous track, if possible.
• Right Arrow Key: Skip to the next track, if possible.
• Up Arrow Key: Raise the player volume by 1%, if possible.
• Down Arrow Key: Lower the player volume by 1%, if possible.
• Space Bar: Toggle pause or play with the current track.
• Shift + Left Arrow Key: Seek forward in the current track, if possible.
• Shift + Right Arrow Key: Seek backwards in the current track, if possible.
• Shift + Up Arrow Key: Raise the player volume by 10%, if possible.
• Shift + Down Arrow Key: Lower the player volume by 10%, if possible.

Note: If a page has both an audio and video player, the keyboard controls will default to the audio player only.

→ playlists.allow_delete

• playlists.allow_delete: Boolean. Enable or disable deletion of playlist files. Default: false

  [playlists]
  allow_delete = false

→ playlists.dir

• playlists.dir: String. A full path to a playlist directory. No default; playlist-related functionality is disabled if this isn't set.

  [playlists]
  dir = "/home/hristos/music/playlists"

→ playlists.allow_save

• playlists.allow_save: Boolean. Can playlists be saved or not. Omitting this value from your config file disables it. Default: true

  [playlists]
  allow_save = true

→ ui.favicon_path

• ui.favicon_path: String. Path or URL for a favicon. Default: "/fidi.png"

  [ui]
  # Just use the default
  favicon_path = "/fidi.png"
  
  # Or, some other URL
  favicon_path = "https://myfavicondomain.tld/some-image.png"

→ ui.holidays

• ui.holidays: Boolean. Enable or disable the usage of specially-themed logos in the user interface. Default: true

  [ui]
  holidays = true

→ ui.icons

• ui.icons: Boolean. Enable or disable the usage of icons in the user interface. Default: true

  [ui]
  icons = true

→ ui.logo_path

• ui.logo_path: String. Path or URL for a logo image. Default: "/fidi.png"

  [ui]
  # Just use the default
  logo_path = "/fidi.png"
  
  # Or, some other URL
  logo_path = "https://mylogodomain.tld/logo.png"

→ ui.show_cover_art

• ui.show_cover_art: Boolean. Enable or disable support for showing cover art. Default: true

  [ui]
  show_cover_art = true

If a supported file (currently only FLAC and MP3) contains an embedded cover art image, that will be used. Otherwise, the cover art will be guessed based on the presence of any images in the same directory as the given file.

→ ui.site_name

• ui.site_name: String. The "site name" as shown in the header and elsewhere. Default: "MousikóFídi - Your Music Cloud"

  [ui]
  # Just use the default
  site_name = "MousikóFídi - Your Music Cloud"
  
  # Use a custom name
  site_name = "My Cool Fidi Instance!"

→ ui.theme

• ui.theme: String. Choose from dark, light, nes, terminal, terminal-green, terminal-solarized , or supply your own stylesheet URL to provide a custom theme. This sets the default theme. Terminal themes by Ben F Joyner III.

  [ui]
  # Default to the dark theme...
  theme = "dark"
  
  # Or the light theme...
  theme = "light"
  
  # Or the "NES" theme...
  theme = "nes"
  
  # Or the "Terminal" theme...
  theme = "terminal"
  
  # Or, supply your own stylesheet:
  theme = "https://mycssdomain.tld/my-style.css"

→ other.secret_key

• other.secret_key: String. This should be a long, secure string to be used for generating secure cookies (used by the "Settings" feature).

  • This is automatically generated with your config file.

[other]
secret_key = "FB36Kb4PUVVi6Pw1t9ERunkWNGwHgNexYEnbc6SjYHI7CVRNrJ"