CINXE.COM

<!DOCTYPE html> <html lang="en" dir="ltr"> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> <title>PeerTube documentation</title> <meta name="description" content="Documentation of PeerTube, a free software to take back control of your videos!"> <meta name="generator" content="VitePress v1.5.0"> <link rel="preload stylesheet" href="/assets/style.DQWyBrDn.css" as="style"> <link rel="preload stylesheet" href="/vp-icons.css" as="style"> <script type="module" src="/assets/app.klHI3b_g.js"></script> <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin=""> <link rel="modulepreload" href="/assets/chunks/theme.CN56dYFF.js"> <link rel="modulepreload" href="/assets/chunks/framework.BsxN8CH-.js"> <link rel="modulepreload" href="/assets/index.md.DuO_FnMK.lean.js"> <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script> <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script> </head> <body> <div id="app"><div class="Layout" data-v-5d98c3a5><span tabindex="-1" data-v-0f60ec36></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-0f60ec36> Skip to content </a><header class="VPNav" data-v-5d98c3a5 data-v-ae24b3ad><div class="VPNavBar" data-v-ae24b3ad data-v-6aa21345><div class="wrapper" data-v-6aa21345><div class="container" data-v-6aa21345><div class="title" data-v-6aa21345><div class="VPNavBarTitle has-sidebar" data-v-6aa21345 data-v-1168a8e4><a class="title" href="/" data-v-1168a8e4><img class="VPImage dark logo" src="/brand-dark.png" alt data-v-8426fc1a><img class="VPImage light logo" src="/brand-light.png" alt data-v-8426fc1a></a></div></div><div class="content" data-v-6aa21345><div class="content-body" data-v-6aa21345><div class="VPNavBarSearch search" data-v-6aa21345><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div></div><div class="VPFlyout VPNavBarTranslations translations" data-v-6aa21345 data-v-88af2de4 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Change language" data-v-cf11d7a2><span class="text" data-v-cf11d7a2><span class="vpi-languages option-icon" data-v-cf11d7a2></span><span class="vpi-chevron-down text-icon" data-v-cf11d7a2></span></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><div class="items" data-v-88af2de4><p class="title" data-v-88af2de4>English</p><div class="VPMenuLink" data-v-88af2de4 data-v-35975db6><a class="VPLink link" href="/fr/" data-v-35975db6><span data-v-35975db6>Français</span></a></div></div></div></div></div><div class="VPNavBarAppearance appearance" data-v-6aa21345 data-v-6c893767><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-6c893767 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aa21345 data-v-0394ad82 data-v-7bc22406><a class="VPSocialLink no-icon" href="https://github.com/Chocobozzz/PeerTube" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a></div><div class="VPFlyout VPNavBarExtra extra" data-v-6aa21345 data-v-bb2aa2f0 data-v-cf11d7a2><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-cf11d7a2><span class="vpi-more-horizontal icon" data-v-cf11d7a2></span></button><div class="menu" data-v-cf11d7a2><div class="VPMenu" data-v-cf11d7a2 data-v-b98bc113><div class="group translations" data-v-bb2aa2f0><p class="trans-title" data-v-bb2aa2f0>English</p><div class="VPMenuLink" data-v-bb2aa2f0 data-v-35975db6><a class="VPLink link" href="/fr/" data-v-35975db6><span data-v-35975db6>Français</span></a></div></div><div class="group" data-v-bb2aa2f0><div class="item appearance" data-v-bb2aa2f0><p class="label" data-v-bb2aa2f0>Appearance</p><div class="appearance-action" data-v-bb2aa2f0><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-bb2aa2f0 data-v-5337faa4 data-v-1d5665e3><span class="check" data-v-1d5665e3><span class="icon" data-v-1d5665e3><span class="vpi-sun sun" data-v-5337faa4></span><span class="vpi-moon moon" data-v-5337faa4></span></span></span></button></div></div></div><div class="group" data-v-bb2aa2f0><div class="item social-links" data-v-bb2aa2f0><div class="VPSocialLinks social-links-list" data-v-bb2aa2f0 data-v-7bc22406><a class="VPSocialLink no-icon" href="https://github.com/Chocobozzz/PeerTube" aria-label="github" target="_blank" rel="noopener" data-v-7bc22406 data-v-bd121fe5><span class="vpi-social-github"></span></a></div></div></div></div></div></div><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-6aa21345 data-v-e5dd9c1c><span class="container" data-v-e5dd9c1c><span class="top" data-v-e5dd9c1c></span><span class="middle" data-v-e5dd9c1c></span><span class="bottom" data-v-e5dd9c1c></span></span></button></div></div></div></div><div class="divider" data-v-6aa21345><div class="divider-line" data-v-6aa21345></div></div></div></header><div class="VPLocalNav has-sidebar empty" data-v-5d98c3a5 data-v-a6f0e41e><div class="container" data-v-a6f0e41e><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-a6f0e41e><span class="vpi-align-left menu-icon" data-v-a6f0e41e></span><span class="menu-text" data-v-a6f0e41e>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-a6f0e41e data-v-17a5e62e><button data-v-17a5e62e>Return to top</button></div></div></div><aside class="VPSidebar" data-v-5d98c3a5 data-v-319d5ca6><div class="curtain" data-v-319d5ca6></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-319d5ca6><span class="visually-hidden" id="sidebar-aria-label" data-v-319d5ca6> Sidebar Navigation </span><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Install or upgrade PeerTube</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/install/any-os" data-v-b7550ba0><p class="text" data-v-b7550ba0>Any OS (recommended)</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/install/docker" data-v-b7550ba0><p class="text" data-v-b7550ba0>Docker</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/install/unofficial" data-v-b7550ba0><p class="text" data-v-b7550ba0>Unofficial</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Maintain PeerTube (sysadmin)</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/maintain/tools" data-v-b7550ba0><p class="text" data-v-b7550ba0>CLI tools</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/maintain/remote-storage" data-v-b7550ba0><p class="text" data-v-b7550ba0>Remote storage (S3)</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/maintain/configuration" data-v-b7550ba0><p class="text" data-v-b7550ba0>System configuration</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/maintain/migration" data-v-b7550ba0><p class="text" data-v-b7550ba0>Instance migration</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/maintain/observability" data-v-b7550ba0><p class="text" data-v-b7550ba0>Monitoring/Observability</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Administer PeerTube</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/following-instances" data-v-b7550ba0><p class="text" data-v-b7550ba0>Instance follows & redundancy</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/managing-users" data-v-b7550ba0><p class="text" data-v-b7550ba0>Manage Users & Auth</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/moderation" data-v-b7550ba0><p class="text" data-v-b7550ba0>Moderate your instance</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/configuration" data-v-b7550ba0><p class="text" data-v-b7550ba0>Configuration</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/remote-runners" data-v-b7550ba0><p class="text" data-v-b7550ba0>Remote runners</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/customize-instance" data-v-b7550ba0><p class="text" data-v-b7550ba0>Customize your instance</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/logs" data-v-b7550ba0><p class="text" data-v-b7550ba0>PeerTube logs</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/admin/privacy-guide" data-v-b7550ba0><p class="text" data-v-b7550ba0>Privacy guide</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Use PeerTube web</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/watch-video" data-v-b7550ba0><p class="text" data-v-b7550ba0>Watch, share, download a video</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/setup-account" data-v-b7550ba0><p class="text" data-v-b7550ba0>Setup your account</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/library" data-v-b7550ba0><p class="text" data-v-b7550ba0>User library</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/create-upload-video" data-v-b7550ba0><p class="text" data-v-b7550ba0>Publish a video or a live</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/studio" data-v-b7550ba0><p class="text" data-v-b7550ba0>Studio: quick edit for your videos</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/video-stats" data-v-b7550ba0><p class="text" data-v-b7550ba0>Video statistics</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/channel-sync" data-v-b7550ba0><p class="text" data-v-b7550ba0>Sync a remote channel</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/search" data-v-b7550ba0><p class="text" data-v-b7550ba0>Search</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/mute" data-v-b7550ba0><p class="text" data-v-b7550ba0>Mute instances/accounts</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/report" data-v-b7550ba0><p class="text" data-v-b7550ba0>Report content</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use/third-party-application" data-v-b7550ba0><p class="text" data-v-b7550ba0>Third-party applications</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Use PeerTube mobile</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use-mobile/get-the-app" data-v-b7550ba0><p class="text" data-v-b7550ba0>Get the app</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use-mobile/watch-video" data-v-b7550ba0><p class="text" data-v-b7550ba0>Watch videos</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/use-mobile/platforms" data-v-b7550ba0><p class="text" data-v-b7550ba0>The Platforms tab</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>Contribute on PeerTube</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/contribute/getting-started" data-v-b7550ba0><p class="text" data-v-b7550ba0>Getting started</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/contribute/plugins" data-v-b7550ba0><p class="text" data-v-b7550ba0>Plugins & Themes</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/contribute/architecture" data-v-b7550ba0><p class="text" data-v-b7550ba0>Architecture</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/contribute/code-of-conduct" data-v-b7550ba0><p class="text" data-v-b7550ba0>Code of conduct</p></a></div></div></div></section></div><div class="no-transition group" data-v-c40bc020><section class="VPSidebarItem level-0" data-v-c40bc020 data-v-b7550ba0><div class="item" role="button" tabindex="0" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><h2 class="text" data-v-b7550ba0>PeerTube API</h2></div><div class="items" data-v-b7550ba0><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/api/custom-client-markup" data-v-b7550ba0><p class="text" data-v-b7550ba0>Custom client markup</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/api/rest-getting-started" data-v-b7550ba0><p class="text" data-v-b7550ba0>Getting started with REST API</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link vp-external-link-icon link" href="/api-rest-reference.html" target="_blank" rel="noreferrer" data-v-b7550ba0><p class="text" data-v-b7550ba0>REST API reference</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/api/plugins" data-v-b7550ba0><p class="text" data-v-b7550ba0>Plugins & Themes API</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/api/embed-player" data-v-b7550ba0><p class="text" data-v-b7550ba0>Player embed API</p></a></div></div><div class="VPSidebarItem level-1 is-link" data-v-b7550ba0 data-v-b7550ba0><div class="item" data-v-b7550ba0><div class="indicator" data-v-b7550ba0></div><a class="VPLink link link" href="/api/activitypub" data-v-b7550ba0><p class="text" data-v-b7550ba0>ActivityPub</p></a></div></div></div></section></div></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-5d98c3a5 data-v-1428d186><div class="VPDoc has-sidebar has-aside" data-v-1428d186 data-v-39a288b8><div class="container" data-v-39a288b8><div class="aside" data-v-39a288b8><div class="aside-curtain" data-v-39a288b8></div><div class="aside-container" data-v-39a288b8><div class="aside-content" data-v-39a288b8><div class="VPDocAside" data-v-39a288b8 data-v-3f215769><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-3f215769 data-v-a5bbad30><div class="content" data-v-a5bbad30><div class="outline-marker" data-v-a5bbad30></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-a5bbad30>On this page</div><ul class="VPDocOutlineItem root" data-v-a5bbad30 data-v-b933a997></ul></div></nav><div class="spacer" data-v-3f215769></div></div></div></div></div><div class="content" data-v-39a288b8><div class="content-container" data-v-39a288b8><main class="main" data-v-39a288b8><div style="position:relative;" class="vp-doc _" data-v-39a288b8><div><div class="index-page"><h1 align="center"><a href="https://joinpeertube.org" target="_blank"><img class="brand-img" src="/brand.png" alt="PeerTube"></a></h1><p align="center"><strong><a href="https://joinpeertube.org">Website</a></strong> | <strong><a href="https://joinpeertube.org/instances">Join an instance</a></strong> | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance">Create a PeerTube platform</a></strong> | <strong><a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#contact">Chat with us</a></strong> | <strong><a href="https://framasoft.org/en/#soutenir">Donate</a></strong></p><p align="center"> Be part of a network of multiple small federated, interoperable video hosting providers. Follow video creators and create videos. No vendor lock-in. All on a platform that is community-owned and ad-free. </p><p align="center"><strong>Developed with ❤ by <a href="https://framasoft.org">Framasoft</a></strong></p><p align="center"><a href="https://framasoft.org" target="_blank"><img width="150px" src="/assets/framasoft.C62tEb1y.png" alt="Framasoft logo"></a></p><br><p align="center"><a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3" target="_blank"><img src="/assets/landing-page.Rl3b_haN.jpg" alt="screenshot"></a></p><h2 id="introduction" tabindex="-1">Introduction <a class="header-anchor" href="#introduction" aria-label="Permalink to "Introduction""></a></h2><p>PeerTube is a free, decentralized and federated video platform developed as an alternative to other platforms that centralize our data and attention, such as YouTube, Dailymotion or Vimeo. 🎬</p><p>To learn more:</p><ul><li>This <a href="https://framatube.org/videos/watch/217eefeb-883d-45be-b7fc-a788ad8507d3" target="_blank" rel="noreferrer">two-minute video</a> (hosted on PeerTube) explaining what PeerTube is and how it works</li><li>PeerTube's project homepage, <a href="https://joinpeertube.org" target="_blank" rel="noreferrer">joinpeertube.org</a></li><li>Demonstration platforms: <ul><li><a href="https://peertube.cpy.re" target="_blank" rel="noreferrer">peertube.cpy.re</a> (stable)</li><li><a href="https://peertube2.cpy.re" target="_blank" rel="noreferrer">peertube2.cpy.re</a> (Nightly)</li><li><a href="https://peertube3.cpy.re" target="_blank" rel="noreferrer">peertube3.cpy.re</a> (RC)</li></ul></li><li>This <a href="https://peertube.cpy.re/videos/watch/da2b08d4-a242-4170-b32a-4ec8cbdca701" target="_blank" rel="noreferrer">video</a> demonstrating the communication between PeerTube and <a href="https://github.com/tootsuite/mastodon" target="_blank" rel="noreferrer">Mastodon</a> (a decentralized Twitter alternative)</li></ul><h2 id="contributing" tabindex="-1">🙌 Contributing <a class="header-anchor" href="#contributing" aria-label="Permalink to ":raised_hands: Contributing""></a></h2><p>You don't need to be a programmer to help!</p><p>You can give us your feedback, report bugs, help us translate PeerTube, write documentation, and more. Check out the <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md" target="_blank" rel="noreferrer">contributing guide</a> to know how, it takes less than 2 minutes to get started. 😉</p><p>You can also join the cheerful bunch that makes our community:</p><ul><li>Chat<a name="contact"></a>: <ul><li>Matrix (bridged on IRC and <a href="https://discord.gg/wj8DDUT" target="_blank" rel="noreferrer">Discord</a>) : <strong><a href="https://matrix.to/#/#peertube:matrix.org" target="_blank" rel="noreferrer">#peertube:matrix.org</a></strong></li><li>IRC : <strong><a href="https://web.libera.chat/#peertube" target="_blank" rel="noreferrer">#peertube on irc.libera.chat:6697</a></strong></li></ul></li><li>Forum: <ul><li>Framacolibri: <a href="https://framacolibri.org/c/peertube" target="_blank" rel="noreferrer">https://framacolibri.org/c/peertube</a></li></ul></li></ul><p>Feel free to reach out if you have any questions or ideas! 💬</p><h2 id="create-your-own-peertube-platform" tabindex="-1">📦 Create your own PeerTube platform <a class="header-anchor" href="#create-your-own-peertube-platform" aria-label="Permalink to ":package: Create your own PeerTube platform""></a></h2><p>See the <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/production.md" target="_blank" rel="noreferrer">production guide</a>, which is the recommended way to install or upgrade PeerTube. For hardware requirements, see <a href="https://joinpeertube.org/faq#should-i-have-a-big-server-to-run-peertube" target="_blank" rel="noreferrer">Should I have a big server to run PeerTube?</a> in the FAQ.</p><p>See the <a href="https://docs.joinpeertube.org/install-unofficial" target="_blank" rel="noreferrer">community packages</a>, which cover various platforms (including <a href="https://install-app.yunohost.org/?app=peertube" target="_blank" rel="noreferrer">YunoHost</a> and <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/docker.md" target="_blank" rel="noreferrer">Docker</a>).</p><h2 id="documentation" tabindex="-1">📖 Documentation <a class="header-anchor" href="#documentation" aria-label="Permalink to ":book: Documentation""></a></h2><p>If you have a question, please try to find the answer in the <a href="https://joinpeertube.org/faq" target="_blank" rel="noreferrer">FAQ</a> first.</p><h3 id="user-documentation" tabindex="-1">User documentation <a class="header-anchor" href="#user-documentation" aria-label="Permalink to "User documentation""></a></h3><p>See the <a href="https://docs.joinpeertube.org/use-setup-account" target="_blank" rel="noreferrer">user documentation</a>.</p><h3 id="admin-documentation" tabindex="-1">Admin documentation <a class="header-anchor" href="#admin-documentation" aria-label="Permalink to "Admin documentation""></a></h3><p>See <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/README.md#package-create-your-own-instance" target="_blank" rel="noreferrer">how to create your own PeerTube platform</a>.</p><p>See the more general <a href="https://docs.joinpeertube.org/admin-following-instances" target="_blank" rel="noreferrer">admin documentation</a>.</p><h3 id="tools-documentation" tabindex="-1">Tools documentation <a class="header-anchor" href="#tools-documentation" aria-label="Permalink to "Tools documentation""></a></h3><p>Learn how to import/upload videos from CLI or admin your PeerTube platform with the <a href="https://docs.joinpeertube.org/maintain-tools" target="_blank" rel="noreferrer">tools documentation</a>.</p><h3 id="technical-documentation" tabindex="-1">Technical documentation <a class="header-anchor" href="#technical-documentation" aria-label="Permalink to "Technical documentation""></a></h3><p>See the <a href="https://docs.joinpeertube.org/contribute-architecture" target="_blank" rel="noreferrer">architecture blueprint</a> for a more detailed explanation of the architectural choices.</p><p>See our REST API documentation:</p><ul><li>OpenAPI 3.0.0 schema: <a href="https://github.com/Chocobozzz/PeerTube/blob/develop/support/doc/api/openapi.yaml" target="_blank" rel="noreferrer">/support/doc/api/openapi.yaml</a></li><li>Spec explorer: <a href="https://docs.joinpeertube.org/api-rest-reference.html" target="_blank" rel="noreferrer">docs.joinpeertube.org/api-rest-reference.html</a></li></ul><p>See our <a href="https://docs.joinpeertube.org/api-activitypub" target="_blank" rel="noreferrer">ActivityPub documentation</a>.</p></div></div></div></main><footer class="VPDocFooter" data-v-39a288b8 data-v-e257564d><div class="edit-info" data-v-e257564d><div class="edit-link" data-v-e257564d><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://framagit.org/framasoft/peertube/documentation/-/edit/master/docs/index.md" target="_blank" rel="noreferrer" data-v-e257564d><span class="vpi-square-pen edit-link-icon" data-v-e257564d></span> Edit this page</a></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-e257564d><span class="visually-hidden" id="doc-footer-aria-label" data-v-e257564d>Pager</span><div class="pager" data-v-e257564d></div><div class="pager" data-v-e257564d><a class="VPLink link pager-link next" href="/install/any-os" data-v-e257564d><span class="desc" data-v-e257564d>Next page</span><span class="title" data-v-e257564d>Any OS (recommended)</span></a></div></nav></footer></div></div></div></div></div></div></div> <script>window.__VP_HASH_MAP__=JSON.parse("{\"admin_configuration.md\":\"4aF10zQm\",\"admin_customize-instance.md\":\"DdQLdOgW\",\"admin_following-instances.md\":\"CL3LvEBn\",\"admin_logs.md\":\"2FNshzTV\",\"admin_managing-users.md\":\"VRF1dOHY\",\"admin_moderation.md\":\"CWFh7CUt\",\"admin_privacy-guide.md\":\"DAgCjTau\",\"admin_remote-runners.md\":\"BURGp61u\",\"api_activitypub.md\":\"DYD7mTUC\",\"api_custom-client-markup.md\":\"Dhdy_mZL\",\"api_embed-player.md\":\"DcOqyEil\",\"api_plugins.md\":\"gd-mDFqN\",\"api_rest-getting-started.md\":\"BWe9JXPg\",\"changelog.md\":\"DtGgssMI\",\"code_of_conduct.md\":\"Cm9uKd1W\",\"contribute_architecture.md\":\"D-dpeY0f\",\"contribute_code-of-conduct.md\":\"UiQQ60XH\",\"contribute_getting-started.md\":\"DddAiMD3\",\"contribute_plugins.md\":\"Bgi5PgVk\",\"contributing.md\":\"D9bOLF5R\",\"credits.md\":\"Cqf6tTaG\",\"fr_index.md\":\"COoGT1XR\",\"fr_use_create-upload-video.md\":\"RWCbSiN4\",\"fr_use_download-video.md\":\"5Co9wwDv\",\"fr_use_report.md\":\"BJQjC5rV\",\"fr_use_search.md\":\"DyKqP9v3\",\"fr_use_setup-account.md\":\"BI2ABdOA\",\"fr_use_share-video.md\":\"Dl47lkwD\",\"fr_use_studio.md\":\"B4BEIoGo\",\"fr_use_video-channels.md\":\"CNc8fyzn\",\"fr_use_video-history.md\":\"BdvcpDJi\",\"fr_use_video-playlist.md\":\"BU-YgIvs\",\"index.md\":\"DuO_FnMK\",\"install_any-os.md\":\"BxXVXELJ\",\"install_docker.md\":\"pTW1V_Dj\",\"install_unofficial.md\":\"w3_gSKny\",\"maintain_configuration.md\":\"rpBe6XQX\",\"maintain_migration.md\":\"BcuZ8fQZ\",\"maintain_observability.md\":\"DDllx24B\",\"maintain_remote-storage.md\":\"DXb7korp\",\"maintain_tools.md\":\"DF_jFQZO\",\"readme.md\":\"DsvesdTA\",\"support_doc_api_embeds.md\":\"DcUv9n61\",\"support_doc_api_quickstart.md\":\"Bvtg3Qoc\",\"support_doc_dependencies.md\":\"DRA-CWIU\",\"support_doc_development_ci.md\":\"BCtoxOkM\",\"support_doc_development_lib.md\":\"CPyDBvNb\",\"support_doc_development_localization.md\":\"CmXEUvl7\",\"support_doc_development_monitoring.md\":\"CsFiHQOc\",\"support_doc_development_release.md\":\"Biknw8Gq\",\"support_doc_development_server.md\":\"DiGqR71h\",\"support_doc_development_tests.md\":\"D1Sa1Hmp\",\"support_doc_docker.md\":\"DLCHhy1k\",\"support_doc_plugins_guide.md\":\"Dar-v9IE\",\"support_doc_production.md\":\"Boy5Ko9_\",\"support_doc_tools.md\":\"Dfmjxnd_\",\"support_doc_translation.md\":\"BFYdO4Fs\",\"use-mobile_get-the-app.md\":\"5N1O_dDt\",\"use-mobile_platforms.md\":\"Cdtyo1u7\",\"use-mobile_watch-video.md\":\"Dl7SgZnw\",\"use_channel-sync.md\":\"BiAXnxXf\",\"use_create-upload-video.md\":\"ClPY8fpw\",\"use_library.md\":\"CJctQCT8\",\"use_mute.md\":\"CggYnlCr\",\"use_report.md\":\"DVvLTx7P\",\"use_search.md\":\"DMvBOdDT\",\"use_setup-account.md\":\"Csce2wqP\",\"use_studio.md\":\"Cy8D8PT6\",\"use_third-party-application.md\":\"CTiy9PaM\",\"use_video-stats.md\":\"Bva8qURU\",\"use_watch-video.md\":\"BWKbYHqy\"}");function deserializeFunctions(r){return Array.isArray(r)?r.map(deserializeFunctions):typeof r=="object"&&r!==null?Object.keys(r).reduce((t,n)=>(t[n]=deserializeFunctions(r[n]),t),{}):typeof r=="string"&&r.startsWith("_vp-fn_")?new Function(`return ${r.slice(7)}`)():r};window.__VP_SITE_DATA__=deserializeFunctions(JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"PeerTube documentation\",\"description\":\"Documentation of PeerTube, a free software to take back control of your videos!\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"editLink\":{\"pattern\":\"_vp-fn_({ filePath }) => {\\n if (filePath === \\\"api/embed-player.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/api/embeds.md\\\";\\n }\\n if (filePath === \\\"api/rest-getting-started.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/api/quickstart.md\\\";\\n }\\n if (filePath === \\\"contribute/code-of-conduct.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/CODE_OF_CONDUCT.md\\\";\\n }\\n if (filePath === \\\"contribute/getting-started.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/.github/CONTRIBUTING.md\\\";\\n }\\n if (filePath === \\\"contribute/plugins.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/plugins/guide.md\\\";\\n }\\n if (filePath === \\\"install/any-os.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/production.md\\\";\\n }\\n if (filePath === \\\"install/docker.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/docker.md\\\";\\n }\\n if (filePath === \\\"maintain/tools.md\\\") {\\n return \\\"https://github.com/Chocobozzz/PeerTube/edit/develop/support/doc/tools.md\\\";\\n }\\n return \\\"https://framagit.org/framasoft/peertube/documentation/-/edit/master/docs/\\\" + filePath;\\n }\",\"text\":\"Edit this page\"},\"logo\":{\"light\":\"/brand-light.png\",\"dark\":\"/brand-dark.png\"},\"siteTitle\":false,\"sidebar\":{\"/\":[{\"text\":\"Install or upgrade PeerTube\",\"items\":[{\"text\":\"Any OS (recommended)\",\"link\":\"/install/any-os\"},{\"text\":\"Docker\",\"link\":\"/install/docker\"},{\"text\":\"Unofficial\",\"link\":\"/install/unofficial\"}]},{\"text\":\"Maintain PeerTube (sysadmin)\",\"items\":[{\"text\":\"CLI tools\",\"link\":\"/maintain/tools\"},{\"text\":\"Remote storage (S3)\",\"link\":\"/maintain/remote-storage\"},{\"text\":\"System configuration\",\"link\":\"/maintain/configuration\"},{\"text\":\"Instance migration\",\"link\":\"/maintain/migration\"},{\"text\":\"Monitoring/Observability\",\"link\":\"/maintain/observability\"}]},{\"text\":\"Administer PeerTube\",\"items\":[{\"text\":\"Instance follows & redundancy\",\"link\":\"/admin/following-instances\"},{\"text\":\"Manage Users & Auth\",\"link\":\"/admin/managing-users\"},{\"text\":\"Moderate your instance\",\"link\":\"/admin/moderation\"},{\"text\":\"Configuration\",\"link\":\"/admin/configuration\"},{\"text\":\"Remote runners\",\"link\":\"/admin/remote-runners\"},{\"text\":\"Customize your instance\",\"link\":\"/admin/customize-instance\"},{\"text\":\"PeerTube logs\",\"link\":\"/admin/logs\"},{\"text\":\"Privacy guide\",\"link\":\"/admin/privacy-guide\"}]},{\"text\":\"Use PeerTube web\",\"items\":[{\"text\":\"Watch, share, download a video\",\"link\":\"/use/watch-video\"},{\"text\":\"Setup your account\",\"link\":\"/use/setup-account\"},{\"text\":\"User library\",\"link\":\"/use/library\"},{\"text\":\"Publish a video or a live\",\"link\":\"/use/create-upload-video\"},{\"text\":\"Studio: quick edit for your videos\",\"link\":\"/use/studio\"},{\"text\":\"Video statistics\",\"link\":\"/use/video-stats\"},{\"text\":\"Sync a remote channel\",\"link\":\"/use/channel-sync\"},{\"text\":\"Search\",\"link\":\"/use/search\"},{\"text\":\"Mute instances/accounts\",\"link\":\"/use/mute\"},{\"text\":\"Report content\",\"link\":\"/use/report\"},{\"text\":\"Third-party applications\",\"link\":\"/use/third-party-application\"}]},{\"text\":\"Use PeerTube mobile\",\"items\":[{\"text\":\"Get the app\",\"link\":\"/use-mobile/get-the-app\"},{\"text\":\"Watch videos\",\"link\":\"/use-mobile/watch-video\"},{\"text\":\"The Platforms tab\",\"link\":\"/use-mobile/platforms\"}]},{\"text\":\"Contribute on PeerTube\",\"items\":[{\"text\":\"Getting started\",\"link\":\"/contribute/getting-started\"},{\"text\":\"Plugins & Themes\",\"link\":\"/contribute/plugins\"},{\"text\":\"Architecture\",\"link\":\"/contribute/architecture\"},{\"text\":\"Code of conduct\",\"link\":\"/contribute/code-of-conduct\"}]},{\"text\":\"PeerTube API\",\"items\":[{\"text\":\"Custom client markup\",\"link\":\"/api/custom-client-markup\"},{\"text\":\"Getting started with REST API\",\"link\":\"/api/rest-getting-started\"},{\"text\":\"REST API reference\",\"link\":\"/api-rest-reference.html\",\"target\":\"_blank\"},{\"text\":\"Plugins & Themes API\",\"link\":\"/api/plugins\"},{\"text\":\"Player embed API\",\"link\":\"/api/embed-player\"},{\"text\":\"ActivityPub\",\"link\":\"/api/activitypub\"}]}],\"/fr/\":[{\"text\":\"Utiliser PeerTube\",\"items\":[{\"text\":\"Configurer son profil\",\"link\":\"/fr/use/setup-account\"},{\"text\":\"Visionner, partager et télécharger une vidéo\",\"link\":\"/fr/use/share-video\"},{\"text\":\"Télécharger une vidéo\",\"link\":\"/fr/use/download-video\"},{\"text\":\"Chaîne de vidéos\",\"link\":\"/fr/use/video-channels\"},{\"text\":\"Playlistes de vidéos\",\"link\":\"/fr/use/video-playlist\"},{\"text\":\"Publier une vidéo ou un direct\",\"link\":\"/fr/use/create-upload-video\"},{\"text\":\"Modifier ses vidéos depuis l'interface web\",\"link\":\"/fr/use/studio\"},{\"text\":\"Historique des vidéos\",\"link\":\"/fr/use/video-history\"},{\"text\":\"Recherche\",\"link\":\"/fr/use/search\"},{\"text\":\"Signaler un contenu\",\"link\":\"/fr/use/report\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Chocobozzz/PeerTube\"}],\"i18nRouting\":false,\"outline\":{\"level\":\"deep\"},\"search\":{\"provider\":\"local\"}},\"locales\":{\"root\":{\"label\":\"English\",\"lang\":\"en\"},\"fr\":{\"label\":\"Français\",\"lang\":\"fr\"}},\"scrollOffset\":134,\"cleanUrls\":true}"));</script> </body> </html>