Install OpenRemote 2.0 Controller
Before using iPhone, iPod Touch or Android panel with OpenRemote, you need to install a controller. You can install a controller on your existing computer hardware. We currently test OpenRemote distributions with Microsoft Windows XP, Mac OS X Snow Leopard and Debian-based Linux distributions. For additional instructions for other operating system variants, please use the OpenRemote User Forums for community support.
Windows XP
1. Install Java
You may already have Java installed on your system. Make sure it is version 6 or higher. You can do this by going to the "Start" menu and choosing "Run..." and then enter 'cmd', see Image 1 below.
Image 1: Start Command Shell in Windows XP
In the terminal window that opens, type:
If you see any version of Java 6 installed, you don't need to install Java. Otherwise, continue with Java installation:
Save the binary on your desktop. Double-click on the icon and follow the installation instructions.
2. Set Up Your Environment
From your desktop, open the Start menu and select Control Panel. From Control Panel, double-click the "System" icon. In the System window, click on Advanced tab and then click "Environment Variables". In Environment Variables, in the User Variables section, click New.
Enter "JAVA_HOME" as variable name and path to root of the Java Runtime directory (installed in step 1) as the value.
Click Ok and continue to step 3.
3. Install OpenRemote
Unpack the zip file on your filesystem. Start CMD shell from Start menu by selecting Run and enter 'cmd'. Change to the unpacked OpenRemote bin\ directory and enter 'openremote run' on the command line.
Avoid installing OpenRemote into a directory path that contains white spaces. This is known to cause issues.
Also, if may need to restart your command shell after setting the JAVA_HOME system property for the changes to take effect.
You should see OpenRemote starting up. Validate your installation by typing into your web browser the following address: http://localhost:8080/controller
4. Customize Panel Interface
Create your custom user interface using OpenRemote 2.0 Designer.
Once done, download your configuration on your desktop, and upload it to OpenRemote via the upload page of your controller.
Start your iPhone Console and configure it for your OpenRemote Controller.
Mac OS X 10.6 (Snow Leopard)
Uncompress the zip file on your desktop. Start the Terminal application and change to your Desktop directory. From your Desktop change to OpenRemote bin directory and execute ./openremote.sh run
You should see OpenRemote starting up. Validate your installation by typing into Safari the following address: http://localhost:8080/controller
Customize Panel Interface
Create your custom user interface using OpenRemote Designer.
Once done, download your configuration on your desktop, and upload it to OpenRemote via the upload page of your controller.
Start your iPhone Console and configure it for your OpenRemote Controller.
Mac OS X 10.5 (Leopard)
1. Set Up Your Environment
Start the Terminal application and make sure you are using Java version 6.
If you have Java 6 installed but Java version 5 is showing up, make sure to set up your JAVA_HOME environment variable (change the path name to your Java 6 location):
2. Install OpenRemote
Uncompress the zip file on your desktop. Change to OpenRemote '/bin' directory and execute './openremote.sh run'
You should see OpenRemote starting up. Validate your installation by typing into Safari the following address: http://localhost:8080/controller
Avoid installing OpenRemote into a directory path which contains white spaces. This is known to cause issues.
Customize Panel Interface
Create your custom user interface using OpenRemote Designer.
Once done, download your configuration on your desktop, and upload it to OpenRemote via the upload page of your controller.
Start your iPhone Console and configure it for your OpenRemote Controller.
Synology NAS
OpenRemote 2.0 How To - Controller on Synology NAS
Netgear ReadyNAS
OpenRemote 2.0 How To - Controller on Netgear ReadyNAS
QNAP NAS
OpenRemote 2.0 How To - Controller on QNAP NAS
Raspberry Pi
OpenRemote 2.0 How To - Install Controller on Raspberry Pi
Comments (17)
Mar 12, 2011
Torbjörn Österdahl says:
The following is my experience with installing the controller on my Ubuntu-based...The following is my experience with installing the controller on my Ubuntu-based home server.
Unzipped the application into /opt/openremote/version-XXX/ and started the application using the 'openremote.sh' script
>sudo ./openremote.sh run
This resulted in a clash with an existing tomcat6 installation since both wanted port 8080. After consulting the controller readme file I decided to copy the controller webapp to the webapps folder of the tomcat instance. (Note: I later noticed that I could had changed the controller port in the config file /opt/openremote/version-XXX/webapps/WEB-INF/classes/config.properties)
>sudo cp -R /opt/openremote/version-XXX/webapps/controller /var/lib/tomcat6/webapps/controller
Now I could check out the controller ui in the browser (http://my-server:8080/controller)
Tried to upload my config that I had created in the designer (openremote.zip).
Resulted in an error message. ('null') -> Poor error message
Found out this is bacause the controller webapp was not allowed to write in the default location for config files ('webapps/controller').
Rather than changing file permissions of the controller folder I created the folder '/opt/openremote/config' and made it belong to the user 'tomcat6'.
>sudo mkdir /opt/openremote/config
>sudo chown tomcat6:tomcat6 /opt/openremote/config
Next now controller did not start. Problem beeing that it tried to create a logfile in /opt/openremote/logs. -> If logs are supposed to be located relative to the config directory i suggest this should be mentioned in the readme file! Anyway, created also the logs directory.
>sudo mkdir /opt/openremote/logs
>sudo chown tomcat6:tomcat6 /opt/openremote/logs
Now it was possible to start the controller and upload the config (openremote.zip).
For verification it would had been very nice at this step if the web console had been integrated in the controller. Instead I proceeded with installing the Android console app from Android Market. The Android console finds the controller without further config. Chooses 'Cable' from the list of devices I have created. I am very pleased as notice that I can shift channels using the HTTP device I have created for my Dreambox DM 800 cable receiver. From first impression it is swift and reliable compared to than the sluggish IR remote delivered with the dreambox. This is extremely exiting and I am very pleased!
Nov 03, 2011
Mike Scher says:
This is useful information. It answered a few questions which I had. Thanks.This is useful information. It answered a few questions which I had. Thanks.
Dec 24, 2011
yodn says:
What is the password to unzip the file ?What is the password to unzip the file ?
Dec 24, 2011
Juha Lindfors says:
It shouldn't be password protected?It shouldn't be password protected?
Dec 24, 2011
yodn says:
Thank for your answer when I unzip the file after 80% it stop and says: file 'a...Thank for your answer
when I unzip the file after 80% it stop and says:
file 'applicationProtocolDataUnit$ is password protacted.Please enter the password in the box below.
What am I doing wrong?
Dec 24, 2011
Juha Lindfors says:
Could be a zip format incompatibility error. Maybe try a different tool for unzi...Could be a zip format incompatibility error. Maybe try a different tool for unzipping the file. What are you using?
Dec 24, 2011
yodn says:
You are absolutely right !!! I was using win xp default extractor . When I used...You are absolutely right !!!
I was using win xp default extractor .
When I used 7zip there was no problem at all
Thanks a lot
Jay
Aug 21, 2012
Alexander Викторович Трифонов says:
Can't install in MacOsX Mountain Lion. Following instructions but terminal tells...Can't install in MacOsX Mountain Lion.
Following instructions but terminal tells : access denied (Im admin)
Aug 22, 2012
Marcus Redeker says:
You will have to change the openremote.sh file to be executable. Something like ...You will have to change the openremote.sh file to be executable.
Something like "chmod +x openremote.sh"
Aug 22, 2012
Alexander Викторович Трифонов says:
Thank you very much!Thank you very much!
Sep 18, 2012
Papasumy says:
Была проблема с установкой сервера. Никак не хотел запускаться ни на WinXP, ни н...Была проблема с установкой сервера. Никак не хотел запускаться ни на WinXP, ни на Win7.
Переменные JAVA_HOME и JRE_HOME были обозначены по инструкции. Но при запуске openremote.bat всегда выскакивало сообщение: "The JAVA_HOME environment variable is not defined correctly This environment variable is needed to run this program NB: JAVA_HOME should point to a JDK not a JRE"
Проблему решил коррекцией файла setclasspath.bat в строке " if not "%JAVA_HOME%" == "" goto gotJdkHome " удалил not и все заработало. На всех операционках.
Oct 16, 2012
Othmar Kyas says:
Make sure you have the !!! Java SE Development Kit !!!! installed.(Not the Java ...Make sure you have the !!! Java SE Development Kit !!!! installed.(Not the Java Runtime Environment).
Java SE Development Kit 7
Go to http://www.oracle.com/technetwork/java/javase/downloads/index.html. Download and install the Java SE JDK for Windows x86.
Oct 14, 2012
geo says:
i installed OpenRemote in a wrong directory (the one where i unzipped the file i...i installed OpenRemote in a wrong directory (the one where i unzipped the file in my download directory) How to proceed to uninstall and to do it again correctly?
Oct 18, 2012
Juha Lindfors says:
You can simply move the directory, or delete the directory and unzip it to a new...You can simply move the directory, or delete the directory and unzip it to a new location from the original archive.
Dec 05, 2012
kurt klingbeil says:
OK, I'm following the bouncing ball... it's got LOTS of spin right from step 1:...OK, I'm following the bouncing ball... it's got LOTS of spin
right from step 1:
Check version of java
> java -version
java version "1.6.0_18"
Java(TM) SE Runtime Environment (build 1.6.0_18-b07)
Java HotSpot(TM) Client VM (build 16.0-b13, mixed mode, sharing)
If you see any version of Java 6 installed, you don't need to install Java. Otherwise, continue with Java installation:
There should be an explanation of whether version "1.6.0_18" is in fact Java 6 or not.
Hard-core java-istas will know whether the leading "1." is relevant or "1.6.x" == "6.x"
then step 2:
Enter "JAVA_HOME" as variable name and path to root of the Java Runtime directory (installed in step 1) as the value.
There should be an explanation of how to find the "root of the Java Runtime directory" whether java was already installed or needed to be installed.
How do other java apps find the root without a JAVA_HOME env var?
There is no established API by which java apps can find this ?
Java periodically gets updated, does that mean that open_remote will stop
until JAVA_HOME is updated, or continue to use old versions despite the updates?
Step 3:
Avoid installing OpenRemote into a directory path that contains white spaces. This is known to cause issues.
The fact that windoze allows/uses spaces in filenames is a fundamental design error.
Nice heads_up.
Sure, I can futz my way through these loose ends, but why?
Mar 01
pe zanstra says:
Sure, I can futz my way through these loose ends, but why? Because you are right...Because you are right.
The point is that there still is no installer for Windows for this product. The developers here are mostly volunteers, who rather improve functionality. I know a proper installer for Windows is high on their agenda. (As a matter of fact I tested a Beta version on 2012-12-12. Afaik it is not yet released )
May 31
Drew Nelson says:
Am I missing something or did the installation instructions for Linux disappear?Am I missing something or did the installation instructions for Linux disappear?