Permalink
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
67 lines (41 sloc) 4.9 KB

Installation Guide

There are quite a number of ways in which the wototo service can be deployed. At some point it may be available on a subscription basis (i.e. Software as a Service, SaaS). In the mean time you will need to set up and maintain your own personal wototo service, either on a desktop or laptop computer, or on a server.

You should be able to run Wototo on a moderate specification desktop or laptop computer running a reasonably recent version of Linux, Windows or MacOS X. If you run Wototo on a desktop or laptop computer then you will probably not be able to use the Forms functionality, and if you want publish material generally then you will also need space on a web server that supports static files and PHP.

To run wototo on a server you will need an Internet-accessible Unix (Linux) server with shell access and root/admin permission; typically this will be a virtual machine (VM) or virtual private server (VPS). On a server Wototo can run alongside other services, but you will need to set up your existing web server (assuming you are running one) to forward requests to Wototo.

Personal / test instance

Creating

You can create a single personal or test instance of the mediahub using the pre-built docker image cgreenhalgh/mediahubauto.

  • install docker as per the docker installation for your operating system. (If you are using windows and having trouble see notes below.)

  • if on windows or Mac start boot2docker as per the installation guide, e.g. on Windows click boot2docker start. (If you are using Linux then docker will run directly on your machine.)

  • download the docker image cgreenhalgh/mediahubauto:latest (if on windows or Mac do this in the boot2docker window; on Linux do it in a term window - on Linux you will need to be root us add sudo to the beginning of the line):

docker pull cgreenhalgh/mediahubauto:latest
  • start a new mediahub instance from that image (and by default make it accessible via port 80 on the docker host):
docker run -d -p :80:80 cgreenhalgh/mediahubauto:latest
  • If on windows or Mac and you want to access the mediahub from other machines on the network then you will need to make the port accessible, e.g. on Windows open Oracle VM VirtualBox, find the entry on the left for boot2docker-vm, select it and click Settings, select Network, on the Adapter 1 tab click Port Forwarding, click Insert new rule (diamond/plus icon), and enter Host Port 80 and Guest Port 80; click OK, OK.

  • Open a browser and enter the URL of the new instance. Note: don't use localhost or 127.0.0.1 - find the actual IP address of your machine (or the docker host vm). Open a terminal (on Windows a Command Prompt) and type boot2docker ip; copy this address (four numbers with dots in between) into the web browser.

  • you should see a form prompting for an instance name, username and password. (If you get a 502 Bad Gateway error then try stopping and re-starting the docker container, or restarting your machine and restarting docker as below.) These will be the admin account for the new server; enter your chosen values and hit configure (don't use credentials that you use elsewhere!). You should see a confirmation page with a Get started link; follow this...

  • you should see a simple web page with a title (OpenSharingToolkit Mediahub) and a link Editor - click this for the authoring and publishing view. The username and password are the ones you set in the previous step.

  • Now try the tutorial in the general (app first) user guide or the kiosk user guide.

Note that the server uses basic authentication over HTTP; you will need to set it up behind a HTTPS reverse proxy if you want this to be secure!

Checking / restarting

Note that if you restart your computer or boot2docker, depending on how you do it, the mediahub instance may not be running afterwards. You can check and if necessary restart it as follows:

  • If on Windows or Mac check that boot2docker is running, and if not start it (as above).

  • Check if you server is still running in docker (as above, if on windows or Mac do this in the boot2docker window; on Linux do it in a term window - on Linux you will need to be root us add sudo to the beginning of the line):

docker ps | grep mediahub
  • if you see an entry for the mediahub in this list of running docker "containers" then no need to worry - it is running. Otherwise...

  • find the stopped container which is your instance:

docker ps -a | grep mediahub
  • if there is NO entry then you don't have an instance here - you'll have to start a new one as above. If there is an entry...
  • copy the first "word" in the line (about 12 letters and digits) and paste this instead of CONTAINERD below:
docker start CONTAINERID
  • with a bit of luck that will restart the mediahub instance, and you can access it from your browser as before.