Documentation:Modules/http intf - Revision history

DoesItReallyMatter: Use Template:Path to VLC, limited copy-edit/style edit

2019-03-14T23:34:04Z

Use Template:Path to VLC, limited copy-edit/style edit

← Older revision		Revision as of 23:34, 14 March 2019
Line 7:		Line 7:
	Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.		Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.

	If you get a ''401 Unauthorized'' error message and you have set a password on the interface as described in [[#Access_control~~\|Access control~~]] below, leave the username field blank and enter the password that you have set.		If you get a ''401 Unauthorized'' error message and you have set a password on the interface as described in [[#Access_control]] below, leave the username field blank and enter the password that you have set.

	VLC 2.0 and below: If you try to access the web interface from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see [[#Access_control~~\|Access control~~]] below.		VLC 2.0 and below: If you try to access the web interface from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see [[#Access_control]] below.

	The following options can be used to specify an IP and a different port on which you want to run the interface.		The following options can be used to specify an IP and a different port on which you want to run the interface.
Line 16:		Line 16:
	--http-port port		--http-port port

	or on Windows platforms:		or on Windows platforms:
	--http-host'''='''host		--http-host'''='''host
	--http-port'''='''port		--http-port'''='''port

	To enable the HTTP control interface as a primary or extra interface, go to Tools -> Preferences (select "All" radio-button) -> Interface -> Main interfaces -> check "Web":		To enable the HTTP control interface as a primary or extra interface, go to Tools → Preferences (select "All" radio-button) → Interface → Main interfaces → check "Web":
	[[File:~~VLC_2~~.~~0_Activate_HTTP~~.png‎\|450px\|center\|Activating VLC 2.0's HTTP interface]]		[[File:VLC 2.0 Activate HTTP.png‎\|450px\|center\|Activating VLC 2.0's HTTP interface]]

	===VLC before 2.0.0===		===VLC before 2.0.0===
	--http-host host:port		--http-host host:port

	or on Windows platforms:		or on Windows platforms:
	--http-host'''='''host:port		--http-host'''='''host:port

	To enable the http interface as a primary or extra interface, go to Tools > Preferences > Interface > General > Interface module: http remote control interface. In later versions it might be Tools -> Preferences (select All radiobutton) -> All radio button -> Interface -> Main interfaces -> check HTTP remote control)		To enable the http interface as a primary or extra interface, go to Tools > Preferences > Interface > General > Interface module: http remote control interface. In later versions it might be Tools → Preferences (select All radiobutton) → All radio button → Interface → Main interfaces → check HTTP remote control)

	== Configure ==		== Configure ==
Line 44:		Line 44:

	==== VLC before 2.1.0 ====		==== VLC before 2.1.0 ====
	Access control for specific IP addresses or ranges of IP addresses to the http interface can be done globally by editing "/usr/share/vlc/lua/http/.hosts" in Linux, "~~%PROGRAMFILES%\VideoLAN\~~VLC\lua\http\.hosts" on Windows and "/Applications/VLC.app/Contents/MacOS/share/lua/http/.hosts" on Mac OS X.		Access control for specific IP addresses or ranges of IP addresses to the http interface can be done globally by editing "/usr/share/vlc/lua/http/.hosts" in Linux, "{{Path to VLC\|windows\|dir=y\|q=n}}\lua\http\.hosts" on Windows and "/Applications/VLC.app/Contents/MacOS/share/lua/http/.hosts" on Mac OS X.

	The existing .hosts file contains examples and can easily customized to meet your needs. On [[Windows]], note that you might need administrator rights to edit this file.		The existing .hosts file contains examples and can easily customized to meet your needs. On [[Windows]], note that you might need administrator rights to edit this file.
Line 56:		Line 56:
	It is now also possible to customize the Web interface. See the html pages in share/html (within the VLC directory for Windows, within the VLC.app package on Mac OS X and somewhere in /usr/local for Linux). This can be a very cool interface if you spent some time developing nice UI elements. If you would like to contribute a new 'Default' html interface, you are also very welcome (keep it small).		It is now also possible to customize the Web interface. See the html pages in share/html (within the VLC directory for Windows, within the VLC.app package on Mac OS X and somewhere in /usr/local for Linux). This can be a very cool interface if you spent some time developing nice UI elements. If you would like to contribute a new 'Default' html interface, you are also very welcome (keep it small).

	An additional theme has been created (by Lucas Steigmeyer a.k.a. Plezops) specifically for PDA's or PSP's in mind. This ~~additonal~~ theme has a grey theme and will fit nicely on most portable versions of web browsers. The theme has the layout reordered to fit the screen better. You may download this theme from [http://www.orrentdesign.com/outsideResources/VLC_Graphite.zip OrrentDesign.com]. A readme file is included. View for install instructions and other info.		An additional theme has been created (by Lucas Steigmeyer a.k.a. Plezops) specifically for PDA's or PSP's in mind. This additional theme has a grey theme and will fit nicely on most portable versions of web browsers. The theme has the layout reordered to fit the screen better. You may download this theme from [http://www.orrentdesign.com/outsideResources/VLC_Graphite.zip OrrentDesign.com]. A readme file is included. View for install instructions and other info.

	== Notes ==		== Notes ==
	* On versions of VLC (windows) that are greater than .8 (possibly previous versions, though not confirmed) the HTTP interface index file is stored in the "http" folder in the VLC folder. There is a ~~[[VLC HTTP requests\|~~README file that serves as documentation]].		* On versions of VLC (windows) that are greater than .8 (possibly previous versions, though not confirmed) the HTTP interface index file is stored in the "http" folder in the VLC folder. There is a README file that serves as documentation, [[VLC HTTP requests]].
	* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.		* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.
	* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.		* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.
	* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.		* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.

	For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [~~http:~~//web.archive.org/web/20050912064324/http://www.videolan.org/doc/play-howto/en/ch04.html#id295619 "The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:~~Play_HowTo~~/~~Building_Pages_for_the_HTTP_Interface\|"~~Building ~~pages~~ for the HTTP ~~interface"~~]]. ([~~http:~~//web.archive.org/web/20050901191213/http://videolan.org/doc/play-howto/en/apb.html "See also old/outdated appendix B"]).		For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [//web.archive.org/web/20050912064324/http://www.videolan.org/doc/play-howto/en/ch04.html#id295619 "The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play HowTo/Building Pages for the HTTP Interface]]. ([//web.archive.org/web/20050901191213/http://videolan.org/doc/play-howto/en/apb.html "See also old/outdated appendix B"]).

	==See also==		==See also==
	* [[Documentation:~~Play_HowTo~~/~~Building_Pages_for_the_HTTP_Interface\|~~Building Pages for the HTTP Interface]] (may be obsolete)		* [[Documentation:Play HowTo/Building Pages for the HTTP Interface]] (may be obsolete)
	* [[Interfaces]]		* [[Interfaces]]

DoesItReallyMatter: /* Notes */ Incorrect: there is documentation as the README file

2019-02-17T06:10:39Z

Notes: Incorrect: there is documentation as the README file

← Older revision		Revision as of 06:10, 17 February 2019
Line 59:		Line 59:

	== Notes ==		== Notes ==
	* On versions of VLC (windows) that are greater than .8 (possibly previous versions, though not confirmed) the HTTP interface index file is stored in the "http" folder in the VLC folder. There ~~are no help files bundled with the download however you may find help files in the online Wiki and how-to, or readme's~~.		* On versions of VLC (windows) that are greater than .8 (possibly previous versions, though not confirmed) the HTTP interface index file is stored in the "http" folder in the VLC folder. There is a [[VLC HTTP requests\|README file that serves as documentation]].
	* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.		* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.
	* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.		* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.

Computergeoffrey at 14:07, 31 October 2016

2016-10-31T14:07:07Z

← Older revision		Revision as of 14:07, 31 October 2016
Line 64:		Line 64:
	* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.		* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.

	For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://videolan.org/doc/play-howto/en/ch04.html#id295619"The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. ([http://web.archive.org/web/20050901191213/http://videolan.org/doc/play-howto/en/apb.html "See also old/outdated appendix B"]).		For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://web.archive.org/web/20050912064324/http://www.videolan.org/doc/play-howto/en/ch04.html#id295619 "The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. ([http://web.archive.org/web/20050901191213/http://videolan.org/doc/play-howto/en/apb.html "See also old/outdated appendix B"]).

	==See also==		==See also==

Computergeoffrey: Fix dead link

2016-10-31T14:06:11Z

Fix dead link

← Older revision		Revision as of 14:06, 31 October 2016
Line 64:		Line 64:
	* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.		* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.

	For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://videolan.org/doc/play-howto/en/ch04.html#id295619"The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. [http://videolan.org/doc/play-howto/en/apb.html"See also old/outdated appendix B"].		For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://videolan.org/doc/play-howto/en/ch04.html#id295619"The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. ([http://web.archive.org/web/20050901191213/http://videolan.org/doc/play-howto/en/apb.html "See also old/outdated appendix B"]).

	==See also==		==See also==

Edwardw: /* VLC 2.1.0 and later */

2013-11-02T17:41:08Z

VLC 2.1.0 and later

← Older revision		Revision as of 17:41, 2 November 2013
Line 40:		Line 40:

	--http-password <your password here>		--http-password <your password here>

			When logging in, '''leave the username field blank'''.

	==== VLC before 2.1.0 ====		==== VLC before 2.1.0 ====

Corbax at 10:32, 3 October 2013

2013-10-03T10:32:28Z

← Older revision		Revision as of 10:32, 3 October 2013
Line 70:		Line 70:
	[[Category:Interfaces]]		[[Category:Interfaces]]

	{{Documentation}}		{{Documentation footer}}

Edwardw: /* Notes */

2013-08-19T22:38:58Z

Notes

← Older revision		Revision as of 22:38, 19 August 2013
Line 60:		Line 60:
	* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.		* A new http interface is available since 0.8.5. However this new interface does not work on handheld PDA's running the Windows Mobile OS, it also does not work with JavaScript turned off in your browser. This old interface was available at <nowiki>http://<ip>:<port>/old/</nowiki> for releases prior to 1.0.0.
	* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.		* Since 2.0.0, the HTTP interface has been rewritten from the ground up as a lua plugin with AJAX, and the oldhttp interface no longer exists.
			* Since 2.1.0, the HTTP interface no longer uses the hosts file, but instead a password.

	For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://videolan.org/doc/play-howto/en/ch04.html#id295619"The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. [http://videolan.org/doc/play-howto/en/apb.html"See also old/outdated appendix B"].		For more information about the HTTP interface, see the document "VLC Play-Howto", the paragraph [http://videolan.org/doc/play-howto/en/ch04.html#id295619"The HTTP interface"] in chapter 4 ("Advanced use of VLC") and [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface\|"Building pages for the HTTP interface"]]. [http://videolan.org/doc/play-howto/en/apb.html"See also old/outdated appendix B"].

Edwardw: /* How to use */

2013-08-19T22:37:17Z

How to use

← Older revision		Revision as of 22:37, 19 August 2013
Line 7:		Line 7:
	Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.		Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.

	If you have set a password on the interface as described in [[#Access_control\|Access control]] below, leave the username field blank and enter the password that you have set.		If you get a ''401 Unauthorized'' error message and you have set a password on the interface as described in [[#Access_control\|Access control]] below, leave the username field blank and enter the password that you have set.

	VLC 2.0 and below: If you try to access the web interface from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see [[#Access_control\|Access control]] below.		VLC 2.0 and below: If you try to access the web interface from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see [[#Access_control\|Access control]] below.

Edwardw: /* VLC 2.1.0 and later */

2013-08-19T22:36:44Z

VLC 2.1.0 and later

← Older revision		Revision as of 22:36, 19 August 2013
Line 36:		Line 36:
	==== VLC 2.1.0 and later ====		==== VLC 2.1.0 and later ====
	Access control has been simplified in VLC 2.1.0. You can restrict access to the web interface by using a simple password that can be set under Tools → Preferences (all) → Interfaces → Main interfaces → Lua → Lua HTTP → Password.		Access control has been simplified in VLC 2.1.0. You can restrict access to the web interface by using a simple password that can be set under Tools → Preferences (all) → Interfaces → Main interfaces → Lua → Lua HTTP → Password.

			It can also be set from the command line as the option 'http-password', like so:

			--http-password <your password here>

	==== VLC before 2.1.0 ====		==== VLC before 2.1.0 ====

Edwardw: /* How to use */

2013-08-19T22:34:41Z

How to use

← Older revision		Revision as of 22:34, 19 August 2013
Line 7:		Line 7:
	Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.		Now, when you start VLC, a web interface will be created and running on your computer on port 8080 (by default, but you can change this yourself). For your information, you can connect to a web server listening on an arbitrary port using http://server:port syntax, so you can test the VLC web interface using this URL: http://127.0.0.1:8080.

	If you ~~try to access~~ the ~~web~~ interface ~~from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see~~ [[#Access_control\|Access control]] below.		If you have set a password on the interface as described in [[#Access_control\|Access control]] below, leave the username field blank and enter the password that you have set.

			VLC 2.0 and below: If you try to access the web interface from another computer or by using your computer's IP address and you get a ''403 Access Denied'' error message, you have to allow access for the IP or IP range first: see [[#Access_control\|Access control]] below.

	The following ~~option~~ can be used to specify an IP and a different port on which you want to run the interface.		The following options can be used to specify an IP and a different port on which you want to run the interface.
	===VLC 2.0.0 and later===		===VLC 2.0.0 and later===
	--http-host host		--http-host host