Documentation

Everything you need to know about Umbrella - from installation to advanced plugin development.

Quick Start

1

Download APK

Download the latest APK from our releases page

2

Install App

Install the APK on your Android device

3

Grant Permissions

Grant necessary permissions for full functionality

4

Install Plugins

Download and install plugins from trusted sources

5

Start Exploring

Begin using Umbrella with your favorite plugins

Documentation

Installation
Get started with Umbrella - download and install the app
Android APKBuilding from SourceRequirements
Configuration
Configure Umbrella to match your preferences and needs
Initial SetupPlugin ManagementApp Settings
Plugin Development
Create your own plugins for Umbrella
Plugin APISandbox EnvironmentPublishing Plugins
Security
Understanding Umbrella's security model and best practices
SandboxingPermissionsCode Review
API Reference
Complete API documentation for plugin developers
Core APIsMedia APIsStorage APIs
Guides
Step-by-step guides for common tasks and use cases
Basic UsageAdvanced FeaturesTroubleshooting

Plugin Development

Create powerful plugins that extend Umbrella's functionality

Getting Started

Plugin Structure

Learn the basic structure and required files for Umbrella plugins

Security Model

Understand how plugins run in a sandboxed environment

API Access

Access Umbrella's APIs for media playback, storage, and more

Sample Plugin

// example-plugin.js
import { type CheerioAPI, load } from "cheerio";

class ExamplePlugin {
  async search(query: string, page?: number) {
    ...
  }
  async getCategory(category: string, page?: number): Promise<object> {
    ...
  }
  async getHomeCategories(): Promise<object[]> {
    ...
  }
  async getItemDetails(id: string): Promise<object> {
    ...
  }
  async getItemMedia(id: string): Promise<object[]> {
    ...
  }
}

module.exports = {
  ...
};

export default ExamplePlugin;

Community & Support

Get help, contribute to the project, and connect with other developers

GitHub

Report issues, contribute code, and track development progress

Discussions

Join community discussions and get help from other users

Contributing

Learn how to contribute to Umbrella's development