mirror of
https://gitlab.com/vyla-entertainment/documentation.git
synced 2026-11-14 06:27:23 -05:00
huge doc rewrite
This commit is contained in:
287
index.html
287
index.html
@@ -9,53 +9,12 @@
|
||||
content="A community-built media project focused on freedom, privacy, and giving people control over their own experience." />
|
||||
<meta name="keywords"
|
||||
content="Vyla, media streaming, self-hosted, privacy, open source, media player, streaming API, SDK, Android TV, desktop media" />
|
||||
<link rel="canonical" href="https://vyla.cc/" />
|
||||
|
||||
<!-- Open Graph / Facebook -->
|
||||
<meta property="og:type" content="website" />
|
||||
<meta property="og:url" content="https://vyla.cc/" />
|
||||
<meta property="og:title" content="Vyla Entertainment — Vyla" />
|
||||
<meta property="og:description"
|
||||
content="A community-built media project focused on freedom, privacy, and giving people control over their own experience." />
|
||||
<meta property="og:image" content="https://vyla.cc/assets/images/thumbnail.png" />
|
||||
<meta property="og:site_name" content="Vyla" />
|
||||
|
||||
<!-- Twitter -->
|
||||
<meta property="twitter:card" content="summary_large_image" />
|
||||
<meta property="twitter:url" content="https://vyla.cc/" />
|
||||
<meta property="twitter:title" content="Vyla Entertainment — Vyla" />
|
||||
<meta property="twitter:description"
|
||||
content="A community-built media project focused on freedom, privacy, and giving people control over their own experience." />
|
||||
<meta property="twitter:image" content="https://vyla.cc/assets/images/thumbnail.png" />
|
||||
<meta property="twitter:site" content="@vylaentertainment" />
|
||||
|
||||
<!-- Additional SEO -->
|
||||
<meta name="robots" content="index, follow" />
|
||||
<meta name="author" content="Vyla" />
|
||||
|
||||
<link rel="icon" href="/favicon.ico" />
|
||||
<link rel="stylesheet" href="/assets/base.css" />
|
||||
<link rel="stylesheet" href="/assets/highlight.css" />
|
||||
<link rel="stylesheet" href="/assets/mintlify-overrides.css" />
|
||||
|
||||
<!-- JSON-LD Structured Data -->
|
||||
<script type="application/ld+json">
|
||||
{
|
||||
"@context": "https://schema.org",
|
||||
"@type": "SoftwareApplication",
|
||||
"name": "Vyla",
|
||||
"description": "A community-built media project focused on freedom, privacy, and giving people control over their own experience.",
|
||||
"url": "https://vyla.cc/",
|
||||
"applicationCategory": "MultimediaApplication",
|
||||
"operatingSystem": "Windows, macOS, Linux, Android, Android TV",
|
||||
"offers": {
|
||||
"@type": "Offer",
|
||||
"price": "0",
|
||||
"priceCurrency": "USD"
|
||||
}
|
||||
}
|
||||
</script>
|
||||
|
||||
<link rel="stylesheet" href="/assets/styling/main.css" />
|
||||
<link rel="manifest" href="/manifest.webmanifest" />
|
||||
<script src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/components/prism-core.min.js"></script>
|
||||
<script
|
||||
src="https://cdnjs.cloudflare.com/ajax/libs/prism/1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
|
||||
<script>
|
||||
(function () {
|
||||
var saved = localStorage.getItem('vyla-theme');
|
||||
@@ -66,176 +25,78 @@
|
||||
</head>
|
||||
|
||||
<body>
|
||||
|
||||
<div id="banner">
|
||||
<span>Vyla is self-hosted. Run Vyla Home, embed the SDK, or deploy Stream API on infrastructure you control.
|
||||
Rights
|
||||
holders can request source removal — <a href="/misc/dmca">DMCA policy</a>.</span>
|
||||
<button id="banner-close" onclick="dismissBanner()" aria-label="Dismiss">✕</button>
|
||||
</div>
|
||||
|
||||
<header id="navbar">
|
||||
<div class="nav-top">
|
||||
<a class="brand" href="/"><img src="/assets/images/logo.png" alt="Vyla" id="brand-logo"></a>
|
||||
<button id="search-trigger" type="button" onclick="openSearch()" aria-label="Search"></button>
|
||||
<div class="links">
|
||||
<button id="theme-toggle" type="button" onclick="toggleThemeMenu(event)" aria-label="Theme"></button>
|
||||
</div>
|
||||
<video class="video-bg" src="" autoplay muted loop></video>
|
||||
<div id="header-container">
|
||||
<div id="banner">
|
||||
<span>
|
||||
Rights holders can request source removal — <a href="/misc/project/dmca">DMCA policy</a>.
|
||||
</span>
|
||||
<button id="banner-close" onclick="dismissBanner()" aria-label="Dismiss">✕</button>
|
||||
</div>
|
||||
<nav class="tabs">
|
||||
<a class="tab-link" href="/">Vyla</a>
|
||||
<a class="tab-link" href="/sdk">SDK</a>
|
||||
<a class="tab-link active" href="/stream-api/overview">Stream API</a>
|
||||
<a class="tab-link" href="/guides/integrations">Resources</a>
|
||||
<a class="tab-link" href="/misc/credit">Misc</a>
|
||||
</nav>
|
||||
</header>
|
||||
<div id="layout">
|
||||
<nav id="sidebar">
|
||||
<div class="group">
|
||||
<p class="group-title">Start here</p>
|
||||
<ul>
|
||||
<li><a class="active" href="/">Introduction</a></li>
|
||||
<li><a class="" href="/architecture">Architecture</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="group">
|
||||
<p class="group-title">Products</p>
|
||||
<ul>
|
||||
<li><a class="" href="/home">Home</a></li>
|
||||
<li><a class="" href="/go">Go</a></li>
|
||||
<li><a class="" href="/tv">Tv</a></li>
|
||||
<li><a class="" href="/player">Player</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
<div class="group">
|
||||
<p class="group-title">Concepts</p>
|
||||
<ul>
|
||||
<li><a class="" href="/concepts/providers">Providers</a></li>
|
||||
</ul>
|
||||
</div>
|
||||
</nav>
|
||||
<div id="content-col">
|
||||
<main class="prose">
|
||||
<h1>Vyla Entertainment</h1>
|
||||
<p class="page-description">A community-built media project focused on freedom, privacy, and giving
|
||||
people
|
||||
control over their own experience.</p>
|
||||
<img class="vyla-banner" src="/assets/images/devices.png"
|
||||
alt="A collage of films and shows available through a Vyla experience" loading="lazy"
|
||||
fetchpriority="low">
|
||||
<h2 id="about-vyla">About Vyla</h2>
|
||||
<p>Vyla is a community-built media project created around a simple idea: <strong>people should have
|
||||
control over
|
||||
how they experience their media.</strong></p>
|
||||
<p>We started Vyla because we wanted something clean, private, and easy to use without relying on a
|
||||
single
|
||||
company or centralized service. What began as a small project has grown into a collection of
|
||||
applications and
|
||||
tools for desktop, Android, Android TV, and more.</p>
|
||||
<p>Vyla is not a streaming service, and we do not host or provide the media itself. Instead, we build
|
||||
the
|
||||
software that brings the experience together while leaving control in the hands of the person using
|
||||
it.</p>
|
||||
<h2 id="where-we-come-from">Where we come from</h2>
|
||||
<p>Vyla started as a small web project focused on creating a better way to discover and watch movies and
|
||||
shows.
|
||||
Over time, it grew into a broader project with applications for different platforms alongside the
|
||||
tools that
|
||||
power them.</p>
|
||||
<p>We care about keeping Vyla open, accessible, and community-driven. Our project has also been shared
|
||||
by
|
||||
communities such as <strong>FMHY</strong> and <strong>r/Piracy</strong>, where people interested in
|
||||
alternative and self-hosted media solutions have discovered Vyla.</p>
|
||||
<p>We are proud to be part of a wider community of people who build, share, and explore alternatives to
|
||||
traditional media platforms.</p>
|
||||
<h2 id="what-we-make">What we make</h2>
|
||||
<p>Vyla is made up of several projects designed for different ways of using the platform.</p>
|
||||
<table>
|
||||
<thead>
|
||||
<tr>
|
||||
<th>Platform</th>
|
||||
<th>Description</th>
|
||||
<th>Link</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td>Vyla Home</td>
|
||||
<td>Desktop app</td>
|
||||
<td><a href="/home">Learn more</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Vyla Go</td>
|
||||
<td>Android app</td>
|
||||
<td><a href="/go">Learn more</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Vyla TV</td>
|
||||
<td>Android TV app</td>
|
||||
<td><a href="/tv">Learn more</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Vyla SDK</td>
|
||||
<td>Developer SDK</td>
|
||||
<td><a href="/sdk">Learn more</a></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td>Stream API</td>
|
||||
<td>Self-hosted API</td>
|
||||
<td><a href="/stream-api/overview">Learn more</a></td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
<h2 id="made-for-people-not-platforms">Made for people, not platforms</h2>
|
||||
<p>We believe software should give people more control, not less.</p>
|
||||
<p>That means keeping Vyla local and self-hostable, avoiding unnecessary centralized dependencies, and
|
||||
allowing
|
||||
developers and users to decide how they want to use the project.</p>
|
||||
<p>Vyla can be as simple as a TV or mobile app, a desktop application, or the foundation for a
|
||||
completely custom
|
||||
media experience. <strong>You decide how much of Vyla you use and where it runs.</strong></p>
|
||||
<h2 id="start-exploring">Start exploring</h2>
|
||||
<ul>
|
||||
<li><strong>On desktop?</strong> See <a href="/home">Vyla Home</a>.</li>
|
||||
<li><strong>On Android?</strong> See <a href="/go">Vyla Go</a>.</li>
|
||||
<li><strong>Using Android TV?</strong> See <a href="/tv">Vyla TV</a>.</li>
|
||||
<li><strong>Building something with Vyla?</strong> Start with the <a href="/sdk-quickstart">SDK
|
||||
quickstart</a>.</li>
|
||||
<li><strong>Building your own client?</strong> See the <a href="/stream-api/overview">Stream
|
||||
API</a>.
|
||||
</li>
|
||||
<li><strong>Want to understand how everything fits together?</strong> Visit <a
|
||||
href="/architecture">Our
|
||||
Architecture</a>.</li>
|
||||
</ul>
|
||||
<div class="callout callout-info">
|
||||
<div class="callout-content">
|
||||
<p>Vyla is self-hosted software and does not host or distribute media. Please respect applicable
|
||||
laws,
|
||||
upstream terms, and rights-holder requests. See the <a href="/misc/dmca">DMCA policy</a> for
|
||||
removal
|
||||
information.</p>
|
||||
</div>
|
||||
<header id="navbar">
|
||||
<div class="nav-top">
|
||||
<a class="brand" href="/"><img src="/assets/images/logo.png" alt="Vyla" id="brand-logo" width="28"
|
||||
height="28" decoding="async" /></a>
|
||||
<button id="search-trigger" type="button" onclick="openSearch()" aria-label="Search"></button>
|
||||
<div class="links">
|
||||
<button id="theme-toggle" type="button" onclick="toggleThemeMenu(event)"
|
||||
aria-label="Theme"></button>
|
||||
</div>
|
||||
</main>
|
||||
<aside id="toc">
|
||||
<p class="toc-title">On this page</p>
|
||||
<ul>
|
||||
<li><a href="#about-vyla">About Vyla</a></li>
|
||||
<li><a href="#where-we-come-from">Where we come from</a></li>
|
||||
<li><a href="#what-we-make">What we make</a></li>
|
||||
<li><a href="#made-for-people-not-platforms">Made for people, not platforms</a></li>
|
||||
<li><a href="#start-exploring">Start exploring</a></li>
|
||||
</ul>
|
||||
</aside>
|
||||
</div>
|
||||
</div>
|
||||
<nav class="tabs" id="nav-tabs"></nav>
|
||||
</header>
|
||||
</div>
|
||||
<footer id="site-footer">
|
||||
<a href="https://discord.gg/5eqRhKeywG" target="_blank" rel="noopener">Discord</a>
|
||||
<a href="https://gitlab.com/vyla-entertainment/" target="_blank" rel="noopener">GitLab</a>
|
||||
</footer>
|
||||
<script src="/assets/app.js"></script>
|
||||
<div id="layout">
|
||||
<nav id="sidebar"></nav>
|
||||
<div id="content-wrapper">
|
||||
<div id="content-col">
|
||||
<div id="main-wrap">
|
||||
<main class="prose" id="main-content"></main>
|
||||
<footer id="site-footer">
|
||||
<div class="footer-nav">
|
||||
<a id="footer-prev" class="footer-link prev" href="#"></a>
|
||||
<a id="footer-next" class="footer-link next" href="#"></a>
|
||||
</div>
|
||||
<div class="footer-bottom">
|
||||
<div class="footer-socials">
|
||||
<a href="https://discord.gg/5eqRhKeywG" target="_blank" rel="noopener"
|
||||
aria-label="Discord">
|
||||
<svg class="footer-icon" viewBox="0 0 24 24" fill="currentColor">
|
||||
<path
|
||||
d="M20.317 4.37a19.791 19.791 0 0 0-4.885-1.515.074.074 0 0 0-.079.037c-.21.375-.444.864-.608 1.25a18.27 18.27 0 0 0-5.487 0 12.64 12.64 0 0 0-.617-1.25.077.077 0 0 0-.079-.037A19.736 19.736 0 0 0 3.677 4.37a.07.07 0 0 0-.032.027C.533 9.046-.32 13.58.099 18.057a.082.082 0 0 0 .031.057 19.9 19.9 0 0 0 5.993 3.03.078.078 0 0 0 .084-.028c.462-.63.874-1.295 1.226-1.994.021-.041.001-.09-.041-.106a13.107 13.107 0 0 1-1.872-.892.077.077 0 0 1-.008-.128 10.2 10.2 0 0 0 .372-.292.074.074 0 0 1 .077-.01c3.929 1.793 8.18 1.793 12.061 0a.074.074 0 0 1 .078.01c.12.098.246.198.373.292a.077.077 0 0 1-.006.127 12.299 12.299 0 0 1-1.873.892.077.077 0 0 0-.041.107c.36.698.772 1.362 1.225 1.993a.076.076 0 0 0 .084.028 19.839 19.839 0 0 0 6.002-3.03.077.077 0 0 0 .032-.054c.5-5.177-.838-9.674-3.549-13.66a.061.061 0 0 0-.031-.028zM8.02 15.33c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.956-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.956 2.418-2.157 2.418zm7.975 0c-1.183 0-2.157-1.085-2.157-2.419 0-1.333.955-2.419 2.157-2.419 1.21 0 2.176 1.096 2.157 2.42 0 1.333-.946 2.418-2.157 2.418z" />
|
||||
</svg>
|
||||
</a>
|
||||
<a href="https://gitlab.com/vyla-entertainment/" target="_blank" rel="noopener"
|
||||
aria-label="GitLab">
|
||||
<svg class="footer-icon" viewBox="0 0 16 16" xmlns="http://www.w3.org/2000/svg"
|
||||
fill="currentColor">
|
||||
<g id="SVGRepo_bgCarrier" stroke-width="0"></g>
|
||||
<g id="SVGRepo_tracerCarrier" stroke-linecap="round" stroke-linejoin="round">
|
||||
</g>
|
||||
<g id="SVGRepo_iconCarrier">
|
||||
<path fill="currentColor"
|
||||
d="M14.975 8.904L14.19 6.55l-1.552-4.67a.268.268 0 00-.255-.18.268.268 0 00-.254.18l-1.552 4.667H5.422L3.87 1.879a.267.267 0 00-.254-.179.267.267 0 00-.254.18l-1.55 4.667-.784 2.357a.515.515 0 00.193.583l6.78 4.812 6.778-4.812a.516.516 0 00.196-.583z">
|
||||
</path>
|
||||
</g>
|
||||
</svg>
|
||||
</a>
|
||||
<a href="https://reddit.com" target="_blank" rel="noopener" aria-label="Reddit">
|
||||
<svg class="footer-icon" viewBox="0 0 24 24" fill="currentColor">
|
||||
<path
|
||||
d="M12 0A12 12 0 0 0 0 12a12 12 0 0 0 12 12 12 12 0 0 0 12-12A12 12 0 0 0 12 0zm5.01 4.744c.688 0 1.25.561 1.25 1.249a1.25 1.25 0 0 1-2.498.056l-2.597-.547-.8 3.747c1.824.07 3.48.632 4.674 1.488.308-.309.73-.491 1.207-.491.968 0 1.754.786 1.754 1.754 0 .716-.435 1.333-1.01 1.614a3.111 3.111 0 0 1 .042.52c0 2.694-3.13 4.87-7.004 4.87-3.874 0-7.004-2.176-7.004-4.87 0-.183.015-.366.043-.534A1.748 1.748 0 0 1 4.028 12c0-.968.786-1.754 1.754-1.754.463 0 .898.196 1.207.49 1.207-.883 2.878-1.43 4.744-1.487l.885-4.182a.342.342 0 0 1 .14-.197.35.35 0 0 1 .238-.042l2.906.617a1.214 1.214 0 0 1 1.108-.702zM9.25 12C8.561 12 8 12.562 8 13.25c0 .687.561 1.248 1.25 1.248.687 0 1.248-.561 1.248-1.249 0-.688-.561-1.249-1.249-1.249zm5.5 0c-.687 0-1.248.561-1.248 1.25 0 .687.561 1.248 1.249 1.248.688 0 1.249-.561 1.249-1.249 0-.687-.562-1.249-1.25-1.249zm-5.466 3.99a.327.327 0 0 0-.231.094.33.33 0 0 0 0 .463c.842.842 2.484.913 2.961.913.477 0 2.105-.056 2.961-.913a.361.361 0 0 0 .029-.463.33.33 0 0 0-.464 0c-.547.533-1.684.73-2.512.73-.828 0-1.979-.197-2.512-.73a.326.326 0 0 0-.232-.095z" />
|
||||
</svg>
|
||||
</a>
|
||||
</div>
|
||||
</div>
|
||||
</footer>
|
||||
</div>
|
||||
<aside id="toc">
|
||||
<p class="toc-title">On this page</p>
|
||||
<ul id="toc-list"></ul>
|
||||
</aside>
|
||||
</div>
|
||||
</div>
|
||||
<script src="/assets/app.js"></script>
|
||||
</body>
|
||||
|
||||
</html>
|
||||
Reference in New Issue
Block a user