From 7bc0c0d270e50cc38004d59dfde214471a28f61a Mon Sep 17 00:00:00 2001 From: dkanada Date: Wed, 10 Apr 2019 01:26:14 -0700 Subject: [PATCH 1/4] add page for tasks and update install options --- docs/administrator-docs/installing.md | 9 +++++---- docs/administrator-docs/tasks.md | 7 +++++++ 2 files changed, 12 insertions(+), 4 deletions(-) create mode 100644 docs/administrator-docs/tasks.md diff --git a/docs/administrator-docs/installing.md b/docs/administrator-docs/installing.md index 4b0b97b4d..94c57b582 100644 --- a/docs/administrator-docs/installing.md +++ b/docs/administrator-docs/installing.md @@ -35,6 +35,7 @@ Alternative docker-compose example: - /path/to/cache:/cache - /path/to/media:/media ``` + ### Unraid Docker An Unraid Docker template is available in the repository. @@ -72,17 +73,17 @@ Generic amd64 Linux builds in TAR archive format are available [here](https://re Platform-agnostic .NET Core DLL builds in TAR archive format are available [here](https://repo.jellyfin.org/releases/server/portable). These builds use the binary `jellyfin.dll` and must be loaded with `dotnet`. -## Arch AUR +## Arch -The Jellyfin package is in the AUR avilable [here](https://aur.archlinux.org/packages/jellyfin-git/). +Jellyfin is not yet available in the official repository but can be found [here](https://aur.archlinux.org/packages/jellyfin-git/) in the user repository. ## Fedora -Fedora 29 builds in RPM package format are available [here](https://repo.jellyfin.org/releases/server/fedora). Coming soon: an official Fedora repository. +Fedora 29 builds in RPM package format are available [here](https://repo.jellyfin.org/releases/server/fedora) for now but an official Fedora repository is coming soon. ## CentOS -CentOS/RHEL 7 builds in RPM package format are available [here](https://repo.jellyfin.org/releases/server/centos). Coming soon: an official CentOS/RHEL repository. +CentOS/RHEL 7 builds in RPM package format are available [here](https://repo.jellyfin.org/releases/server/centos) and an official CentOS/RHEL repository is planned for the future. ## Debian diff --git a/docs/administrator-docs/tasks.md b/docs/administrator-docs/tasks.md new file mode 100644 index 000000000..a7a295a18 --- /dev/null +++ b/docs/administrator-docs/tasks.md @@ -0,0 +1,7 @@ +# Tasks + +Tasks include any operations that are either too time consuming to always run within a library scan or not directly related to scanning media. One such example of a task is theoption to clean out old log files. They can either be run on demand by clicking the run button on the right of a task or at specific times by creating a trigger. + +The triggers can be set daily or weekly to run at a set time or on a specific interval if the former two are insufficient. There is also an option to simply run the task every time the server starts running. You can add more than one trigger depending on how often you want to run the task. + +Plugins can add their own tasks if they include operations that need to be run at specified intervals. These will also show up in the settings for you to configure. From 3dd3acf9154683265af62a68d3621d89e75cc09e Mon Sep 17 00:00:00 2001 From: dkanada Date: Wed, 10 Apr 2019 01:56:04 -0700 Subject: [PATCH 2/4] add new ldap plugin --- docs/administrator-docs/plugins.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/administrator-docs/plugins.md b/docs/administrator-docs/plugins.md index e3d1fd8ef..fbc1da079 100644 --- a/docs/administrator-docs/plugins.md +++ b/docs/administrator-docs/plugins.md @@ -44,6 +44,12 @@ All plugins hosted on the repository can be built from source and manually added [![](https://img.shields.io/github/contributors/jellyfin/jellyfin-plugin-iptv.svg)](https://github.com/jellyfin/jellyfin-plugin-iptv) [![](https://img.shields.io/github/license/jellyfin/jellyfin-plugin-iptv.svg)](https://github.com/jellyfin/jellyfin-plugin-iptv) +#### ldapauth + +[![](https://img.shields.io/github/languages/top/jellyfin/jellyfin-plugin-ldapauth.svg)](https://github.com/jellyfin/jellyfin-plugin-ldapauth) +[![](https://img.shields.io/github/contributors/jellyfin/jellyfin-plugin-ldapauth.svg)](https://github.com/jellyfin/jellyfin-plugin-ldapauth) +[![](https://img.shields.io/github/license/jellyfin/jellyfin-plugin-ldapauth.svg)](https://github.com/jellyfin/jellyfin-plugin-ldapauth) + #### reports [![](https://img.shields.io/github/languages/top/jellyfin/jellyfin-plugin-reports.svg)](https://github.com/jellyfin/jellyfin-plugin-reports) @@ -67,4 +73,3 @@ All plugins hosted on the repository can be built from source and manually added #### [antennas](https://github.com/TheJF/antennas) Takes your tuners in Tvheadend and emulates a HDHomeRun in order to connect to Jellyfin's DVR feature. That means any tuner whether dvb-t, dvb-c, dvb-s or ATSC can work with Jellyfin providing Tvheadend supports it (i.e you've installed the drivers for your tuner). It can be installed via binaries, Node or Docker. Set-up requires an anonymous user in Tvheadend with rights and streaming profiles as well as your channel list having the correct numbers. Configuration parameters are a URL that will show the status of Antennas, the URL of your Tvheadend installation with your username and password as well as the number of tuners you have. Then just setup your tuner in Jellyfin by selecting a HD Homerun then enter your Antennas URL. For setting up guide data, you have to use XMLTV. Either a link or .xml file will work. In the UK, I use the free xmltv.co.uk which gives me a link for 7 days guide data. - From 6edc0c08afaa80865a96fcdb0a485ec4ab19db50 Mon Sep 17 00:00:00 2001 From: dkanada Date: Wed, 10 Apr 2019 02:01:08 -0700 Subject: [PATCH 3/4] add plugins and merge developers and contributors --- .../coding-style.md | 0 docs/index.md | 8 ++++---- .../tvheadend.md} | 2 +- docs/user-docs/getting-help.md | 20 +++++++++---------- mkdocs.yml | 10 ++++++---- 5 files changed, 21 insertions(+), 19 deletions(-) rename docs/{developer-docs => contributor-docs}/coding-style.md (100%) rename docs/{user-docs/plugin-tvheadend-configuration.md => plugins/tvheadend.md} (98%) diff --git a/docs/developer-docs/coding-style.md b/docs/contributor-docs/coding-style.md similarity index 100% rename from docs/developer-docs/coding-style.md rename to docs/contributor-docs/coding-style.md diff --git a/docs/index.md b/docs/index.md index 272957321..58d03fbf4 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,7 +1,7 @@ # Welcome to Jellyfin

-Logo banner +Banner Image

GPL 2.0 License Current Release @@ -25,7 +25,7 @@ Note: Jellyfin is a fast moving project that is in its early stages, and this do Want to get starting using Jellyfin right now? Check out the pages below for how to get Jellyfin [installed](/administrator-docs/installing) on your machine. -* [Arch Linux](https://aur.archlinux.org/packages/jellyfin/) +* [Arch](/administrator-docs/installing#arch) * [Debian](/administrator-docs/installing#debian) * [Ubuntu](/administrator-docs/installing#ubuntu) * [Fedora](/administrator-docs/installing#fedora) @@ -52,7 +52,7 @@ Have questions about how Jellyfin works or encountering an error? Check out the Want to know more about administering a Jellyfin server? Check out these pages! -* [Quick-start guide](/administrator-docs/first-time): What to do after you've installed Jellyfin to get it up and running. +* [Quick-Start Guide](/administrator-docs/quick-start): What to do after you've installed Jellyfin to get it up and running. * [Migrating from Emby](/administrator-docs/migrate-from-emby): How to migrate an existing Emby 3.5.2 installation to Jellyfin. * [Plugins](/administrator-docs/plugins): How to install plugins in Jellyfin. * [Port Bindings](/administrator-docs/port-bindings) @@ -65,4 +65,4 @@ Want to help out? Check out the pages below for how to contribute. * [Plugin Guide](https://github.com/jellyfin/jellyfin-plugin-template): Documentation and resources to get started writing a plugin to extend Jellyfin functionality. * [Reporting bugs](/contributor-docs/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs. * [Requesting features](/contributor-docs/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements. -* [Code style guide](/developer-docs/coding-style): Code and naming style guide. +* [Code style guide](/contributor-docs/coding-style): Code and naming style guide. diff --git a/docs/user-docs/plugin-tvheadend-configuration.md b/docs/plugins/tvheadend.md similarity index 98% rename from docs/user-docs/plugin-tvheadend-configuration.md rename to docs/plugins/tvheadend.md index 4be48c483..484d14672 100644 --- a/docs/user-docs/plugin-tvheadend-configuration.md +++ b/docs/plugins/tvheadend.md @@ -1,4 +1,4 @@ -# Configuring Tvheadend for Jellyfin +# TVHeadend The objective of the guide is to configure the Jellyfin Tvheadend plugin to backend a Tvheadend server. diff --git a/docs/user-docs/getting-help.md b/docs/user-docs/getting-help.md index 286d5209b..c2341a71f 100644 --- a/docs/user-docs/getting-help.md +++ b/docs/user-docs/getting-help.md @@ -1,8 +1,8 @@ -# Getting Help with Jellyfin +# Getting Help If you are having trouble using or administrating Jellyfin, there are several ways to get help: -* The Jellyfin [Matrix/Riot channels](https://matrix.to/#/+jellyfin:matrix.org): For chat and real-time discussions. +* The Jellyfin [Matrix channels](https://matrix.to/#/+jellyfin:matrix.org): For chat and real-time discussions. * The Jellyfin [forums](https://forum.jellyfin.org): For long-term discussions. @@ -14,12 +14,12 @@ We are also active on social media: * [Twitter](https://twitter.com/jellyfin) -## Matrix channel list +## Matrix Channels -* jellyfin: General chat about the project -* jellyfin-announce: Announcements from the Core project team -* jellyfin-troubleshooting: User troubleshooting chat -* jellyfin-dev: Core development chat -* jellyfin-web-dev: Web UI development chat -* jellyfin-app-dev: App development chat -* jellyfin-offtopic: Off-topic chat about anything +* jellyfin: General chat related to the project +* jellyfin-announce: Announcements for releases and other important information +* jellyfin-troubleshooting: User troubleshooting +* jellyfin-dev: Main room for development communication +* jellyfin-web-dev: Web development +* jellyfin-app-dev: Client development +* jellyfin-offtopic: Chat about anything diff --git a/mkdocs.yml b/mkdocs.yml index dc5aff459..4187cc7bf 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,8 +8,8 @@ pages: - About: 'about.md' - FAQ: 'faq.md' - Users: - - Getting help: 'user-docs/getting-help.md' - - Client apps: 'user-docs/apps.md' + - Getting Help: 'user-docs/getting-help.md' + - Client Apps: 'user-docs/apps.md' - Administrators: - Installing Jellyfin: 'administrator-docs/installing.md' - Building from Source: 'administrator-docs/building.md' @@ -18,6 +18,7 @@ pages: - Connectivity: 'administrator-docs/connectivity.md' - Plugins: 'administrator-docs/plugins.md' - Reverse Proxy: 'administrator-docs/reverse-proxy.md' + - Tasks: 'administrator-docs/tasks.md' - Users: 'administrator-docs/users.md' - Contributors: - Contributing: 'contributor-docs/contributing.md' @@ -25,7 +26,8 @@ pages: - Development Procedure: 'contributor-docs/contributing-code.md' - Branding: 'contributor-docs/branding-guide.md' - Release Procedure: 'contributor-docs/release-procedure.md' - - Developers: - - Style Guidelines: 'developer-docs/coding-style.md' + - Style Guidelines: 'contributor-docs/coding-style.md' + - Plugins: + - TVHeadend: 'plugins/tvheadend.md' extra_css: - static/overrides.css From 716f060ab4289f0014902e219c8438f245b73060 Mon Sep 17 00:00:00 2001 From: dkanada Date: Wed, 10 Apr 2019 02:11:21 -0700 Subject: [PATCH 4/4] rename apps to clients and move user docs to root --- docs/{user-docs/apps.md => clients.md} | 11 +++++------ docs/{user-docs => }/getting-help.md | 0 docs/index.md | 22 +++++++--------------- mkdocs.yml | 5 ++--- 4 files changed, 14 insertions(+), 24 deletions(-) rename docs/{user-docs/apps.md => clients.md} (91%) rename docs/{user-docs => }/getting-help.md (100%) diff --git a/docs/user-docs/apps.md b/docs/clients.md similarity index 91% rename from docs/user-docs/apps.md rename to docs/clients.md index 8ac33f39d..7a4cb56d1 100644 --- a/docs/user-docs/apps.md +++ b/docs/clients.md @@ -1,10 +1,10 @@ -# Jellyfin Apps +# Clients -Apps connect your devices to your Jellyfin server and let you view your content on any supported device. You can find a list of apps, as well as their status, below. +Clients connect your devices to your Jellyfin server and let you view your content on any supported device. You can find a list of clients below with their current development status. -**Note**: Many apps were direct forks of the latest available codebases of Emby apps, and some are not functional yet or are deprecated. If you interested in helping out, please see our [contribution guide](/contributor-docs/contributing). +**Note**: Many clients were direct forks of the latest available codebases from Emby, and some are not functional yet. If you interested in helping out, please see our [contribution guide](/contributor-docs/contributing). -Do you have an app that interfaces with Jellyfin and would like to see it listed here? Please [submit a PR](https://github.com/jellyfin/jellyfin-docs)! +Do you have a client that interfaces with Jellyfin and want to see it listed here? Please [submit a PR](https://github.com/jellyfin/jellyfin-docs)! ## Android @@ -31,6 +31,7 @@ The official Jellyfin Android TV app. * [Binary repository](https://repo.jellyfin.org/releases/client/androidtv) #### Installation on Amazon Fire TV Stick + Currently the Jellyfin app isn't listed on the Fire TV's app store. In order to install it, you need to use a process known as "side loading". 1. Install the [Android SDK Platform Tools](https://developer.android.com/studio/releases/platform-tools.html) on your workstation @@ -102,7 +103,6 @@ The official Jellyfin Google Chrome extension. [GitHub](https://github.com/jellyfin/jellyfin-chrome) - ## Apple ### Jellyfin for Apple iOS @@ -156,7 +156,6 @@ The official Jellyfin Kodi plugin. This will help keep your media libraries up to date without waiting for a periodic resync from Kodi. - ## Roku ### Jellyfin for Roku diff --git a/docs/user-docs/getting-help.md b/docs/getting-help.md similarity index 100% rename from docs/user-docs/getting-help.md rename to docs/getting-help.md diff --git a/docs/index.md b/docs/index.md index 58d03fbf4..3681453ac 100644 --- a/docs/index.md +++ b/docs/index.md @@ -17,13 +17,13 @@ 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! -For more information about us, please see our [about page](/about). +You can find a list of all available clients [here](/clients). For more information please see our [about page](/about) or the [FAQ](/faq). If you are looking for help, check out [this page](/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 don't hesitate to contact us via our Matrix/Riot channels or our Subreddit! +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 don't hesitate to contact us via our Matrix channels or the subreddit! ## Getting Started -Want to get starting using Jellyfin right now? Check out the pages below for how to get Jellyfin [installed](/administrator-docs/installing) on your machine. +Want to get starting using Jellyfin right now? Check out the pages below for how to [install Jellyfin](/administrator-docs/installing) on your machine. * [Arch](/administrator-docs/installing#arch) * [Debian](/administrator-docs/installing#debian) @@ -40,14 +40,6 @@ Want to get starting using Jellyfin right now? Check out the pages below for how Alternatively, Jellyfin may be built directly from the [source code](/administrator-docs/building). -## User Documentation - -Have questions about how Jellyfin works or encountering an error? Check out the pages below for documentation. - -* [Frequently asked questions](/faq): Frequently asked questions about running Jellyfin. -* [Getting help](/user-docs/getting-help): How to get help with Jellyfin. -* [Client apps](/user-docs/apps): Details on the available client applications for Jellyfin. - ## Administrator Documentation Want to know more about administering a Jellyfin server? Check out these pages! @@ -61,8 +53,8 @@ Want to know more about administering a Jellyfin server? Check out these pages! Want to help out? Check out the pages below for how to contribute. -* [Contributing guide](/contributor-docs/contributing): General information on contributing to Jellyfin. +* [Contribution Guide](/contributor-docs/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](/contributor-docs/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs. -* [Requesting features](/contributor-docs/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements. -* [Code style guide](/contributor-docs/coding-style): Code and naming style guide. +* [Reporting Bugs](/contributor-docs/issues#reporting-bugs): How to use our issue tracker on GitHub to report bugs. +* [Requesting Features](/contributor-docs/issues#requesting-features): How to use our issue tracker on GitHub to request new features or enhancements. +* [Coding Style](/contributor-docs/coding-style): Code and naming style guide. diff --git a/mkdocs.yml b/mkdocs.yml index 4187cc7bf..db3da3d5b 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -7,9 +7,8 @@ pages: - Home: 'index.md' - About: 'about.md' - FAQ: 'faq.md' - - Users: - - Getting Help: 'user-docs/getting-help.md' - - Client Apps: 'user-docs/apps.md' + - Clients: 'clients.md' + - Getting Help: 'getting-help.md' - Administrators: - Installing Jellyfin: 'administrator-docs/installing.md' - Building from Source: 'administrator-docs/building.md'