diff options
author | Joshua M. Boniface <joshua@boniface.me> | 2024-02-03 13:27:23 -0500 |
---|---|---|
committer | Joshua M. Boniface <joshua@boniface.me> | 2024-02-03 13:27:23 -0500 |
commit | 09213a671b13ccc2493a26e053f657ca3299aeb5 (patch) | |
tree | 1975b75b273b9fc33a9284c26e8d15421268d51e | |
download | jellyfin-packaging-09213a671b13ccc2493a26e053f657ca3299aeb5.tar.gz jellyfin-packaging-09213a671b13ccc2493a26e053f657ca3299aeb5.tar.bz2 jellyfin-packaging-09213a671b13ccc2493a26e053f657ca3299aeb5.zip |
Add initial commit of README explaining the repo
-rw-r--r-- | README.md | 62 |
1 files changed, 62 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..1805c6d --- /dev/null +++ b/README.md @@ -0,0 +1,62 @@ +<h1 align="center">Jellyfin</h1> +<h3 align="center">The Free Software Media System</h3> + +--- + +<p align="center"> +<img alt="Logo Banner" src="https://raw.githubusercontent.com/jellyfin/jellyfin-ux/master/branding/SVG/banner-logo-solid.svg?sanitize=true"/> +<br/> +<br/> +<a href="https://github.com/jellyfin/jellyfin"> +<img 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 alt="Current Release" src="https://img.shields.io/github/release/jellyfin/jellyfin.svg"/> +</a> +<a href="https://translate.jellyfin.org/projects/jellyfin/jellyfin-core/?utm_source=widget"> +<img alt="Translation Status" src="https://translate.jellyfin.org/widgets/jellyfin/-/jellyfin-core/svg-badge.svg"/> +</a> +<a href="https://dev.azure.com/jellyfin-project/jellyfin/_build?definitionId=29"> +<img alt="Azure Builds" src="https://dev.azure.com/jellyfin-project/jellyfin/_apis/build/status/Jellyfin%20Server"/> +</a> +<a href="https://hub.docker.com/r/jellyfin/jellyfin"> +<img alt="Docker Pull Count" src="https://img.shields.io/docker/pulls/jellyfin/jellyfin.svg"/> +</a> +<br/> +<a href="https://opencollective.com/jellyfin"> +<img alt="Donate" src="https://img.shields.io/opencollective/all/jellyfin.svg?label=backers"/> +</a> +<a href="https://features.jellyfin.org"> +<img alt="Submit Feature Requests" src="https://img.shields.io/badge/fider-vote%20on%20features-success.svg"/> +</a> +<a href="https://matrix.to/#/#jellyfinorg:matrix.org"> +<img alt="Chat on Matrix" src="https://img.shields.io/matrix/jellyfin:matrix.org.svg?logo=matrix"/> +</a> +<a href="https://www.reddit.com/r/jellyfin"> +<img alt="Join our Subreddit" src="https://img.shields.io/badge/reddit-r%2Fjellyfin-%23FF5700.svg"/> +</a> +<a href="https://github.com/jellyfin/jellyfin/releases.atom"> +<img alt="Release RSS Feed" src="https://img.shields.io/badge/rss-releases-ffa500?logo=rss" /> +</a> +<a href="https://github.com/jellyfin/jellyfin/commits/master.atom"> +<img alt="Master Commits RSS Feed" src="https://img.shields.io/badge/rss-commits-ffa500?logo=rss" /> +</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! + +This repository contains packaging for Jellyfin 10.9.0 and above, for use by manual builders or the CI system with GitHub workflows. + +Inside this repository are 6 major components: + +1. Submodules for the `jellyfin` and `jellyfin-web` repositories. These are dynamic submodules; while the repo has them committed at a given version, this is only updated on an official release build. Note that for simplicity, the `jellyfin` repo is in a folder here called `jellyfin-server`. + +2. Debian/Ubuntu packaging configurations (under `debian`). These will build the 3 Jellyfin packages (`jellyfin` metapackage, `jellyfin-server` core server, and `jellyfin-web` web client). Future packages (e.g. Vue) may be added here if and when they are promoted to a production build alongside the others. + +3. Fedora/CentOS packaging configurations (under `fedora`). These will build the same packages as Debian. + +4. Docker image builders. Like the above two as well, only building the combined Docker images. + +5. Script infrastructure to handle coordinating these builds from the main repos on a release trigger. |