KeyNode.JS What it is and how it Works

KeyNode.JS

The parts of this presentation:

1. General features of KeyNode.JS
2. Getting started
3. The presenter
4. The server
5. Technic behind

General features

• Synchronise your deck.js presentation
• AND adds a presenterview to your deck.js presentation

It is written in Javascript and works with every Deck.js presentation.

Getting started

1. Requirements
2. [optional but recommended] Run local Keynode.JS server
3. Configuration
4. Start the presenter

Requirements

1. A running deck.js presentation
2. a running node.JS and npm installation

Run local Keynode.JS server

open Bash/cmd and do the following:

#1. clone Keynode.JS Server:
git clone https://github.com/AKSW/KeyNode.js.git -b server keynode.js.server
cd keynode.js.server

#2. install Required axtensions by running:
npm install

#3.a) copy configuration file (Bash)
cp keynode.js.server_settings.js_sample keynode.js.server_settings.js
#3.b) copy configuration file (Windows)
copy keynode.js.server_settings.js_sample "keynode.js.server_settings.js"

#4. start Server:
node keynode.js.server
            

Setting Dokumentation of the Server: here

Configurate your deck.js presentation

With a Keynode.js Server: e.g.

[Keynode.JS-server]="http://keynodeserver.aksw.org"

• Add a link to the JS-files into your presentation before the deck was initialiated

  <script src="[Keynode.JS-server]/watcher/keynode.state.js"></script>
  <script src="[Keynode.JS-server]/watcher/keynode.video.js"></script>
  <script src="[Keynode.JS-server]/watcher/keynode.watch.js"></script>

• add following settings to the head of your presentation:
  

  //Canonical URL = Identification for the Presentation:
  <link 
      rel="http://ns.aksw.org/keynode/canonical" 
      href="[your canonical url e.g. http://myserver.com/mypresentation.html]" />
  
  //Keynode.JS Server URL
  <link 
      rel="http://ns.aksw.org/keynode/server" 
      href="[e.g.http://localhost:4123]" />  
    
  //opt.: insert md5(md5(<yourPassword>)) here, to authenticate against this password
  <meta 
      name="password" 
      content="65e769bcfba3cc2a78d7ea32c59b7e09">
  
  //opt.: You E-Mail for passwordresets
  <link 
      rel="http://ns.aksw.org/keynode/mailto"    
      href="[e.g.mailto:me@myserver.net]" />

Start the Presenter:

just open URL with webbrowser:

• local Server:

  http://localhost/presenter/

• public Server:

  http://keynodeserver.aksw.org/presenter/

How to use the presenter?

1. if the presenter gets the content form the canonical URL, it fills the values found there otherwise you have to do the following steps
2. [optional] add an alternate URL to your presenter, this one will used by the Presenter, if set
3. [optional] add another NodeServer and hit [Ok] button next to it
4. add the password for each NodeServer (if you know it) and hit [Test Inputs]
5. [optional] hit [Reset] at the NodeServer you have forget the password from, then it will be send to your emailaddress or will shown in the console of your local server, if you have one
6. When ready hit [start Presenter] and begin to present

How to start the presenter? (3)

Now you are on the presenter console and can begin to have your talk. On the next Slide: How to use the presenter

How do i use the presenter? (1)

What is shown in each part of the presenter?

• On the left side: your last presentation slide
• In the middle: the slide everyone listen to your presentation sees
• On the right side: your next presentation slide

How do I use the presenter? (2)

With the arrow keys you can control your presentation, any change will be broadcasted to every slide opened with the keynode.watcher.js included.

How do I use the server? (1)

1. Check if you have installed the following programs:

   - node.js(download)
   - npm (for easy nodepackage installation)
   - socket.io (extention of node.js)
   - nodemailer (extention of node.js: if you want to run a public server)
   - request (extention of node.js:  if you want to run a public server)

2. Rename or Copy: keynode.js.server_settings.js_sample to keynode.js.server_settings.js
3. Check the configuration if it fits to your requirements (How to Configurate)

How to actualy start the server

go to the folder and run the server:

$ cd ./server
$ node keynode.js.server.js

How do I configure the server? (1)

in the Config file you find the following settings:

• Did you want to see the password in the console if you reset it or send an email?
  Default:

  this.localInstallation = false;

• How do your consolelogging looks like
  Default:

  this.preTagInfo = '\x1B[32m\x1B[1m[Info]\x1B[0m';
  this.preTagSettings = '\x1B[32m\x1B[1m[Settings]\x1B[0m';
  this.preTagServerData = '\x1B[32m\x1B[1m[Server_data]\x1B[0m';
  this.preTagServer = '\x1B[32m\x1B[1m[Server]\x1B[0m';
  this.preTagPres = '\x1B[32m\x1B[1m[Presentation]\x1B[0m';

• What is your default password set when you reset it?
  Default:

  this.standardPassword = (Math.floor(Math.random() * 4257671236709));

  uncomment the following line and comment the other, when only you use the server

  this.standardPassword = 'rootKannAlles';

• On what port should the server listen?
  Default:

  this.Server_Port = 4123;

• Do you want to allow new presentations or dont you?
  Default:

  this.allow_new_presentations = true;

How do I configure the server? (2)

in the Config file you find the following settings:

• Do you want to see all debug information on the console screen? Default:

  this.debug = true;

• Do you want to use the MailerOptions? (only in nonlocalInstallation)
  Default:

  this.useMail = false;

  they require 2 addons for node.js (only change if they are somewhere else):

  this.NodeMailerPackage = "nodemailer";
  this.RequestPackage = "request";

• Mail configuration:
  you can find an great number of possible options at documentation of Nodemailer
  Default:

  this.mailProto = "SMTP";
  this.smtp_options = {
  	host: "domain.de",
  	secureConnection: true,
  	port: 465,
  	auth: {
  		user: "user@Domain.de",
  		pass: ""
  	}
  };

  another option is the commented sendmail config:

  this.mailProto = "Sendmail";
  this.smtp_options = "/usr/bin/sendmail";

How does it work?

the easyest way to show is the following chart: