KeexyBox's wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Installation of KeexyBox ======
KeexyBox is software that can be installed on a Raspberry Pi or any x86_64 compatible machine. It can also be installed on a virtual machine. 

===== RaspiOS (Raspberry ARM) =====

==== Hardware requirement ====

You will need the following in order to install KeexyBox:

  * [[https://www.raspberrypi.org/|Raspberry Pi]]
  * MicroSD card >= 16GB
  * Good quality micro USB power supply > 2.5A
  * RJ45 cable
  * A Raspberry Pi Case



==== Install KeexyBox by flashing MicroSD ====



=== Installation ===

  - [[https://sourceforge.net/projects/keexybox/|Download]] Raspios Lite image bundled with latest KeexyBox.
  - Use [[https://www.balena.io/etcher|balenaEtcher]] to flash the downloaded **.img.xz** image on your MicroSD.
  - Insert MicroSD card in your Raspberry PI.
  - Plug a RJ45 cable between your Raspberry PI and your internet router.
  - Plug micro USB power supply.

You are done with the installation.

=== Configuration ===

KeexyBox is accessible by following IP addresses for configuration:

  * [[http://192.168.1.254:8001/users/adminlogin]]
  * [[https://192.168.1.254:8003/users/adminlogin]]
  * [[http://192.168.2.254:8001/users/adminlogin]]
  * [[https://192.168.2.254:8003/users/adminlogin]]

You may have to change the network settings of the computer you use to reach KeexyBox. For exemple, you can set the IP address 192.168.1.253 on your computer, then you will be able to reach KeexyBox by this address [[http://192.168.1.254:8001/users/adminlogin]].

when you are able to reach one of KeexyBox's addresses, connect as ''admin'', with password ''KeexyBox974'' and then configure KeexyBox:

  - Configure [[system_settings_datetime|Date and time]].
  - Configure [[system_settings_network|Network]]. (:!: It is recommended reading this article to understand [[network_topologies|KeexyBox’s network topologies]]).
  - Configure [[system_settings_dhcp|DHCP]].
  - Feed the [[blacklist_manage|Blacklist]].
  - Create [[profiles_manage|Profiles]].
  - Add [[users_manage|Users]].
  - Declare [[devices_manage|Devices]] (Optional).
  - [[diagnostics_services_power|Restart KeexyBox]]

:!: The default credentials for SSH are the same as [[https://www.raspberrypi.org/documentation/installation/installing-images/|Raspbian default]].

==== Install KeexyBox from installation script ====

=== Prerequisites ===

  * **Install Raspbian Lite on your Raspberry PI**: [[https://www.raspberrypi.org/documentation/installation/installing-images/]]
  * **Make sure your Raspberry PI has the Internet connectivity**.
  * **Make sure APT is well set to Raspbian repository**: [[https://www.raspbian.org/RaspbianRepository]].

=== Installation ===

Connect as root to the console of your Raspberry PI and follow the instructions below.

Download KeexyBox:
  cd ~
  wget https://download.keexybox.org/arm/keexybox_21.04.2_raspios10.tar.gz
  
Extract files: 
  tar xzf keexybox_21.04.2_raspios10.tar.gz

Run installation:
  cd keexybox_21.04.2_raspios10
  ./install.sh

Set the KeexyBox Admin password (the password must contains at least 8 chars):

{{:keexybox_img:install_step01_password.png?500|}}

Confirm the KeexyBox Admin password:

{{:keexybox_img:install_step02_confirm_password.png?500|}}

Select ''Yes'' to confirm the installation:

{{:keexybox_img:install_step03_confirm_installation.png?500|}}

When KeexyBox is successfully installed you should have the screen below:

{{:keexybox_img:install_step04_end_installation.png?500|}}

Note the KeexyBox Web interface addresses and select ''OK''. The next step is the post installation.




===== Debian (amd64/x86_64) =====

:!: Debian 10 is recommended.

==== Install KeexyBox from installation script ====

=== Prerequisites ===

  * **Get any hardware compatible x86_64/amd64**: 1 CPU, 1GB RAM, 16GB HDD (KeexyBox can also be installed on a virtual machine)
  * **Install latest Debian**: [[https://www.debian.org/distrib/]]
  * **Make sure your machine has the Internet connectivity**.
  * **Make sure APT is well set to a Debian repository**

=== Installation ===

Connect as root to the console of your machine and follow the instructions below.

Download KeexyBox:
  cd ~
  wget https://download.keexybox.org/amd64/keexybox_21.04.2_amd64_debian10.tar.gz
  
Extract files: 
  tar xzf keexybox_21.04.2_amd64_debian10.tar.gz

Run installation:
  cd keexybox_21.04.2_amd64_debian10
  ./install.sh

Set the KeexyBox Admin password (the password must contains at least 8 chars):

{{:keexybox_img:install_step01_password.png?500|}}

Confirm the KeexyBox Admin password:

{{:keexybox_img:install_step02_confirm_password.png?500|}}

Select ''Yes'' to confirm the installation:

{{:keexybox_img:install_step03_confirm_installation.png?500|}}

When KeexyBox is successfully installed you should have the screen below:

{{:keexybox_img:install_step04_end_installation.png?500|}}

Note the KeexyBox Web interface addresses and select ''OK''. The next step is the post installation.

====== Post installation of KeexyBox ======

For the post installation, you need to use an Internet Browser and enter the given KeexyBox Web interface address, example:

  https://192.168.1.249:8003/

or
  http://192.168.1.249:8001/

:!: You will get a security alert if you connect to it using HTTPS. This is because KeexyBox uses a self-signed certificate. You must override the alert to connect to it.

Wherever you are on the KeexyBox Web interface, you can change the language by clicking on the flag at the top right, then select your language.

{{:keexybox_img:interface_select_language.png?400}}

By default when you access the KeexyBox’s web interface, you are redirected to the [[using_connect|captive portal]] allowing users to connect to the Internet. You have to switch to the KeexyBox administration by clicking on ''Admin'' and then click on ''Manage''.

{{:keexybox_img:install_step05_admin_login.png?400|}}

You must connect with the ''admin'' account and the password defined during the installation.
  
{{:keexybox_img:install_step06_enter_credentials.png?400}}

You are now on the KeexyBox’s configuration wizard page.

You have to choose first, how you want to use KeexyBox. To make the best choice for your needs, it is better to understand the [[network_topologies|KeexyBox’s network topologies]]. Depending of your choice, the wizard will be different.

{{:keexybox_img:install_step07_choose_topology.png?600|}}

For the next steps everything is explained on the wizard. 

  - Accept the licences.
  - Date and time settings: Refer to [[system_settings_datetime|KeexyBox - Date and time]] if you need more help.
  - Network settings: Refer to [[system_settings_network|KeexyBox - Network settings]] if you need more help.
  - DHCP settings (you can skip this step): Refer to [[system_settings_dhcp|KeexyBox - DHCP settings]] if you need more help.
  - Add domains to the Blacklist (you can skip this step): Refer to [[blacklist_manage|KeexyBox - Manage the Blacklist]] if you need more help.
  - Add a new user (you can skip this step): Refer to [[users_manage|KeexyBox - Manage users]] if you need more help.
  - Scan and add devices (you can skip this step): Refer to [[devices_manage|KeexyBox - Manage devices]] if you need more help.
  - For the last step, click on ''Finish'' to reboot you KeexyBox’s device.

{{:keexybox_img:install_steplast_finish.png?600}}