Koko

Self-hosted media server

ℹ️ About

Koko is a (WIP) self-hosted media server written in Rust. At this point in time this is a learning project, and you SHOULD NOT use this for any purpose. I don't know what I am doing and the code is probably terrible. This is also NOT a functioning media server yet. Once it is, I will update this README.

If you are interested in this project, please leave a star and watch the repository for updates.

If you would like to contribute, please reach out on our discord server.

⚙️ Configuration

Koko uses a YAML configuration file to set up the server.

The file must be named settings.yml and be placed in the following location, depending on your OS.

OS	Location
Linux	$XDG_CONFIG_HOME/Koko
macOS	$HOME/Library/Application Support/Koko
Windows	%LOCALAPPDATA%\Koko

Only the non default values need to be set in the configuration file. An example with all the default values is shown below.

---
general:
  data_dir: 'data'

server:
  use_https: true
  address: '127.0.0.1'
  port: 9191
  cert_path: 'cert.pem'
  key_path: 'key.pem'
  use_custom_certs: false

📝 TODO

This list is not all-inclusive, and just meant to be a very high level for the initial design.

• Branding
  • Koko logo
  • Koko banner
  • Tray icons for different states/activity
• Publishing (enabling readme badges as required)
  • GitHub Releases
  • Docker/GHCR
  • Flathub
  • Winget
  • LizardByte/Homebrew
  • LizardByte/pacman-repo
• Localization and CrowdIn integration
• Unit Testing
  • doc tests
  • Coverage
• Settings/Config
• Notification System
  • System Notifications
  • Discord
  • Webhooks
• Database
• Backend
  • Authentication
  • API
  • Certs/SSL
  • Media Scanner
  • Media Player
  • Legal/Licensing info on dependencies
• Frontend
  • Home
  • Media
  • Settings
  • Dashboard
    • System Info
    • CPU Usage
    • Memory Usage
    • Disk Usage
    • Network Usage
    • GPU Usage
    • Play history
  • Media Player
  • User Management
  • Legal/Licensing info on dependencies
• User Documentation
  • Publish docs to ReadTheDocs
  • Create Gurubase and enable readme badge
• Media
  • Live TV
    • DVR/Tuner
  • Video
    • Movies
    • TV Shows
    • Videos
  • Audio
    • Albums/Music
    • Podcasts
    • Audiobooks
  • Images
    • Photos
  • Books
    • Ebooks
    • PDFs
    • Comics
  • Games (Pipe Dream)
    • Spin up on-demand game servers (containers or VMs)