mirror of
https://github.com/jellyfin/jellyfin.org.git
synced 2025-06-06 19:11:32 +00:00
62 lines
5.0 KiB
Markdown
62 lines
5.0 KiB
Markdown
---
|
|
uid: intro
|
|
title: Introduction
|
|
sidebar-position: 1
|
|
---
|
|
|
|
# Welcome to the Jellyfin Documentation
|
|
|
|
<p align="center">
|
|
<a href="https://github.com/jellyfin/jellyfin"><img className="badge" alt="GPL 2.0 License" src="https://img.shields.io/github/license/jellyfin/jellyfin.svg"/></a>
|
|
<a href="https://github.com/jellyfin/jellyfin/releases"><img className="badge" alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"/></a>
|
|
<a href="https://translate.jellyfin.org/engage/jellyfin/?utm_source=widget"><img className="badge" alt="Translations" src="https://translate.jellyfin.org/widgets/jellyfin/-/svg-badge.svg"/></a>
|
|
<a href="https://cloud.drone.io/jellyfin/jellyfin"><img className="badge" alt="Build Status" src="https://cloud.drone.io/api/badges/jellyfin/jellyfin/status.svg"/></a>
|
|
<a href="https://hub.docker.com/r/jellyfin/jellyfin"><img className="badge" alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/jellyfin/jellyfin.svg"/></a>
|
|
<br/>
|
|
<a href="https://jellyfin.org"><img className="badge" alt="Visit our Website" src="https://img.shields.io/website/http/jellyfin.org.svg?up_message=online&down_message=offline"/></a>
|
|
<a href="https://forum.jellyfin.org"><img className="badge" alt="Join our Forum" src="https://img.shields.io/website/http/forum.jellyfin.org.svg?label=forum&up_message=online&down_message=offline"/></a>
|
|
<a href="https://matrix.to/#/+jellyfin:matrix.org"><img className="badge" alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/></a>
|
|
<a href="https://opencollective.com/jellyfin"><img className="badge" alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/></a>
|
|
</p>
|
|
|
|
Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. We welcome anyone who is interested in joining us in our quest!
|
|
|
|
You can find a list of all [available clients here](/downloads/clients). For more information please see our [about page](/docs/general/about) or the [FAQ](/docs/general/faq). If you are looking for help, [check out this page](/docs/general/getting-help) for all the different communication channels we use.
|
|
|
|
Note: Jellyfin is a fast-moving project that is in its early stages, and this documentation as well as the code may change frequently. Please check back often and do not hesitate to contact us via our Matrix channels or Forum!
|
|
|
|
## Getting Started
|
|
|
|
Want to get starting using Jellyfin right now? Check out the pages below for how to [install Jellyfin](/docs/general/installation) on your machine.
|
|
|
|
- [Windows](/docs/general/installation/windows)
|
|
- [macOS](/docs/general/installation/macos)
|
|
- [Debian / Ubuntu](/docs/general/installation/linux#debian--ubuntu-and-derivatives)
|
|
- [Other Linux Distributions](/docs/general/installation/linux#other-distributions)
|
|
- [Docker / Kubernetes / Podman](/docs/general/installation/container)
|
|
- [Synology](/docs/general/installation/advanced/synology)
|
|
- [TrueNAS SCALE](/docs/general/installation/advanced/truenas)
|
|
- [Generic Linux](/docs/general/installation/advanced/manual#portable-linux-install)
|
|
|
|
Alternatively, Jellyfin may be built directly from the [source code](/docs/general/installation/advanced/source).
|
|
|
|
## Administrator Documentation
|
|
|
|
Want to know more about administering a Jellyfin server? Check out these pages!
|
|
|
|
- [Migrating](/docs/general/administration/migrate): How to migrate Jellyfin.
|
|
- [Backup and Restore](/docs/general/administration/backup-and-restore): How to back up or restore your Jellyfin metadata and configuration.
|
|
- [Plugins](/docs/general/server/plugins): How to install and manage plugins.
|
|
- [Networking](/docs/general/post-install/networking): Networking settings and troubleshooting.
|
|
- [Monitoring](/docs/general/post-install/networking/advanced/monitoring): Integration with external monitoring software.
|
|
- [Hardware Acceleration](/docs/general/post-install/transcoding/hardware-acceleration): Improve transcoding performance on supported hardware.
|
|
|
|
## Contributing to Jellyfin
|
|
|
|
Want to help out? Check out the pages below for how to contribute.
|
|
|
|
- [Contribution Guide](/docs/general/contributing): General information on contributing to Jellyfin.
|
|
- [Plugin Guide](https://github.com/jellyfin/jellyfin-plugin-template): Documentation and resources to get started writing a plugin to extend Jellyfin functionality.
|
|
- [Reporting Bugs](/docs/general/contributing/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs.
|
|
- [Requesting Features](/docs/general/contributing/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements.
|