Add go2rtc package #5889

skrashevich · 2023-09-17T22:40:42Z

Description

This PR adds the go2rtc package, a camera streaming application with support for various protocols. The package version is 1.7.1. The Makefile, PLIST, and digests for the package are created. The package is also added to the Synology package manager with the necessary configuration files, service setup script, and user interface files for installation and upgrade wizards. The package is configured to run as a background service with a dedicated user group.

Checklist

Build rule all-supported completed successfully
New installation of package completed successfully
Package upgrade completed successfully (Manually install the package again)
Package functionality was tested
Any needed documentation is updated/created

Type of change

This commit adds the go2rtc package, a camera streaming application with support for various protocols. The package version is 1.7.1. The Makefile, PLIST, and digests for the package are created. The package is also added to the Synology package manager with the necessary configuration files, service setup script, and user interface files for installation and upgrade wizards. The package is configured to run as a background service with a dedicated user group.

skrashevich · 2023-09-20T03:37:10Z

now it doesn't depends on #5890

cross/go2rtc/Makefile

spk/go2rtc/Makefile

The maintainer of the go2rtc Makefile has been updated from AlexxIT to skrashevich. This change reflects the current responsibility for the maintenance of this file.

Co-authored-by: hgy59 <[email protected]>

cross/go2rtc/digests

hgy59 · 2023-09-20T23:30:59Z

@skrashevich some more suggestions

the package icon must be of quadratic shape (we prefer 512x512 pixel, or at least 256x256)
in service-setup.sh the config file must not be overwritten in package ugrade, it must only be created at first installation. Otherwise custom config settings will get lost on upgrade (you find examples in other packages, search for == "INSTALL")
this package uses port 8443 for srtp that is missing in the *.sc file. And this port is already in use by Synology CalDAV package. So the config file must define a different port for srtp
I propose to add a config.yml file to install with placeholders for user/password from the wizard.
I found that it is not possible to restart go2rtc within the web UI. We should document this, or (if it is possible) disable the Save & Restart Button (or modify the button to Save only). For Restart the DSM Package Center must be used.

sample log file:

Wed Sep 20 20:09:51 CEST 2023
Starting go2rtc command /volume1/@appstore/go2rtc/bin/go2rtc -config /volume1/@appstore/go2rtc/var/go2rtc.yaml
20:09:51.706 INF go2rtc version 1.6.2 linux/arm64
20:09:51.707 INF [api] listen addr=0.0.0.0:1984
20:09:51.707 INF [rtsp] listen addr=0.0.0.0:8554
20:09:51.708 INF [webrtc] listen addr=0.0.0.0:8555/tcp
20:09:51.709 INF [srtp] listen addr=0.0.0.0:8443

…-setup.sh to include the new configuration if the package status is INSTALL

skrashevich · 2023-09-24T12:52:54Z

I found that it is not possible to restart go2rtc within the web UI. We should document this, or (if it is possible) disable the Save & Restart Button (or modify the button to Save only). For Restart the DSM Package Center must be used.

AlexxIT/go2rtc#652 (backported in 4adbe55 )

cross/go2rtc/Makefile

Co-authored-by: hgy59 <[email protected]>

skrashevich · 2023-10-14T16:28:31Z

upd to 1.8.0

spk/go2rtc/Makefile

cross/go2rtc/digests

hgy59 · 2023-10-14T17:08:15Z

@skrashevich please avoid git force-push when ever possible (use only if required, e.g. when rebasing to master).

skrashevich · 2023-10-14T17:14:24Z

@hgy59 Please tell me about the possibility of merging this PR into main branch? I don't want to maintain package without real feedback

hgy59 · 2023-10-14T17:27:06Z

@hgy59 Please tell me about the possibility of merging this PR into main branch? I don't want to maintain package without real feedback

You created a PR ✅
One of the maintainers will approve it to run/enable the github build action
The github build action will create packages (artifacs) that can be manually downloaded and installed

Since there is still pending work in spk/go2rtc/Makefile (go2rtc_extra_install) I did not approve step 2. yet.
If go2rtc supports additionial configuration by environment variables, you should activate this and document how to use it in the environment-variables file, otherwise just remove the code and the file.
Such a environment-variables file should only be used if there is no other solution provided by the application like a config file.

skrashevich · 2023-10-14T17:31:23Z

What changes need to be made? Exactly; not brief ?

skrashevich · 2023-10-14T17:45:25Z

@AlexxIT need your opinion

hgy59 · 2023-10-14T19:29:12Z

@skrashevich I got the current version running on aarch64 with DSM 6.2.4 (DS-218+).

my findings so far:

go2rtc does not use variables from environment, so you can remove the environment-variables file and its installation code (leftover from minio package)
I highly recommend to install a go2rtc.yaml file by the package and not to create it in service_postinst. This will then need to replace some place holders by wizard variables (like service-setup.sh in spk/monit package)
We can omit the upgrade wizard. Currently it only asks for the web user and password again (but does not change anything in the configuration). Since the go2rtc.yaml file can be editet in the web ui, there is no need for such an upgrade wizard.
the one thing that is annoying are the color codes (esc sequences) in the log output. Probably it is possible to configure the log format for text only output, but I didn't find any documentation of this configuration parameter.
the CHANGELOG is not shown to the user that installs the package. So you really can remove any package related info from it...

If you don't mind, I can update your PR with my probosal.

skrashevich · 2023-10-14T20:14:35Z

I think it will be better if you update PR with your's proposal

- install go2rtc.yaml file - remove environment-variables file - remove obsolete variables - DSM_UI_DIR: no app icon is created in DSM UI (and app is the default DSM_UI_DIR anyway) - SPK_COMMANDS: there is no cli tool installed (go2rtc is used in SERVICE_COMMAND only) - use sed to inject wizard variables into config file at package installation - remove upgrade wizard

hgy59 · 2023-10-14T21:32:16Z

@skrashevich probably there is an error in go2rtc that should be reported upstream:

On the Streams page an empty "Version" is shown, but go2rtc -version displays the correct version Current version: 1.8.0.

hgy59 · 2023-10-14T21:39:42Z

@skrashevich is there any reason to configure strp as listen: 0.0.0.0:18443 instead of listen: :18443?

If it must be configured as 0.0.0.0:18443 and :18443 does not work as expected, it would be worth to document this in the yaml file. Otherwise we should omit the 0.0.0.0.

- avoid color codes in log output - make config file more expressive by adding all listening ports (even the default ones) - update WebRTC protocol description - remove obsolete PATCH_LEVEL and include in cross/go2rtc/Makefile

skrashevich · 2023-10-15T04:36:14Z

@skrashevich probably there is an error in go2rtc that should be reported upstream:

On the Streams page an empty "Version" is shown, but go2rtc -version displays the correct version Current version: 1.8.0.

it's known bug in 1.8.0 release, will be fixed soon

AlexxIT · 2023-10-15T04:45:40Z

@hgy59 I don't know why someone needs ipv6 in their home. Because SRTP used only for HomeKit right now. HomeKit is local thing.

With 0.0.0.0 - it will be ipv4, without - ipv4+ipv6.

skrashevich · 2023-10-15T04:46:04Z

@skrashevich is there any reason to configure strp as listen: 0.0.0.0:18443 instead of listen: :18443?

in this PR in config default value is ":18443". Where did you see 0.0.0.0:18443?

skrashevich · 2023-10-15T04:49:01Z

go2rtc does not use variables from environment, so you can remove the environment-variables file and its installation code (leftover from minio package)

go2rtc support templates for using environment variables in any part of config:
https://github.com/AlexxIT/go2rtc/wiki/Configuration#environment-variables

skrashevich · 2023-10-15T04:52:16Z

We can omit the upgrade wizard. Currently it only asks for the web user and password again (but does not change anything in the configuration). Since the go2rtc.yaml file can be editet in the web ui, there is no need for such an upgrade wizard.

so, I need just to delete upgrade_uifile.sh ?

hgy59 · 2023-10-15T09:48:55Z

so, I need just to delete upgrade_uifile.sh ?

already done in 6cfd3d4

hgy59 · 2023-10-15T09:58:05Z

go2rtc support templates for using environment variables in any part of config:
https://github.com/AlexxIT/go2rtc/wiki/Configuration#environment-variables

Thanks for this info.
But there is no need to use environment variables, you can use the config file.
AFAICR, in minio options must be set through environment variables as there is no configuration file.

hgy59 · 2023-10-15T10:01:35Z

in this PR in config default value is ":18443". Where did you see 0.0.0.0:18443?

This was your code before I added go2rtc.yaml to the package:

   if [ "${SYNOPKG_PKG_STATUS}" == "INSTALL" ]; then
      echo -e "api:\n  username: ${wizard_root_user}\n  password: ${wizard_root_password}\nsrtp:\n  listen: 0.0.0.0:18443" > ${GO2RTC_CFG_FILE}
   fi

skrashevich · 2023-10-16T11:09:32Z

well,
What is required by me now?

…o2rtc

hgy59 · 2023-10-16T17:23:31Z

Documented the ports used by go2rtc on https://github.com/SynoCommunity/spksrc/wiki/SynoCommunity-Used-Ports

cross/go2rtc/Makefile

spk/go2rtc/Makefile

skrashevich force-pushed the go2rtc branch from ce173f8 to d54aabc Compare September 17, 2023 22:49

hgy59 mentioned this pull request Sep 18, 2023

Update Go version to 1.21.1 #5890

Closed

10 tasks

Downgrade go2rtc version to 1.6.2

9dfeb8e

hgy59 reviewed Sep 20, 2023

View reviewed changes

cross/go2rtc/Makefile Outdated Show resolved Hide resolved

hgy59 reviewed Sep 20, 2023

View reviewed changes

cross/go2rtc/Makefile Show resolved Hide resolved

hgy59 reviewed Sep 20, 2023

View reviewed changes

spk/go2rtc/Makefile Outdated Show resolved Hide resolved

skrashevich and others added 2 commits September 20, 2023 15:47

Update Maintainer in go2rtc Makefile

77f0113

The maintainer of the go2rtc Makefile has been updated from AlexxIT to skrashevich. This change reflects the current responsibility for the maintenance of this file.

fix PKG_DIST_{NAME,SITE,FILE} vars in cross/go2rtc/Makefile

50d4e17

Co-authored-by: hgy59 <[email protected]>

hgy59 reviewed Sep 20, 2023

View reviewed changes

cross/go2rtc/digests Outdated Show resolved Hide resolved

Update Digests from 'v1.6.2.tar.gz' to 'go2rtc-1.6.2.tar.gz'.

6ca645e

skrashevich added 2 commits September 24, 2023 15:02

Update go2rtc.png

1bf3e5c

Add new configuration for go2rtc-srtp in go2rtc.sc and update service…

c3c7705

…-setup.sh to include the new configuration if the package status is INSTALL

skrashevich requested a review from hgy59 September 24, 2023 12:55

skrashevich added 2 commits September 24, 2023 17:09

backport AlexxIT/go2rtc#652

4adbe55

fix srtp port typo

04c5ce7

hgy59 reviewed Sep 24, 2023

View reviewed changes

cross/go2rtc/Makefile Outdated Show resolved Hide resolved

Update cross/go2rtc/Makefile

beb06cd

Co-authored-by: hgy59 <[email protected]>

skrashevich requested a review from hgy59 September 27, 2023 20:13

skrashevich added 2 commits September 30, 2023 05:29

update to 1.7.1 back with go1.20 support

e6fc19d

Merge remote-tracking branch 'upstream/master' into go2rtc

04276aa

skrashevich force-pushed the go2rtc branch from a09e135 to 176126b Compare October 14, 2023 16:27

hgy59 reviewed Oct 14, 2023

View reviewed changes

spk/go2rtc/Makefile Outdated Show resolved Hide resolved

hgy59 reviewed Oct 14, 2023

View reviewed changes

cross/go2rtc/digests Outdated Show resolved Hide resolved

v1.8.0

39da1af

skrashevich force-pushed the go2rtc branch from 176126b to 39da1af Compare October 14, 2023 17:00

upd changelog

e8f8621

hgy59 mentioned this pull request Oct 14, 2023

fix display of Version in web ui AlexxIT/go2rtc#691

Closed

update config

063e498

- avoid color codes in log output - make config file more expressive by adding all listening ports (even the default ones) - update WebRTC protocol description - remove obsolete PATCH_LEVEL and include in cross/go2rtc/Makefile

force use of ipv4 for srtp

9845cf1

skrashevich added 2 commits October 16, 2023 14:16

v1.8.1

7c3da3f

Merge branch 'go2rtc' of https://github.com/skrashevich/spksrc into g…

e499c05

…o2rtc

hgy59 approved these changes Oct 16, 2023

View reviewed changes

cross/go2rtc/Makefile Outdated Show resolved Hide resolved

spk/go2rtc/Makefile Outdated Show resolved Hide resolved

hgy59 merged commit 71d20d0 into SynoCommunity:master Oct 18, 2023
17 checks passed

hgy59 added the status/published Published and activated (may take up to 48h until visible in DSM package manager) label Oct 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add go2rtc package #5889

Add go2rtc package #5889

skrashevich commented Sep 17, 2023 •

edited

Loading

skrashevich commented Sep 20, 2023 •

edited

Loading

hgy59 commented Sep 20, 2023

skrashevich commented Sep 24, 2023 •

edited

Loading

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023 •

edited

Loading

skrashevich commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 15, 2023

AlexxIT commented Oct 15, 2023 •

edited

Loading

skrashevich commented Oct 15, 2023

skrashevich commented Oct 15, 2023

skrashevich commented Oct 15, 2023

hgy59 commented Oct 15, 2023

hgy59 commented Oct 15, 2023

hgy59 commented Oct 15, 2023

skrashevich commented Oct 16, 2023 •

edited

Loading

hgy59 commented Oct 16, 2023

Add go2rtc package #5889

Add go2rtc package #5889

Conversation

skrashevich commented Sep 17, 2023 • edited Loading

Description

Checklist

Type of change

skrashevich commented Sep 20, 2023 • edited Loading

hgy59 commented Sep 20, 2023

skrashevich commented Sep 24, 2023 • edited Loading

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023 • edited Loading

skrashevich commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 14, 2023

hgy59 commented Oct 14, 2023

hgy59 commented Oct 14, 2023

skrashevich commented Oct 15, 2023

AlexxIT commented Oct 15, 2023 • edited Loading

skrashevich commented Oct 15, 2023

skrashevich commented Oct 15, 2023

skrashevich commented Oct 15, 2023

hgy59 commented Oct 15, 2023

hgy59 commented Oct 15, 2023

hgy59 commented Oct 15, 2023

skrashevich commented Oct 16, 2023 • edited Loading

hgy59 commented Oct 16, 2023

skrashevich commented Sep 17, 2023 •

edited

Loading

skrashevich commented Sep 20, 2023 •

edited

Loading

skrashevich commented Sep 24, 2023 •

edited

Loading

hgy59 commented Oct 14, 2023 •

edited

Loading

AlexxIT commented Oct 15, 2023 •

edited

Loading

skrashevich commented Oct 16, 2023 •

edited

Loading