Skip to content

Easy Install

kjbstar edited this page Sep 24, 2017 · 4 revisions

Requirements

  • A local server (on a Raspberry with Raspbian, for example).
  • Or a Virtual Machine with Debian or Ubuntu.
  • Any modern browser on client side (Chrome, Chromium, Firefox...)

My installation is done on a Raspberry Pi Zero. In this case, I suggest you to temporary increase swap memory to avoid any memory issue during installation. Read more.

You can install on another OS, but Recalboy has been tested only on Debian 8, Ubuntu Server 17.04, and Raspbian. You may have to do manual install on another OS.

Virtual Machine users : I suggest you to configure your network on Bridge Access, so that your VM will get its own local IP. Just select "Bridged Adapter" in Network configuration (4th choice).

Easy Install Wizard

Recalboy is very simple to install.

  • Connect to the machine where you will install Recalboy through ssh
  • Then enter the following command, to download and execute the Install file.
wget https://raw.githubusercontent.com/kjbstar/recalboy/master/install.sh && chmod +x install.sh && sudo ./install.sh

Yes, you have to execute this command with sudo. You can check the file by yourself, there's nothing dangerous :)

The Wizard will guide you through 4 steps:

  1. Install requirements: mainly Apache 2 and PHP
  2. Virtual Host setup
  3. Composer install
  4. Recalboy install

On a freshly installed OS, or if you don't know what to answer, you would answer all questions just by pressing Enter key on your keyboard. Be careful: the last question expect you to enter your Recalbox's IP :)

Advanced users: please note that the Wizard will stop if you choose to customize the path of Recalboy's VirtualHost. Manual install is still possible, though.

Bravo ! Recalboy is now installed, you should be able to access it by your server's local IP (usually http://192.168.0.X, or by http://recalboy.local if you modify the hosts file of your client machine. But access by IP is fine :)

Then visit http://recalboy.local/config to eventually finish configuration. It's not mandatory, but higly advised if you plan to use Demo Mode :)

Clone this wiki locally