Server: Difference between revisions

Latest revision as of 16:26, 3 May 2022

"kJams Pro" and "kJams 2" allow the KJ to enable a web server that is built into kJams. It allows singers to use the app kJams Cue or a web browser to manage their "Tonight", "Favorites", and "History" playlists. Singers can search the KJ's Library, or search any of their playlists to find songs they can then put into their "Tonight" playlist. They can reorder their "Tonight" list so the songs come in the order in which they want to sing them, and they can change the key of any song.

Note: Internet Explorer and Opera are not supported. You must use FireFox, Safari, or, with a little work, Chrome.

Take Note

Singers created in the kJams app by the host (rather than thru the web interface or thru kJams Cue) do not have a password. Singers without passwords will NOT show up in the list of singers that can be logged into. To assign a password to a singer so they can log in, in kJams context click the singer and pick "Get Info", then type a password.

Playlist used for Server Search

By default, the playlist that is searched by the server is the Library. However, the host can change this to any other playlist if desired, by context-clicking the playlist and choosing "Playlist used for Server Search".

This is handy if, for example, you have every song in the world in your Library, but only want a subset to be visible for user searches when they use the web server. This setting is remembered per-venue. Only one Playlist may be used for the Server Search.

This also has the benefit of moving the playlist to the top area of the Source list, above the venue, so you can get to it easily without having to scroll down below the singers to find it.

How To Turn It On

for Windows users only:
1. Click the start menu
2. Type in "Services"
3. Sort by Name
4. Scroll down to World Wide Web Publishing Service (W3SVC)
5. right click it and pick "Properties"
6. if it is running, click "stop"
7. in the "startup type" menu, pick "disabled"
8. click "Apply"
run kJams
To enable existing singers for remote login, right click on each singer and pick "Get info..." and enter a password.
go to "kJams->Preferences->Server"
Check "Enable kJams Web Server"
Keep the default port number (80) unless you're already running your own web server. If you are, try 12345 as your port.

Testing the Web Server

The web server will be on port 80 (or whatever other port you've configured it to) on the IP address which your computer or laptop is set to on the local network, whether wireless (usually) or wired.

To make it easier to find, both for kJams Cue and for users accessing it with a standard web browser on their phone, tablet, or laptop, kJams uses Apple's 'Bonjour' service discovery protocol. You will need to install a "Bonjour Browser" to easily find the kJams venue, or you can locate it manually

If you're using Windows

Required install Bonjour for Windows (it says "Print Services" but it's the real Bonjour)
Note that "Internet Explorer" is not supported at all.

Install a Bonjour Browser

Mac: Bonjour Browser
Windows: Bonjour Browser

Locate it Manually

One option is to run kJams, then go to the Video menu and pick "QR Code-Web Server". This will display a QRCode grid on the Video screen. Have your singer scan that with a QR-Reader app on their smart phone, this will take them right to the your kJams Server.

Otherwise, you must find out the "sharing name" of your server machine

Mac: in System Preferences->sharing, eg: "bree.local"
Windows:
1. start menu->control panels->system->computer name. That plus ".local" is your "sharing name". eg: if your "computer name" is "bree" then your "sharing name" is "bree.local"
2. If the above doesn't work: start->control panels->network and sharing->change adapter settings->double click the LAN adapter->details->IPv4 address: that set of four numbers is your "sharing name", go figure.
to get the full address, you must append ":<port number>" to the sharing name unless it is 80. eg: if your port number is 12345, and your "sharing name" is "bree.local", the full address will be "bree.local:12345". if the port is 80, you do not need to append anything.
Go to any computer on your LAN, and in the web browser, enter the full address.

Example Server

Click Here (un: dave, pw: a) to see an example of what the server looks like!

If you're hyper savvy

You can put this on a *public* IP address under some domain, and use port 80 (provided there's no other web server on that address). that way people can *from home* enter something like:

https://karaoke.kjams.com:12345/

and then set up their tonight list, before they even get to the venue! isn't that spiffy?

The below is FOR EXPERTS ONLY. If you don't understand something, you'll have to seek the advice of someone who knows what they're doing to help you, this is outside the purview of kJams tech support.

get a domain of your own
get a public IP address for your server, from your ISP
set the domain to point to your server
set your server up to run on said address
Clone your "kJams" setup from your rig to your server
run kJams on your server
set the port to 80

Now, when people go to your domain, they'll get to your kJams server!

Before your show, quit kJams on the server and copy the "kJams Library" folder to your rig. Run your show. After your show, copy it back and run kJams on the server again.

Known Issues

A search that returns more than 200 songs will say "too many hits, refine your search" or something like that. ("200" is the default, but you can change it in the prefs "maximum number of songs returned in web server search")
A failed login (i.e., bad password) will not display an error; it will just display the login page again.
Updates made in kJams (eg: song added or list reordered) don't show up in the web UI unless the playlist is refreshed

Updates to the Server Resources

The "Server resources" are the HTML, CSS, and Javascript files that make the singer-request webserver work They live in a the preferences folder for kJams, on your hard drive. When you first run kJams, it copies them to its preferences directory, where kJams will subsequently look for them, so that you can edit them yourself, to do things like insert your show service's logo.

When there is an update to the server resources, kJams will ask you if you'd like to automatically update them.

Warning: If you HAVE made changes to them, you have to manually update these files, otherwise you can just click "Update" when it asks.

Code

if you're a code monkey and stuff you can look here

@@ Line 1: / Line 1: @@
-In the Pro version, kJams allows the KJ to enable a web server that can act as the front end to kJams.  This will allow singers to log in and manage their "Tonight", "Favorites", and "History" playlists.  They can search the Library or any of their singer lists to find songs they can then put into their "Tonight" list.  They can reorder their "Tonight" list so the songs come in the order in which they want to sing them.
+"'''kJams Pro'''" and "'''kJams 2'''" allow the KJ to enable a '''web server''' that is built into kJams. It allows singers to use the app '''[[kJams Cue]]''' or a web browser to manage their "Tonight", "Favorites", and "History" playlists. Singers can search the KJ's Library, or search any of their playlists to find songs they can then put into their "Tonight" playlist. They can reorder their "Tonight" list so the songs come in the order in which they want to sing them, and they can change the key of any song.
-Support for iPhone/iTouch Safari is NOT working, very soon there'll be a full App in the App store for 99¢.  Also, the Web UI will not work in any version of Internet Explorer, if you use windows as your satellite stations, you must use FireFox or Safari.
+Note: Internet Explorer and Opera are not supported. You must use FireFox, Safari, or, with a little work, Chrome.
-# To enable existing singers for remote login, right click on the singer and pick "get info" and enter a password.
+==Take Note==
-# Hold down the option key and pick "Preferences"
+Singers created in the kJams app by the host (rather than thru the web interface or thru '''kJams Cue''') do not have a password. Singers without passwords will NOT show up in the list of singers that can be logged into. To assign a password to a singer so they can log in, in kJams [[Context_Click|context click]] the singer and pick "Get Info", then type a password.
-# Click "Sharing".
+==Playlist used for Server Search==
+By default, the playlist that is searched by the server is the Library. However, the host can change this to any other playlist if desired, by [[Context_Click|context-clicking]] the playlist and choosing "Playlist used for Server Search".
+This is handy if, for example, you have every song in the world in your Library, but only want a subset to be visible for user searches when they use the web server. This setting is remembered per-venue. Only one Playlist may be used for the Server Search.
+This also has the benefit of moving the playlist to the top area of the Source list, above the venue, so you can get to it easily without having to scroll down below the singers to find it.
+==How To Turn It On==
+# for Windows users only:
+## Click the start menu
+## Type in "Services"
+## Sort by Name
+## Scroll down to World Wide Web Publishing Service (W3SVC)
+## right click it and pick "Properties"
+## if it is running, click "stop"
+## in the "startup type" menu, pick "disabled"
+## click "Apply"
+# run kJams
+# To enable existing singers for remote login, right click on each singer and pick "Get info..." and enter a password.
+# go to "kJams->Preferences->Server"
 # Check "Enable kJams Web Server"
-# Enter a port number or keep the default eg: 12345
+# Keep the default port number (80) unless you're already running your own web server. If you are, try 12345 as your port.
-# if you're using Safari, just browse your Bonjour sites for "kJams: <Venue Name> (<machine name>)"
-# if you're going to be using another browser, then:
+==Testing the Web Server==
-## you need to find out the sharing name of your server machine (in System Preferences->sharing, eg: "mymac.local")
+The web server will be on port 80 (or whatever other port you've configured it to) on the IP address which your computer or laptop is set to on the local network, whether wireless (usually) or wired.
-## Go to a machine on your local network and enter the kJams Server url eg: http://mymac.local:12345
+To make it easier to find, both for [[kJams Cue]] and for users accessing it with a standard web browser on their phone, tablet, or laptop, kJams uses Apple's 'Bonjour' service discovery protocol. You will need to install a "Bonjour Browser" to easily find the kJams venue, or you can locate it manually
+=== If you're using Windows ===
+# Required install [http://support.apple.com/kb/DL999 Bonjour for Windows] (it says "Print Services" but it's the real Bonjour)
+# Note that "Internet Explorer" is not supported at all.
+==== Install a Bonjour Browser ====
+Mac: [http://www.tildesoft.com/ Bonjour Browser]<br>
+Windows: [https://hobbyistsoftware.com/bonjourbrowser Bonjour Browser]
+=== Locate it Manually ===
+One option is to run kJams, then go to the Video menu and pick "QR Code-Web Server". This will display a QRCode grid on the Video screen. Have your singer scan that with a QR-Reader app on their smart phone, this will take them right to the your kJams Server.
+Otherwise, you must find out the "sharing name" of your server machine
+# Mac: in System Preferences->sharing, eg: "bree.local"
+# Windows:
+## start menu->control panels->system->computer name. That plus ".local" is your "sharing name". eg: if your "computer name" is "bree" then your "sharing name" is "bree.local"
+## If the above doesn't work: start->control panels->network and sharing->change adapter settings->double click the LAN adapter->details->IPv4 address: that set of four numbers is your "sharing name", go figure.
+# to get the full address, you must append ":<port number>" to the sharing name unless it is 80. eg: if your port number is 12345, and your "sharing name" is "bree.local", the full address will be "bree.local:12345". if the port is 80, you do not need to append anything.
+# Go to any computer on your LAN, and in the web browser, enter the full address.
-Send me some feedback on what works and what doesn't, and what you need to make it better.  Thanks!
+==Example Server==
+[https://karaoke.kjams.com:12345 Click Here] (un: dave, pw: a) to see an example of what the server looks like!
-If you're hyper savvy you can put this on a *public* IP address under some domain, and use port 80 (provided there's no other web server on that address).  that way people can *from home* enter something like:
+==If you're hyper savvy==
+You can put this on a *public* IP address under some domain, and use port 80 (provided there's no other web server on that address). that way people can *from home* enter something like:
-http://kjams.mykaraokeshow.com/
+https://karaoke.kjams.com:12345/
 and then set up their tonight list, before they even get to the venue!  isn't that spiffy?
+The below is FOR EXPERTS ONLY. If you don't understand something, you'll have to seek the advice of someone who knows what they're doing to help you, this is outside the purview of kJams tech support.
+# get a domain of your own
+# get a public IP address for your server, from your ISP
+# set the domain to point to your server
+# set your server up to run on said address
+# [[Cloning|Clone]] your "kJams" setup from your rig to your server
+# run kJams on your server
+# set the port to 80
+Now, when people go to your domain, they'll get to your kJams server!
+Before your show, quit kJams on the server and copy the "kJams Library" folder to your rig. Run your show. After your show, copy it back and run kJams on the server again.
 == Known Issues ==
-* Any list (singers or songs) with more than 200 items will not load.
+* A search that returns more than 200 songs will say "too many hits, refine your search" or something like that. ("200" is the default, but you can change it in the prefs "maximum number of songs returned in web server search")
 * A failed login (i.e., bad password) will not display an error; it will just display the login page again.
-* The album selector doesn't actually do anything (yet).
+* Updates made in kJams (eg: song added or list reordered) don't show up in the web UI unless the playlist is refreshed
-* Updates made in kJams don't show up in the web UI until the playlist is refreshed. This will be addressed after 1.0.
+==Updates to the Server Resources==
+The "Server resources" are the HTML, CSS, and Javascript files that make the singer-request webserver work  They live in a the preferences folder for kJams, on your hard drive. When you first run kJams, it copies them to its preferences directory, where kJams will subsequently look for them, so that you can edit them yourself, to do things like insert your show service's logo.
+When there is an update to the server resources, kJams will ask you if you'd like to automatically update them.
+Warning: If you HAVE made changes to them, you have to [[Server/Update|manually update]] these files, otherwise you can just click "Update" when it asks.
+==Code==
+if you're a code monkey and stuff you can [[Code|look here]]