vdradmin-am/README at master · vdr-projects/vdradmin-am · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
This is the "VDRAdmin-AM" a web user interface for VDR.

Written by:                  Andreas Mair (andreas AT vdr - developer DOT org)

Project's homepage:          https://github.com/vdr-projects/vdradmin-am
                             (<= 3.6.10: http://andreas.vdr-developer.org)

Latest version available at: https://github.com/vdr-projects/vdradmin-am
                             (<= 3.6.10: http://andreas.vdr-developer.org)


License
-------

	This program is free software; you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation; either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License along
	with this program; if not, write to the Free Software Foundation, Inc.,
	51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

See the file COPYING for the full GNU GENERAL PUBLIC LICENSE Version 2 (GPLv2).

"Bubblehelp infoboxes" (templates/default/infobox.js) is licensed under
GNU GENERAL PUBLIC LICENSE Version 2 (GPLv2) *only*.

"Crystal Theme Icons" are licensed under GNU LESSER GENERAL PUBLIC LICENSE v2.1
(LGPLv2.1), see LGPL.txt.


Requirements
------------

- VDR (http://www.tvdr.de/)
- Some Perl modules (see "./install.sh -p"):
  - Required:
	  - Template
	  - Template::Plugin::JavaScript
	  - CGI
	  - HTTP::Date
	  - IO::Socket
	  - Time::Local
	  - MIME::Base64
	  - File::Temp
	  - File::Find
	  - URI
	  - URI::Escape
	  - HTTP::Tiny
	  - HTTP::Daemon
	  - Locale::gettext OR Locale::Messages
	- Optional:
	  - Required for built-in HTTP response compression:
	    - Compress::Zlib
	  - Required for AutoTimer email notification:
	    - Net::SMTP
	    - Authen::SASL
	  - Required for AutoTimer email notification and CRAM-MD5 authentication:
	    - Digest::HMAC_MD5
	  - Required for syslog logging:
	    - Sys::Syslog
	  - Required for IPv6 support:
	    - IO::Socket::INET6
	  - Required for SSL support (https):
	    - HTTP::Daemon::SSL

Description
-----------

VDRAdmin-AM is a web based interface to VDR.


Installation
------------

See "INSTALL" file.


Options
-------

	-n, --nofork
		don't fork, log to stderr.

	-c,  --config
		run configuration dialog.

	-d [dir], --cfgdir [dir]
		use [dir] for configuration files.

	-k, --kill
		kill a forked vdradmind[.pl].

	-p [name], --pid [name]
		name of pidfile to use.

  -6, --ipv6
    use IPv6. [EXPERIMENTAL!]

  -s, --ssl
    only accept https:// connections.

		NOTE: this requires server-cert.pem and server-key.pem in the "certs" directory.
		      You can create them for example like this:
		# openssl req -new -x509 -days 9999 -keyout server-rsa-key.pem -out server-cert.pem
		# openssl rsa -in server-rsa-key.pem > server-key.pem

	-l [level], --log [level]
		set log level for this session [0 - 7].

	-h, --help
		print usage information.


Credits
-------

See "CREDITS" file.

Packages
--------
RPM (Fedora): until included in upstream available via COPR: https://copr.fedorainfracloud.org/coprs/pbiering/vdr_extensions/packages/