Skip to content

Commit

Permalink
🎉 Release of add-on TVHeadend 3.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
dfigus committed Dec 22, 2023
1 parent 9eb018c commit 87b819a
Show file tree
Hide file tree
Showing 7 changed files with 248 additions and 0 deletions.
23 changes: 23 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,19 @@ https://github.com/dfigus/hassio-addons-beta

## Add-ons provided by this repository

### ✓ [TVHeadend][addon-tvheadend]

![Latest Version][tvheadend-version-shield]
![Supports armhf Architecture][tvheadend-armhf-shield]
![Supports armv7 Architecture][tvheadend-armv7-shield]
![Supports aarch64 Architecture][tvheadend-aarch64-shield]
![Supports amd64 Architecture][tvheadend-amd64-shield]
![Supports i386 Architecture][tvheadend-i386-shield]

TV streaming server and recorder.

[:books: TVHeadend add-on documentation][addon-doc-tvheadend]

## Releases

Releases are based on [Semantic Versioning][semver], and use the format
Expand All @@ -59,6 +72,7 @@ You have several options to get them answered:
separate GitHub repository for each add-on. Please ensure you are creating
the issue on the correct GitHub repository matching the add-on.

- [Open an issue for the add-on: TVHeadend][tvheadend-issue]

For a general repository issue or add-on ideas [open an issue here][issue]

Expand Down Expand Up @@ -96,6 +110,15 @@ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[addon-tvheadend]: https://github.com/dfigus/addon-tvheadend/tree/v3.1.1
[addon-doc-tvheadend]: https://github.com/dfigus/addon-tvheadend/blob/v3.1.1/README.md
[tvheadend-issue]: https://github.com/dfigus/addon-tvheadend/issues
[tvheadend-version-shield]: https://img.shields.io/badge/version-v3.1.1-blue.svg
[tvheadend-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
[tvheadend-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
[tvheadend-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg
[tvheadend-armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg
[tvheadend-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg
[dfigus]: https://github.com/dfigus
[issue]: https://github.com/dfigus/hassio-addons-beta/issues
[license-shield]: https://img.shields.io/github/license/dfigus/hassio-addons-beta.svg
Expand Down
22 changes: 22 additions & 0 deletions tvheadend/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## What's Changed
* Add Panel Icons by @dfigus in https://github.com/dfigus/addon-tvheadend/pull/12
* ⬆️ Bump actions/checkout from 3 to 4 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/18
* ⬆️ Bump actions/cache from 3.2.6 to 3.3.2 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/17
* ⬆️ Bump docker/build-push-action from 4.0.0 to 5.1.0 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/16
* Bump peter-evans/repository-dispatch from 2.1.1 to 2.1.2 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/21
* Bump docker/setup-qemu-action from 2.1.0 to 3.0.0 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/20
* ⬆️ Bump docker/setup-buildx-action from 2.4.1 to 3.0.0 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/15
* ⬆️ Bump docker/login-action from 2.1.0 to 3.0.0 by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/13
* ⬆️ Bump streamlink from 6.4.1 to 6.4.2 in /tvheadend by @dependabot in https://github.com/dfigus/addon-tvheadend/pull/14
* Configure Renovate by @renovate in https://github.com/dfigus/addon-tvheadend/pull/19
* ⬆️ Update Add-on base image to v14.3.3 by @renovate in https://github.com/dfigus/addon-tvheadend/pull/23
* Introduce Edge & Beta Repositories by @dfigus in https://github.com/dfigus/addon-tvheadend/pull/25
* Fix deploy workflow by @dfigus in https://github.com/dfigus/addon-tvheadend/pull/26
* Update docs by @dfigus in https://github.com/dfigus/addon-tvheadend/pull/27
* Update License by @dfigus in https://github.com/dfigus/addon-tvheadend/pull/28
* ⬆️ Update streamlink to v6.5.0 by @renovate in https://github.com/dfigus/addon-tvheadend/pull/29

## New Contributors
* @dependabot made their first contribution in https://github.com/dfigus/addon-tvheadend/pull/18

**Full Changelog**: https://github.com/dfigus/addon-tvheadend/compare/v3.1.0...v3.1.1
137 changes: 137 additions & 0 deletions tvheadend/DOCS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,137 @@
# Home Assistant Community Add-on: TVHeadend

TVHeadend is a TV streaming server and recorder supporting:
DVB-S, DVB-S2, DVB-C, DVB-T, DVB-T2, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun
as input sources.
TVHeadend offers the HTTP (VLC, MPlayer), HTSP (Kodi, Movian) and SAT>IP streaming.

Multiple EPG sources are supported such as
over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML.

Have included the following along with TVHeadend:
-Webgrab+
-Streamlink

## Installation

The installation of this add-on is pretty straightforward and not different in
comparison to installing any other Home Assistant add-on.

1. Add this repository to have addons by Daniel Figus:
[![Home Assistant with repository URL pre-filled][my-ha-shield]][my-ha-repo]
1. Search for the "TVHeadend" add-on in the Supervisor add-on store and install it.
1. Start the "TVHeadend" add-on.
1. Check the logs of the "TVHeadend" to see if everything went well.
1. Click the "OPEN WEB UI" button and start using it.
1. Ready to go!

## Configuration

**Note**: _Remember to restart the add-on when the configuration is changed._

Example add-on configuration:

```yaml
system_packages:
- ffmpeg
init_commands:
- echo 'Hello World'
```
**Note**: _This is just an example, don't copy and paste it! Create your own!_
### Option: `system_packages`

Allows you to specify additional [Alpine packages][alpine-packages] to be
installed to the TVHeadend Addon (e.g., `ffmpeg`, `g++`, etc. ).

**Note**: _Adding many packages will result in a longer start-up time for the add-on._

### Option: `init_commands`

Customize your TVHeadend environment even more with the `init_commands` option.
Add one or more shell commands to the list, and they will be executed
every single time this add-on starts.

### Option: `args`

Additional startup arguments to be passed to TVHeadend. A list of command line
arguments can be found [here](https://github.com/tvheadend/tvheadend/blob/master/docs/markdown/cmdline_options.md).
The addon itself will use the following arguments, hence do not use them:

- `-C, --firstrun`: To create the initial access control entry
- `--http-root`: This will be set to the HA `ingress_path` to enable the HA Ingress feature

If you use a Fritz!Box with integrated DVC-C tuners, you might want to use the
`--satip_xml http://<your Fritz!BoxIP>:49000/satipdesc.xml` argument.

## Additional Details

- Config files are stored in `/config/tvheadend/`
- Recording files are stored in `/config/tvheadend/recordings/`
- `/dev/dvb/`, `/dev/dri/` would be respectively mapped to
`/dev/dvb/`, `/dev/dri/` inside the addon.

Consider, backing `/config/tvheadend/` up whenever migrating.

## Changelog & Releases

This repository keeps a change log using [GitHub's releases][releases]
functionality.

Releases are based on [Semantic Versioning][semver], and use the format
of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented
based on the following:

- `MAJOR`: Incompatible or major changes.
- `MINOR`: Backwards-compatible new features and enhancements.
- `PATCH`: Backwards-compatible bugfixes and package updates.

## Support

Got questions?

You have several options to get them answered:

- The Home Assistant [Community Forum][forum].
- You could also [open an issue here][issue] GitHub.

## Authors & contributors

This repository is owned and maintained by [Daniel Figus][dfigus].

This has been possible thanks to the community add-ons initiative by [Frenck][frenck]

## License

MIT License

Copyright (c) 2023-2024 Daniel Figus

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

[alpine-packages]: https://pkgs.alpinelinux.org/packages
[forum]: https://community.home-assistant.io/
[frenck]: https://github.com/frenck
[dfigus]: https://github.com/dfigus
[my-ha-shield]: https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg
[issue]: https://github.com/dfigus/addon-tvheadend/issues
[semver]: http://semver.org/spec/v2.0.0.htm
[my-ha-repo]: https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fdfigus%2Fhassio-addons
[releases]: https://github.com/dfigus/addon-tvheadend/releases
26 changes: 26 additions & 0 deletions tvheadend/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# Home Assistant Community Add-on: TVHeadend

[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield]

[![Community Forum][forum-shield]][forum]

TVHeadend add-on by Daniel Figus.

## About

TVHeadend is a TV streaming server and recorder supporting:
DVB-S, DVB-S2, DVB-C, DVB-T, DVB-T2, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun
as input sources.
TVHeadend offers the HTTP (VLC, MPlayer), HTSP (Kodi, Movian) and SAT>IP streaming.

Multiple EPG sources are supported (over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML).

Have included the following along with TVHeadend:
-Webgrab+
-Streamlink

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg
[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg
[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
[release-shield]: https://img.shields.io/badge/version-v3.1.1-blue.svg
[release]: https://github.com/dfigus/addon-tvheadend/tree/v3.1.1
40 changes: 40 additions & 0 deletions tvheadend/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: TVHeadend
version: 3.1.1
stage: experimental
slug: tvheadend
description: TV streaming server and recorder.
url: https://github.com/dfigus/addon-tvheadend
ingress: true
ingress_stream: true
ingress_port: 80
init: false
panel_icon: mdi:television
arch:
- aarch64
- amd64
- armhf
- armv7
- i386
host_network: true
devices:
- /dev/dvb
- /dev/dri
ports:
9981/tcp: 9981
9982/tcp: 9982
ports_description:
9981/tcp: TVH Web Interface
9982/tcp: TVH HTSP
map:
- config:rw
options:
system_packages: []
init_commands: []
args: ''
schema:
system_packages:
- str
init_commands:
- str
args: str
image: ghcr.io/dfigus/tvheadend/{arch}
Binary file added tvheadend/icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added tvheadend/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 87b819a

Please sign in to comment.