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

config.cover_art
  • config.cover_art: Boolean. Enable or disable support for showing cover art. Default: true

      # Enable cover art
      cover_art: true
    
      # Any value other than 'true' will disable cover art:
      cover_art: ohHello
    
config.favicon_path
  • config.favicon_path: String. Path or URL for a favicon.

      # Just use the default
      favicon_path: /fidi.png
    
      # Some other URL
      favicon_path: https://myfavicondomain.tld/some-image.png
    
config.holidays
  • config.holidays: Boolean. Enable or disable the usage of specially-themed logos in the user interface. Default: true

      # Enable holidays
      holidays: true
    
      # Any value other than 'true' will disable holidays:
      holidays: blazin
    
config.icons
  • config.icons: Boolean. Enable or disable the usage of icons in the user interface.

      # Enable icons
      icons: true
    
      # Any value other than 'true' will disable icons:
      icons: enchilada
    
config.logo_path
  • config.logo_path: String. Path or URL for a logo image.

      # Just use the default
      logo_path: /fidi.png
    
      # Some other URL
      logo_path: https://mylogodomain.tld/logo.png
    
config.music_dirs
  • config.music_dirs: Array of strings. Each string should be a full path to a music directory. Ensure the fidi user can read these paths.

      music_dirs:
        - /home/hristos/music/flac
        - /home/hristos/music/mp3
        - /home/hristos/music/ogg
        - /home/hristos/video/mp4
        - /home/hristos/video/webm
    
config.playlist.dir
  • config.playlist.dir: String. A full path to a playlist directory.

      playlist:
        dir: /home/hristos/music/playlists
    
config.playlist.save
  • config.playlist.save: Boolean. Can playlists be saved or not. Omitting this value from your config file disables it. Default: true

      # Allow saving:
      playlist:
        save: true
    
      # Any value other than 'true' will disable saving:
      playlist:
        save: taco
    
config.preload_audio
  • config.preload_audio: Boolean. Set this to true to enable preloading the entire track with the audio player. This can be useful if experiencing skipping or stalling in playback. It only applies to the playlist player. Omitting this value from your config file disables it. Default: false

      # Enable audio preloading
      preload_audio: true
    
      # Any value other than 'true' will disable audio preloading:
      preload_audio: tostada
    
config.preload_video
  • config.preload_video: Boolean. Set this to true to enable preloading the entire track with the video player. This can be useful if experiencing skipping or stalling in playback. It only applies to the playlist player. Omitting this value from your config file disables it. Default: false

      # Enable video preloading
      preload_video: true
    
      # Any value other than 'true' will disable video preloading:
      preload_video: burrito
    
config.secret_key
  • config.secret_key: String. This should be a long, secure string to be used for generating secure cookies (used by the "Queue" feature).
    • One can be generated with this command: python3 -c 'import os;print(os.urandom(24))'

        secret_key: b'\xb7(\xa0\x9f>\x7f6\xc8\x9b\x1d\xfe\xcd\x0c\x0c\x06b\xaer\xa6\x11J\xa3\xa8g'
      
config.site_name
  • config.site_name: String. The "site name" as shown in the header and elsewhere.

      # Just use the default
      site_name: MousikóFídi - Your Music Cloud
    
      # Use a custom name
      site_name: My Cool Fidi Instance!
    
config.theme
  • config.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 ogenfald.

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

About this wiki

commit c7aa8adde209af4256caa44eb0a930f96d40d5ef
Author: Hristos N. Triantafillou <me@hristos.triantafillou.us>
Date:   2019-11-25T12:46:48-06:00

Put the "Contributing" section at the top, mention the dev branch

The way things were before, it wasn't very clear that the "dev" branch
is what someone would want to work off of (need to even).

Moving the "Contributing" section to the top, and adding specific
wording about "dev", will help make this more clear.

I've also swapped out the git-send-email.io link for a direct link to
the new "make a patch" link on sourcehut, and removed the bit about
the git book (out of scope for the document anyways).
Clone this wiki
https://git.sr.ht/~hristoast/mousikofidi (read-only)
git@git.sr.ht:~hristoast/mousikofidi (read/write)