Plugin: SageTV Web Interface V2 for Jetty

[jreichen]

Version 2.25 of nielm's SageTV Web Interface introduces support for running in the Jetty web server in addition to existing support for the Tiny Java Web Server (TJWS). Up to this point, support for the web interface has been provided on the original thread. Support will continue to be provided there, but questions about Jetty setup, feature comparison, etc should be discussed in this thread.

See post 2356 in the other thread for the version 2.25 announcement.

Jetty Support
This release has a new build included that will deploy the web interface so it runs in Jetty. A lot of work went into maintaining compatibility so RSS and XML links from 3rd party apps that use the web interface as a data source will still work. The previous downloads for running nielm's web interface on its own web server (Tiny Java Web Server - TJWS) are still available for the time being, but it's definitely moving in the direction of being deployed in Jetty. Version 2.x will continue to be supported on TJWS, but version 3 will only run on Jetty.

Installation
See the wiki page for instructions on installing the web interface on Jetty and for migrating if you were running the web interface on TJWS.

Downloads
Beginning with this release, three downloads will be delivered for the web interface.

• Windows installer for web interface with TJWS
  (SageWebserverSetup_2_x.exe)
• Zip file for web interface with TJWS
  (webserver_2_x.zip)
• NEW: Zip file for web interface with Jetty (nielm_websrv_jetty_2_x.zip)

The first and second choices are Nielm's original webserver that runs on Tiny Java Web Server (TJWS). One in zip format and one with a Windows installer. Neither of these are for Jetty.

The 3rd one is the Jetty version of Nielm's webserver. This is the only one you should download if you want to run it in Jetty.

No matter what you should only download and install ONE of these three.
[Thanks to sleonard for clarifying the downloads.]

[jreichen]

This post intentionally left non-blank. If there had been something to post here, it would have been posted here; however, there is currently nothing of importance to say here. Nothing of importance.

[rmac321]

Originally Posted by jreichen

[LIST=1][*]Remove the existing /webserver folder and jar files

Which jar files do we remove? I'll check to see what was added when I installed, but I'm concerned that I might accidentally remove a shared jar.

Thanks

[jreichen]

Originally Posted by rmac321

Which jar files do we remove? I'll check to see what was added when I installed, but I'm concerned that I might accidentally remove a shared jar.

Thanks

• servlet.jar
• nielm_sagewebserver.jar
• nielm_sageutls.jar
• nielm_sagexmlinfo.jar

Note: nielm_sageutls.jar and nielm_sagexmlinfo.jar are also installed by some other plugins. Save those to a backup location in case you later find that you need them.

[rmac321]

Originally Posted by jreichen

• servlet.jar
• nielm_sagewebserver.jar
• nielm_sageutls.jar
• nielm_sagexmlinfo.jar

Note: nielm_sageutls.jar and nielm_sagexmlinfo.jar are also installed by some other plugins. Save those to a backup location in case you later find that you need them.

I've either removed too much, too little, or need a nudge in the right direction. I stopped the sage service. I removed the jars, the /webserver folder and the portion of my load at startup line in sage.properties. I unzipped the new v2.25 zip. Unfortunately, I can't seem to get to the (new) Web Interface.

The unzip was successful as there is a new /webserver folder and the new context file is in the /jetty/contexts folder. It appears from the context.xml that /sage is the proper address to append to the server and port.

I already have jetty working and can access sagealert and bmt. To try to use the new jetty version of the Web User Interface, I used the same address as before, but changed the port to the jetty port. Is there some other change to the address, or have I missed something else?

http://sageserver:8080/bmt/ opens bmt user interface page
http://sageserver:8080/sagealert/ opens sagealert page
http://sageserver:8080/sage/ result is error 404
http://sageserver:8080/sage/home result is error 404

If I use the old port: http://sageserver:8081/sage/Home, then I get a Failed to Connect which I would expect.

What am I missing?
Thanks

Edit: Problem Solved! I was still running v1.5 of the Jetty Starter. I wasn't subscribed to that thread and my other jetty apps were working fine, so I missed the 1.6 upgrade. Upgraded Jetty Starter to v1.6 and all is good.
Thanks jreichen for Jetty Starter and the new Jetty version of the Web Interface.
Thanks Brent for the upgrade instructions.
Thanks nielm for the Web User Interface.

[toricred]

I'm having this problem too. I haven't actually removed the jar files yet.

[b-morgan]

It worked for me (after I stopped and started SageTV). Make sure you've done that (including stopping and starting the service if used).

There may be a way to just restart jetty but I don't know how to do that. Restarting SageTV is easy for me to do.

Regards,

Brad

[toricred]

But what was the URL?

[b-morgan]

The following work for me:

http://localhost:8080/sage/Home

http://localhost:8080/sjq/SJQClient.html

Also:

http://localhost:8080/

Shows a list of installed applications with their links (on a page with a 404 error).

Regards,

Brad

[toricred]

All I get are 404 errors on the first and last link. I don't use SJQ so it doesn't surprise me that that one won't work. On the last one there are no links just the plain 404. Also on the last one I get a forbidden message.

Edit: I got it now. I thought the Sage Service was shut down when I extracted the files, but apparently not. Anyhow it's working fine now.

[toricred]

Now DVRMS Toolbox can't connect. Any thoughts? I'm also going to post in babgvant's forum.

[jreichen]

Originally Posted by rmac321

The unzip was successful as there is a new /webserver folder and the new context file is in the /jetty/contexts folder. It appears from the context.xml that /sage is the proper address to append to the server and port.

Is there a nielm_sagewebserver.war in the jetty/webapps folder?

Originally Posted by rmac321

I already have jetty working and can access sagealert and bmt. To try to use the new jetty version of the Web User Interface, I used the same address as before, but changed the port to the jetty port. Is there some other change to the address, or have I missed something else?

http://sageserver:8080/bmt/ opens bmt user interface page
http://sageserver:8080/sagealert/ opens sagealert page
http://sageserver:8080/sage/ result is error 404
http://sageserver:8080/sage/home result is error 404

Make sure you're using a capital 'H' on the word 'Home' in the URL.

If that doesn't work, turn on SageTV's debug logging and see if the log has anything helpful.

[jreichen]

Originally Posted by b-morgan

There may be a way to just restart jetty but I don't know how to do that.

Right now there's no way to restart Jetty. Jetty's API supports restarts but the plugin doesn't support it right now. I'd like to create some tools to make installation and configuration of Jetty easier, it's just a matter of having time to do it and its priority on the feature list.

[jreichen]

Originally Posted by toricred

Now DVRMS Toolbox can't connect. Any thoughts? I'm also going to post in babgvant's forum.

I haven't used that plugin. The web server should still support all the URLs that other plugins rely on. If you can provide some details about what doesn't work then I'll try to fix the incompatibility.

[toricred]

I figured out the problem with DTB, but it is strange. It actually only fails when testing the config because it is trying to go to /sage/home (all lower case). I've posted that on babgvant's forum and hopefully he'll just make a change to how he tests.

[mkanet]

Jreichen, thank you for providing instructions on how to migrate to all Jetty. However, I am using https for Neilms webserver. Could you please update the intructions for people who want to move over to Jetty AND also retain their https capability? I followed the instructions for getting Neilms webserver to use https. I would like to also use https after switching to Jetty. I currently have Jetty 1.6 up and running.

Thanks so much

Originally Posted by jreichen

Version 2.25 is now available on SourceForge.

ENHANCEMENTS

• (slugger, stuckless, jreichen) Run as an application on the Jetty web server plugin (deploy as a .war file)

• (jreichen) System Messages page and RSS feed (requires SageTV 6.5.17 or later)

The list is rather short this time, but I think they're a couple of good features.

Jetty Support
This release has a new build included that will deploy the web interface so it runs in Jetty. A lot of work went into maintaining compatibility so RSS and XML links from 3rd party apps that use the web interface as a data source will still work. The previous downloads for running nielm's web interface on its own web server are still available for the time being, but it's definitely moving in the direction of being deployed in Jetty.

There isn't any documentation for how to move nielm's web interface to Jetty yet. I'll be updating the wiki with more information soon. Initially I'm anticipating that early adopters will be the first to move anyway and will be up for a challenge In fact, feel free to update the wiki along the way

Here's a quick summary:

1. Remove the existing /webserver folder and jar files as well as the load_at_startup_runnable_classes entry in Sage.properties.
2. Just like you would install other Jetty web apps, unzip the new download into the SageTV directory. A context xml and war file will be extracted. The extenders.properties, paths.properties, and transcode.properties files will be extracted to the previous /webserver folder to maintain compatibility with those features. Sorry, aliases.properties could not be supported because it was part of the old server (Tiny Java Web Server) that is replaced by Jetty.

Downloads
For the first time I am releasing the update rather than nielm. Unfortunately that means the downloads page cannot be updated with the most recent version. You'll need to download directly from SourceForge or use one of these download links.

• Windows installer for web interface with TJWS
  
• Zip file for web interface with TJWS
  
• NEW: Zip file for web interface with Jetty

[rmac321]

Originally Posted by jreichen

Is there a nielm_sagewebserver.war in the jetty/webapps folder?

Yes, it is there.

Originally Posted by jreichen

Make sure you're using a capital 'H' on the word 'Home' in the URL.

That was a typo, sorry. I originally used the old link and just changed the port, so the h was capitalized. I also tried it with several variations after it failed.

Originally Posted by jreichen

If that doesn't work, turn on SageTV's debug logging and see if the log has anything helpful.

I'll also try to reinstall to see if that helps. I was hoping I just missed something obvious.

[rmac321]

I know part of the beauty of jetty is that you don't have to stop the jetty server when you install a new app. But, does the Jetty Server need to be running when you install/extract jetty apps?

The reason I ask is because I had the Sage Service stopped when I extracted v2.25 because I needed to stop the service to make the sage.properties mods and delete the jar files. It was still stopped while I extracted v2.25.

I just re-extracted v2.25 without stopping the service, but still no joy.

[jreichen]

Originally Posted by mkanet

Jreichen, thank you for providing instructions on how to migrate to all Jetty. However, I am using https for Neilms webserver. Could you please update the intructions for people who want to move over to Jetty AND also retain their https capability? I followed the instructions for getting Neilms webserver to use https. I would like to also use https after switching to Jetty. I currently have Jetty 1.6 up and running.

Thanks so much

Check out the Jetty SSL instructions. You can skip the Generating an SSL Certificate section and proceed to the JettyStarter.properties section.

[LehighBri]

Originally Posted by jreichen

ENHANCEMENTS

• (slugger, stuckless, jreichen) Run as an application on the Jetty web server plugin (deploy as a .war file)

Amazing job.... and this was very easy to switch to use the Jetty version (probably easy given I already am using Jetty and have other war files installed). Keep up the great work.