MediaBot User Guide

Welcome to MediaBot, your lightweight, privacy-focused media server designed for completely offline use. This guide will help you navigate and use the MediaBot web interface efficiently.

MediaBot allows you to organize, stream, and enjoy your personal media collection including movies, TV shows, music from anywhere on your home network without requiring an internet connection.

Quick Start

For those in a hurry, here's the short rundown on how to get started

  1. Download and install MediaBot Server from the Apple App Store
  2. Start the app, the MediaBot Icon will appear in your menu bar at the top right of your screen
  3. Click the Icon and select "Open MediaBot...". Your browser will open to the MediaBot's web interface in Safari
  4. Click the Icon and select "Open MediaBot...". Your browser will open to the MediaBot's web interface in Safari
  5. You should be on the configuration page. A default user "admin" with password "admin" is already created.
  6. Click the "Edit" icon next to the "admin" user and enter a new password. Click "Save"
  7. Click the "Edit" icon next to the "Movies" library
  8. Click "Grant Folder Access" and select the folder containing your movie collection (i.e. Movies)
    9. We recommend creating a Media folder in your home directory or the root of your hard drive and creating subdirectories in it such as Movies. You can also put it on an external USB/SSD drive.
  9. Click the dropdown for Path and select the folder you created
  10. You can add more than one path for your library
  11. Click "Save"
  12. Click "Scan" to start indexing your movie collection
  13. Select "Movies" from the menu bar and select a movie to start watching

Features

MediaBot provides a comprehensive set of features for managing and enjoying your media:

Media Libraries

Libraries are the foundation of MediaBot. They organize your media by type and location.

Library Types

Creating a Library

  1. Navigate to the Libraries section in the main menu
  2. Click "Add Library"
  3. Enter a name for your library
  4. Select the library type
  5. Click "Pick Folder" to select the folder containing your media
  6. Click "Save" to create the library
  7. Click "Scan" to index the media in your library

Managing Libraries

From the Libraries section, you can:

Media Playback

MediaBot includes built-in players for various media types.

Video Playback

To play a video:

  1. Navigate to a Movies or TV library
  2. Click on a video thumbnail to start playback
  3. Use the on-screen controls to play, pause, seek, and adjust volume
  4. Click the forward/backward buttons to navigate between videos
  5. Toggle shuffle mode with the shuffle button

MediaBot remembers your playback position for videos, allowing you to resume where you left off.

Music Playback

To play music:

  1. Navigate to a Music library
  2. Click on a song to start playback
  3. Use the audio player controls to play, pause, and navigate between tracks
  4. Toggle shuffle mode with the shuffle button

Playlists

Playlists allow you to organize and play selected media in a specific order.

Creating a Playlist

  1. Navigate to the Playlists section
  2. Click "Add Playlist"
  3. Enter a name for your playlist
  4. Click "Save"

Adding Media to a Playlist

  1. Navigate to a media library
  2. Find the media item you want to add
  3. Click the menu icon on the media item
  4. Select "Add to Playlist"
  5. Choose the playlist you want to add the item to

Playing a Playlist

  1. Navigate to the Playlists section
  2. Click on the playlist you want to play
  3. Click on a media item to start playback
  4. The playlist will continue playing in sequence

User Management

MediaBot supports multiple user accounts with different access levels.

User Roles

Creating a User

  1. Navigate to the Users section (admin access required)
  2. Click "Add User"
  3. Enter a username and password
  4. Click "Save"

Managing Library Access

  1. Navigate to the Libraries section
  2. Select a library
  3. Click "Manage Access"
  4. Select which users can access the library
  5. Click "Save"

Grant Folder Access

MediaBot does not have access to any of your folders. Before it can access any Media, you must grant it access to the folders containing your media. It does not have access to browse your folders unless you grant it access to root of your drive. We therefore recommend you put your media in a Media folder in your home directory or the root of your hard drive and create subdirectories in it such as Movies, TV Shows, Music, etc. The best and most common setup is to use a USB/SSD drive for all your media and grant MediaBot access to that drive.

Frequently Asked Questions

Does MediaBot require an internet connection?

No, MediaBot is designed to work completely offline on your local network. Once installed, you can access and use it without any internet connection.

What file formats are supported?

MediaBot supports file formats that play natively in Safari:

How do I update MediaBot?

MediaBot updates are distributed through the App Store. When a new version is available, you'll receive a notification through the App Store, and you can update with a single click.

Is my media collection secure?

Yes, MediaBot is designed with privacy and security in mind. Your media stays on your local network, and MediaBot doesn't collect any usage data or personal information.

Can I access MediaBot from outside my home network?

MediaBot is designed for local network use. If you need remote access, you would need to set up a VPN to your home network.

Support

If you need help with MediaBot, there are several ways to get support:

Contact Information

For direct support, contact us at: [email protected]

Reporting Issues

If you encounter any bugs or issues, please include the following information:

Feature Requests

We're always looking to improve MediaBot. If you have suggestions for new features or improvements, please let us know at the email address above.