mirror of
https://github.com/Tautulli/Tautulli.git
synced 2025-07-05 04:35:46 -07:00
Revert "GitBook: [nightly] 11 pages modified"
This reverts commit 2acb220f3e.
This commit is contained in:
jonny
JonnyWong16
parent
036c574600
commit
490b15b9a3
9 changed files with 807 additions and 434 deletions
49
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
49
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,49 @@
|
|||
---
|
||||
name: Bug Report
|
||||
about: Please do not use bug reports for support issues.
|
||||
title: ''
|
||||
labels: 'status:awaiting-triage, type:bug'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
<!---
|
||||
THIS IS NOT THE PLACE TO ASK FOR SUPPORT! Please use [Discord](https://tautulli.com/discord) for support issues.
|
||||
DO NOT ERASE THE TEMPLATE! Please complete the entire template.
|
||||
--->
|
||||
|
||||
**Describe the Bug**
|
||||
A clear and concise description of what the bug is.
|
||||
|
||||
**Steps to Reproduce**
|
||||
1. Go to '...'
|
||||
2. Click on '...'
|
||||
3. Scroll down to '...'
|
||||
4. See error
|
||||
|
||||
**Expected Behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
Provide screenshots to help explain your problem.
|
||||
|
||||
**Relevant Settings**
|
||||
- eg. Plex Media Server IP address/port/checkboxes/proxy/etc.
|
||||
- eg. Notification agent configuration/triggers/conditions/text/delay/grouping/etc.
|
||||
- eg. Newsletter agent configuration/checkboxes/template/etc.
|
||||
- Other settings
|
||||
|
||||
**Tautulli and System Info (see Tautulli settings page)**
|
||||
- Version: [eg. v2.6.6]
|
||||
- Git Branch: [eg. master]
|
||||
- Git Commit Hash: [eg. 2cc5bf812fe05e0666aeaeb37ed550c59816fb4c]
|
||||
- Platform and Version: [eg. Windows 10]
|
||||
- Python Version: [e.g. 3.8.8]
|
||||
- Browser and Version: [e.g. Chrome 88]
|
||||
|
||||
**Link to logs (required)**
|
||||
Include a link to your **FULL** logs (not just a few lines) on [Gist](http://gist.github.com).
|
||||
|
||||
<!--
|
||||
Close your issue when it's solved! If you found the solution yourself please comment so that others benefit from it.
|
||||
-->
|
||||
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
20
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
---
|
||||
name: Feature Request
|
||||
about: Suggest a new feature for Tautulli.
|
||||
title: ''
|
||||
labels: 'status:awaiting-triage, type:enhancement'
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Is your feature request related to a problem? Please describe.**
|
||||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
||||
|
||||
**Describe the solution you'd like**
|
||||
A clear and concise description of what you want to happen.
|
||||
|
||||
**Describe alternatives you've considered**
|
||||
A clear and concise description of any alternative solutions or features you've considered.
|
||||
|
||||
**Additional context**
|
||||
Add any other context or screenshots about the feature request here.
|
||||
20
.github/pull_request_template.md
vendored
Normal file
20
.github/pull_request_template.md
vendored
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
## Description
|
||||
|
||||
Please include a summary of the change and which issue is fixed.
|
||||
|
||||
Fixes #(issue)
|
||||
|
||||
## Type of change
|
||||
|
||||
Please delete options that are not relevant.
|
||||
|
||||
- [ ] Bug fix (non-breaking change which fixes an issue)
|
||||
- [ ] New feature (non-breaking change which adds functionality)
|
||||
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
||||
|
||||
## Checklist:
|
||||
|
||||
- [ ] My code follows the style guidelines of this project
|
||||
- [ ] I have performed a self-review of my own code
|
||||
- [ ] I have commented my code, particularly in hard-to-understand areas
|
||||
- [ ] I have added or updated the docstring for new or existing methods
|
||||
3
API.md
Normal file
3
API.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# API Reference
|
||||
|
||||
Tautulli API documentation has been moved to the [wiki page](https://github.com/Tautulli/Tautulli/wiki/Tautulli-API-Reference).
|
||||
File diff suppressed because it is too large
Load diff
|
|
@ -1,49 +1,41 @@
|
|||
# Contributing to Tautulli
|
||||
|
||||
## Pull Requests
|
||||
|
||||
If you think you can contribute code to the Tautulli repository, do not hesitate to submit a pull request.
|
||||
|
||||
### Branches
|
||||
|
||||
All pull requests should be based on the `nightly` branch, to minimize cross merges. When you want to develop a new feature, clone the repository with `git clone origin/nightly -b FEATURE_NAME`. Use meaningful commit messages.
|
||||
|
||||
### Python Code
|
||||
|
||||
#### Compatibility
|
||||
|
||||
The code should work with Python 3.6+. Note that Tautulli runs on many different platforms.
|
||||
|
||||
Re-use existing code. Do not hesitate to add logging in your code. You can the logger module `plexpy.logger.*` for this. Web requests are invoked via `plexpy.request.*` and derived ones. Use these methods to automatically add proper and meaningful error handling.
|
||||
|
||||
#### Code conventions
|
||||
Although Tautulli did not adapt a code convention in the past, we try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you (copied from http://wiki.ros.org/PyStyleGuide):
|
||||
|
||||
Although Tautulli did not adapt a code convention in the past, we try to follow the [PEP8](http://legacy.python.org/dev/peps/pep-0008/) conventions for future code. A short summary to remind you \(copied from [http://wiki.ros.org/PyStyleGuide](http://wiki.ros.org/PyStyleGuide)\):
|
||||
|
||||
* 4 space indentation
|
||||
* 80 characters per line
|
||||
* `package_name`
|
||||
* `ClassName`
|
||||
* `method_name`
|
||||
* `field_name`
|
||||
* `_private_something`
|
||||
* `self.__really_private_field`
|
||||
* `_global`
|
||||
* 4 space indentation
|
||||
* 80 characters per line
|
||||
* `package_name`
|
||||
* `ClassName`
|
||||
* `method_name`
|
||||
* `field_name`
|
||||
* `_private_something`
|
||||
* `self.__really_private_field`
|
||||
* `_global`
|
||||
|
||||
#### Documentation
|
||||
|
||||
Document your code. Use docstrings See [PEP-257](https://www.python.org/dev/peps/pep-0257/) for more information.
|
||||
|
||||
### HTML/Template code
|
||||
|
||||
#### Compatibility
|
||||
|
||||
HTML5 compatible browsers are targeted.
|
||||
|
||||
#### Conventions
|
||||
|
||||
* 4 space indentation
|
||||
* `methodName`
|
||||
* `variableName`
|
||||
* `ClassName`
|
||||
|
||||
191
README.md
191
README.md
|
|
@ -1,94 +1,163 @@
|
|||
# Tautulli
|
||||
|
||||
A python based web application for monitoring, analytics and notifications for [Plex Media Server](https://plex.tv).
|
||||
A python based web application for monitoring, analytics and notifications for
|
||||
[Plex Media Server](https://plex.tv).
|
||||
|
||||
This project is based on code from [Headphones](https://github.com/rembo10/headphones) and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb).
|
||||
This project is based on code from [Headphones](https://github.com/rembo10/headphones)
|
||||
and [PlexWatchWeb](https://github.com/ecleese/plexWatchWeb).
|
||||
|
||||
## Features
|
||||
|
||||
* Responsive web design viewable on desktop, tablet and mobile web browsers.
|
||||
* Themed to complement Plex/Web.
|
||||
* Easy configuration setup \(no separate web server required\).
|
||||
* Monitor current Plex Media Server activity.
|
||||
* Fully customizable notifications for stream activity and recently added media.
|
||||
* Top statistics on home page with configurable duration and measurement metric.
|
||||
* Global watching history with search/filtering & dynamic column sorting.
|
||||
* Full user list with general information and comparison stats.
|
||||
* Individual user information including devices IP addresses.
|
||||
* Complete library statistics and media file information.
|
||||
* Rich analytics presented using Highcharts graphing.
|
||||
* Beautiful content information pages.
|
||||
* Full sync list data on all users syncing items from your library.
|
||||
* And many more!!
|
||||
- Responsive web design viewable on desktop, tablet and mobile web browsers.
|
||||
- Themed to complement Plex/Web.
|
||||
- Easy configuration setup (no separate web server required).
|
||||
- Monitor current Plex Media Server activity.
|
||||
- Fully customizable notifications for stream activity and recently added media.
|
||||
- Top statistics on home page with configurable duration and measurement metric.
|
||||
- Global watching history with search/filtering & dynamic column sorting.
|
||||
- Full user list with general information and comparison stats.
|
||||
- Individual user information including devices IP addresses.
|
||||
- Complete library statistics and media file information.
|
||||
- Rich analytics presented using Highcharts graphing.
|
||||
- Beautiful content information pages.
|
||||
- Full sync list data on all users syncing items from your library.
|
||||
- And many more!!
|
||||
|
||||
## Preview
|
||||
|
||||
[Full preview gallery available on our website](http://tautulli.com)
|
||||
[Full preview gallery available on our website][Tautulli]
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
[](https://python.org/downloads) [](https://hub.docker.com/r/tautulli/tautulli) [](https://hub.docker.com/r/tautulli/tautulli) [](https://github.com/Tautulli/Tautulli/releases/latest)
|
||||
[![Python][badge-python]][Python]
|
||||
[![Docker Pulls][badge-docker-pulls]][DockerHub]
|
||||
[![Docker Stars][badge-docker-stars]][DockerHub]
|
||||
[![Downloads][badge-downloads]][Releases Latest]
|
||||
|
||||
\| --- \| --- \| --- \| --- \| \| Release \| [](https://github.com/Tautulli/Tautulli/releases/latest)
|
||||
[](https://github.com/Tautulli/Tautulli/releases/latest) \| [](https://github.com/Tautulli/Tautulli/releases)
|
||||
[](https://github.com/Tautulli/Tautulli/commits/beta) \| [](https://github.com/Tautulli/Tautulli/commits/nightly)
|
||||
[](https://github.com/Tautulli/Tautulli/commits/nightly) \| \| Docker \| [](https://hub.docker.com/r/tautulli/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Amaster) \| [](https://hub.docker.com/r/tautulli/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Abeta) \| [](https://hub.docker.com/r/tautulli/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Anightly) \| \| Snap \| [](https://snapcraft.io/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Amaster) \| [](https://snapcraft.io/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Abeta) \| [](https://snapcraft.io/tautulli)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Anightly) \| \| Installer \| [](https://github.com/Tautulli/Tautulli/releases/latest)
|
||||
[](https://github.com/Tautulli/Tautulli/releases/latest)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Amaster) \| [](https://github.com/Tautulli/Tautulli/releases)
|
||||
[](https://github.com/Tautulli/Tautulli/releases)
|
||||
[](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Abeta) \| [](https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Anightly) \|
|
||||
[badge-python]: https://img.shields.io/badge/python->=3.6-blue?style=flat-square
|
||||
[badge-docker-pulls]: https://img.shields.io/docker/pulls/tautulli/tautulli?style=flat-square
|
||||
[badge-docker-stars]: https://img.shields.io/docker/stars/tautulli/tautulli?style=flat-square
|
||||
[badge-downloads]: https://img.shields.io/github/downloads/Tautulli/Tautulli/total?style=flat-square
|
||||
|
||||
Read the [Installation Guides](https://github.com/Tautulli/Tautulli/wiki/Installation) for instructions on how to install Tautulli.
|
||||
| Status | Branch: `master` | Branch: `beta` | Branch: `nightly` |
|
||||
| --- | --- | --- | --- |
|
||||
| Release | [![Release@master][badge-release-master]][Releases Latest] <br> [![Release Date@master][badge-release-master-date]][Releases Latest] | [![Release@beta][badge-release-beta]][Releases] <br> [![Commits@beta][badge-release-beta-commits]][Commits Beta] | [![Last Commits@nightly][badge-release-nightly-last-commit]][commits Nightly] <br> [![Commits@nightly][badge-release-nightly-commits]][Commits Nightly] |
|
||||
| Docker | [![Docker@master][badge-docker-master]][DockerHub] <br> [![Docker Build@master][badge-docker-master-ci]][Publish Docker Master] | [![Docker@beta][badge-docker-beta]][DockerHub] <br> [![Docker Build@beta][badge-docker-beta-ci]][Publish Docker Beta] | [![Docker@nightly][badge-docker-nightly]][DockerHub] <br> [![Docker Build@nightly][badge-docker-nightly-ci]][Publish Docker Nightly] |
|
||||
| Snap | [![Snap@master][badge-snap-master]][Snapcraft] <br> [![Snap Build@master][badge-snap-master-ci]][Publish Snap Master] | [![Snap@beta][badge-snap-beta]][Snapcraft] <br> [![Snap Build@beta][badge-snap-beta-ci]][Publish Snap Beta] | [![Snap@nightly][badge-snap-nightly]][Snapcraft] <br> [![Snap Build@nightly][badge-snap-nightly-ci]][Publish Snap Nightly] |
|
||||
| Installer | [![Windows@master][badge-installer-master-win]][Releases Latest] <br> [![MacOS@master][badge-installer-master-macos]][Releases Latest] <br> [![Installer Build@master][badge-installer-master-ci]][Publish Installer Master] | [![Windows@beta][badge-installer-beta-win]][Releases] <br> [![MacOS@beta][badge-installer-beta-macos]][Releases] <br> [![Installer Build@beta][badge-installer-beta-ci]][Publish Installer Beta] | [![Installer Build@nightly][badge-installer-nightly-ci]][Publish Installer Nightly] |
|
||||
|
||||
Read the [Installation Guides][Installation] for instructions on how to install Tautulli.
|
||||
|
||||
[badge-release-master]: https://img.shields.io/github/v/release/Tautulli/Tautulli?style=flat-square
|
||||
[badge-release-master-date]: https://img.shields.io/github/release-date/Tautulli/Tautulli?style=flat-square&color=blue
|
||||
[badge-release-beta]: https://img.shields.io/github/v/release/Tautulli/Tautulli?include_prereleases&style=flat-square
|
||||
[badge-release-beta-commits]: https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/beta?style=flat-square&color=blue
|
||||
[badge-release-nightly-last-commit]: https://img.shields.io/github/last-commit/Tautulli/Tautulli/nightly?style=flat-square&color=blue
|
||||
[badge-release-nightly-commits]: https://img.shields.io/github/commits-since/Tautulli/Tautulli/latest/nightly?style=flat-square&color=blue
|
||||
[badge-docker-master]: https://img.shields.io/badge/docker-latest-blue?style=flat-square
|
||||
[badge-docker-master-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker/master?style=flat-square
|
||||
[badge-docker-beta]: https://img.shields.io/badge/docker-beta-blue?style=flat-square
|
||||
[badge-docker-beta-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker/beta?style=flat-square
|
||||
[badge-docker-nightly]: https://img.shields.io/badge/docker-nightly-blue?style=flat-square
|
||||
[badge-docker-nightly-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Docker/nightly?style=flat-square
|
||||
[badge-snap-master]: https://img.shields.io/badge/snap-stable-blue?style=flat-square
|
||||
[badge-snap-master-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Snap/master?style=flat-square
|
||||
[badge-snap-beta]: https://img.shields.io/badge/snap-beta-blue?style=flat-square
|
||||
[badge-snap-beta-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Snap/beta?style=flat-square
|
||||
[badge-snap-nightly]: https://img.shields.io/badge/snap-edge-blue?style=flat-square
|
||||
[badge-snap-nightly-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Snap/nightly?style=flat-square
|
||||
[badge-installer-master-win]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=windows&style=flat-square
|
||||
[badge-installer-master-macos]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=macos&style=flat-square
|
||||
[badge-installer-master-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Installers/master?style=flat-square
|
||||
[badge-installer-beta-win]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=windows&include_prereleases&style=flat-square
|
||||
[badge-installer-beta-macos]: https://img.shields.io/github/v/release/Tautulli/Tautulli?label=macos&include_prereleases&style=flat-square
|
||||
[badge-installer-beta-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Installers/beta?style=flat-square
|
||||
[badge-installer-nightly-ci]: https://img.shields.io/github/workflow/status/Tautulli/Tautulli/Publish%20Installers/nightly?style=flat-square
|
||||
|
||||
## Support
|
||||
|
||||
[](https://github.com/Tautulli/Tautulli/wiki) [](https://tautulli.com/discord) [](https://reddit.com/r/Tautulli) [](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242) [](https://github.com/Tautulli/Tautulli/issues)
|
||||
[![Wiki][badge-wiki]][Wiki]
|
||||
[![Discord][badge-discord]][Discord]
|
||||
[![Reddit][badge-reddit]][Reddit]
|
||||
[![Plex Forums][badge-forums]][Plex Forums]
|
||||
[![Issues][badge-issues]][Issues]
|
||||
|
||||
If you think you've found a bug in Tautulli make sure you have read the [FAQ](https://github.com/Tautulli/Tautulli/wiki/Frequently-Asked-Questions) first to make sure it hasn't been covered by one of the questions there. If your problem isn't answered in the FAQ try the following first:
|
||||
[badge-wiki]: https://img.shields.io/badge/github-wiki-black?style=flat-square
|
||||
[badge-discord]: https://img.shields.io/discord/183396325142822912?label=discord&style=flat-square&color=7289DA
|
||||
[badge-reddit]: https://img.shields.io/reddit/subreddit-subscribers/tautulli?label=reddit&style=flat-square&color=FF5700
|
||||
[badge-forums]: https://img.shields.io/badge/plex%20forums-discussion-E5A00D?style=flat-square
|
||||
[badge-issues]: https://img.shields.io/badge/github-issues-black?style=flat-square
|
||||
|
||||
* Update to the latest version of Tautulli.
|
||||
* Turning your device off and on again.
|
||||
* Analyzing your logs, you just might find the solution yourself!
|
||||
* Using the **search** function to see if this issue has already been reported/solved.
|
||||
* Checking the [Wiki](https://github.com/Tautulli/Tautulli/wiki) for [Installation](https://github.com/Tautulli/Tautulli/wiki/Installation) instructions and reading the [FAQs](https://github.com/Tautulli/Tautulli/wiki/Frequently-Asked-Questions).
|
||||
* For basic questions try asking on [Discord](https://tautulli.com/discord), [Reddit](https://reddit.com/r/Tautulli),
|
||||
If you think you've found a bug in Tautulli make sure you have read the [FAQ][]
|
||||
first to make sure it hasn't been covered by one of the questions there. If your
|
||||
problem isn't answered in the FAQ try the following first:
|
||||
|
||||
or the [Plex Forums](https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242) first before opening an issue.
|
||||
- Update to the latest version of Tautulli.
|
||||
- Turning your device off and on again.
|
||||
- Analyzing your logs, you just might find the solution yourself!
|
||||
- Using the **search** function to see if this issue has already been reported/solved.
|
||||
- Checking the [Wiki][] for [Installation][] instructions and reading the [FAQs][FAQ].
|
||||
- For basic questions try asking on [Discord][], [Reddit][],
|
||||
or the [Plex Forums][] first before opening an issue.
|
||||
|
||||
### If nothing has worked:
|
||||
##### If nothing has worked:
|
||||
|
||||
1. Please check the [issues tracker](https://github.com/Tautulli/Tautulli/issues) to see if someone else has already reported the bug.
|
||||
2. If this is a new bug, open a [bug report](https://github.com/Tautulli/Tautulli/issues/new/choose) on the issues tracker.
|
||||
3. Provide a clear title to easily help identify your problem.
|
||||
4. Use proper [Markdown syntax](https://help.github.com/articles/github-flavored-markdown) to structure your post \(i.e. code/log in code blocks\).
|
||||
5. Make sure to fill out the required information on the issue template.
|
||||
6. Close your issue when it's solved! If you found the solution yourself please
|
||||
|
||||
comment so that others benefit from it.
|
||||
1. Please check the [issues tracker][Issues] to see if someone else has already reported the bug.
|
||||
2. If this is a new bug, open a [bug report][Issue New] on the issues tracker.
|
||||
3. Provide a clear title to easily help identify your problem.
|
||||
4. Use proper [Markdown syntax][] to structure your post (i.e. code/log in code blocks).
|
||||
5. Make sure to fill out the required information on the issue template.
|
||||
6. Close your issue when it's solved! If you found the solution yourself please
|
||||
comment so that others benefit from it.
|
||||
|
||||
## Feature Requests
|
||||
|
||||
1. Pleases check the [issues tracker](https://github.com/Tautulli/Tautulli/issues) to see if someone else has already requested the feature.
|
||||
|
||||
If a similar idea has already been requested, _give it a thumbs up_. \*\*Do not comment
|
||||
|
||||
with `+1` or something similar as it creates unnecessary spam.\*\*
|
||||
|
||||
2. If this is a new feature request, open a [feature request](https://github.com/Tautulli/Tautulli/issues/new/choose) on the issues tracker.
|
||||
1. Pleases check the [issues tracker][Issues] to see if someone else has already requested the feature.
|
||||
If a similar idea has already been requested, _give it a thumbs up_. **Do not comment
|
||||
with `+1` or something similar as it creates unnecessary spam.**
|
||||
2. If this is a new feature request, open a [feature request][Issue New] on the issues tracker.
|
||||
|
||||
## License
|
||||
|
||||
[](https://github.com/Tautulli/Tautulli/blob/master/LICENSE)
|
||||
[![License][badge-license]][License]
|
||||
|
||||
This is free software under the GPL v3 open source license. Feel free to do with it what you wish, but any modification must be open sourced. A copy of the license is included.
|
||||
[badge-license]: https://img.shields.io/github/license/Tautulli/Tautulli?style=flat-square
|
||||
|
||||
This software includes Highsoft software libraries which you may freely distribute for non-commercial use. Commerical users must licence this software, for more information visit [https://shop.highsoft.com/faq/non-commercial\#non-commercial-redistribution](https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution).
|
||||
This is free software under the GPL v3 open source license. Feel free to do with it what you wish,
|
||||
but any modification must be open sourced. A copy of the license is included.
|
||||
|
||||
This software includes Highsoft software libraries which you may freely distribute for
|
||||
non-commercial use. Commerical users must licence this software, for more information visit
|
||||
https://shop.highsoft.com/faq/non-commercial#non-commercial-redistribution.
|
||||
|
||||
|
||||
[Python]: https://python.org/downloads
|
||||
[DockerHub]: https://hub.docker.com/r/tautulli/tautulli
|
||||
[Releases]: https://github.com/Tautulli/Tautulli/releases
|
||||
[Releases Latest]: https://github.com/Tautulli/Tautulli/releases/latest
|
||||
[License]: https://github.com/Tautulli/Tautulli/blob/master/LICENSE
|
||||
[FAQ]: https://github.com/Tautulli/Tautulli/wiki/Frequently-Asked-Questions
|
||||
[Installation]: https://github.com/Tautulli/Tautulli/wiki/Installation
|
||||
[Issues]: https://github.com/Tautulli/Tautulli/issues
|
||||
[Issue New]: https://github.com/Tautulli/Tautulli/issues/new/choose
|
||||
[Markdown syntax]: https://help.github.com/articles/github-flavored-markdown
|
||||
[Tautulli]: http://tautulli.com
|
||||
[Wiki]: https://github.com/Tautulli/Tautulli/wiki
|
||||
[Discord]: https://tautulli.com/discord
|
||||
[Reddit]: https://reddit.com/r/Tautulli
|
||||
[Plex Forums]: https://forums.plex.tv/t/tautulli-monitor-your-plex-media-server/225242
|
||||
[Snapcraft]: https://snapcraft.io/tautulli
|
||||
[Commits Beta]: https://github.com/Tautulli/Tautulli/commits/beta
|
||||
[Commits Nightly]: https://github.com/Tautulli/Tautulli/commits/nightly
|
||||
|
||||
[Publish Docker Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Amaster
|
||||
[Publish Docker Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Abeta
|
||||
[Publish Docker Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Docker"+branch%3Anightly
|
||||
[Publish Snap Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Amaster
|
||||
[Publish Snap Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Abeta
|
||||
[Publish Snap Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Snap"+branch%3Anightly
|
||||
[Publish Installer Master]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Amaster
|
||||
[Publish Installer Beta]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Abeta
|
||||
[Publish Installer Nightly]: https://github.com/Tautulli/Tautulli/actions?query=workflow%3A"Publish+Installers"+branch%3Anightly
|
||||
|
|
|
|||
|
|
@ -1,6 +0,0 @@
|
|||
# Table of contents
|
||||
|
||||
* [Tautulli](README.md)
|
||||
* [Changelog](changelog.md)
|
||||
* [Contributing to Tautulli](contributing.md)
|
||||
|
||||
64
init-scripts/init.systemd
Normal file
64
init-scripts/init.systemd
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
# Tautulli - Stats for Plex Media Server usage
|
||||
#
|
||||
# Service Unit file for systemd system manager
|
||||
#
|
||||
# INSTALLATION NOTES
|
||||
#
|
||||
# 1. Copy this file into your systemd service unit directory (often '/lib/systemd/system')
|
||||
# and name it 'tautulli.service' with the following command:
|
||||
# cp /opt/Tautulli/init-scripts/init.systemd /lib/systemd/system/tautulli.service
|
||||
#
|
||||
# 2. Edit the new tautulli.service file with configuration settings as required.
|
||||
# More details in the "CONFIGURATION NOTES" section shown below.
|
||||
#
|
||||
# 3. Enable boot-time autostart with the following commands:
|
||||
# systemctl daemon-reload
|
||||
# systemctl enable tautulli.service
|
||||
#
|
||||
# 4. Start now with the following command:
|
||||
# systemctl start tautulli.service
|
||||
#
|
||||
# CONFIGURATION NOTES
|
||||
#
|
||||
# - The example settings in this file assume that you will run Tautulli as user: tautulli
|
||||
# - The example settings in this file assume that Tautulli is installed to: /opt/Tautulli
|
||||
#
|
||||
# - To create this user and give it ownership of the Tautulli directory:
|
||||
# 1. Create the user:
|
||||
# Ubuntu/Debian: sudo addgroup tautulli && sudo adduser --system --no-create-home tautulli --ingroup tautulli
|
||||
# CentOS/Fedora: sudo adduser --system --no-create-home tautulli
|
||||
# 2. Give the user ownership of the Tautulli directory:
|
||||
# sudo chown -R tautulli:tautulli /opt/Tautulli
|
||||
#
|
||||
# - Adjust ExecStart= to point to:
|
||||
# 1. Your Python interpreter (get the path with "command -v python3")
|
||||
# - Default: /usr/bin/python3
|
||||
# 2. Your Tautulli executable
|
||||
# - Default: /opt/Tautulli/Tautulli.py
|
||||
# 3. Your config file (recommended is to put it somewhere in /etc)
|
||||
# - Default: --config /opt/Tautulli/config.ini
|
||||
# 4. Your datadir (recommended is to NOT put it in your Tautulli exec dir)
|
||||
# - Default: --datadir /opt/Tautulli
|
||||
#
|
||||
# - Adjust User= and Group= to the user/group you want Tautulli to run as.
|
||||
#
|
||||
# - WantedBy= specifies which target (i.e. runlevel) to start Tautulli for.
|
||||
# multi-user.target equates to runlevel 3 (multi-user text mode)
|
||||
# graphical.target equates to runlevel 5 (multi-user X11 graphical mode)
|
||||
|
||||
[Unit]
|
||||
Description=Tautulli - Stats for Plex Media Server usage
|
||||
Wants=network-online.target
|
||||
After=network-online.target
|
||||
|
||||
[Service]
|
||||
ExecStart=/usr/bin/python3 /opt/Tautulli/Tautulli.py --config /opt/Tautulli/config.ini --datadir /opt/Tautulli --quiet --nolaunch
|
||||
User=tautulli
|
||||
Group=tautulli
|
||||
Restart=on-abnormal
|
||||
RestartSec=5
|
||||
StartLimitInterval=90
|
||||
StartLimitBurst=3
|
||||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
Loading…
Add table
Add a link
Reference in a new issue