https://wiki.keexybox.org/ 2026-04-22T13:06:33+00:00 https://wiki.keexybox.org/ https://wiki.keexybox.org/lib/exe/fetch.php/wiki/dokuwiki.svg text/html 2020-09-25T07:31:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/blacklist_manage?rev=1601019106&do=diff KeexyBox - Manage the Blacklist The Blacklist is KeexyBox's internal database containing the domains to block. All domains or websites added in the blacklist have to be categorized. These categories are used to be assigned to connection profiles in order to block domains. text/html 2020-02-20T13:53:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/dev_packaging_keexyapp?rev=1582206821&do=diff Create keexyapp Tar archive for KeexyBox installer Clone keexyapp to you local machine: git clone https://github.com/keexybox/keexyapp Create tar archive: tar czf keexybox-keexyapp.tar.gz --exclude keexyapp/.git --exclude keexyapp/tmp --exclude keexyapp/logs --exclude keexyapp/config/app.php --exclude keexyapp/src/Shell/scripts/config.py keexyapp text/html 2021-05-04T11:19:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/devices_manage?rev=1620127158&do=diff KeexyBox - Manage devices For KeexyBox, a device is a hardware that can have a connectivity to the Internet. It can be a PC, smartphone, tablet, IP Camera, Smart TV or a voice assistant. :!: Since version 21.04.1, you can avoid registering your devices in KeexyBox to connect them to the internet. You just need to set text/html 2020-09-25T07:31:27+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/diagnostics_domain_check?rev=1601019087&do=diff Check a domain In some cases a domain can be filtered while it is not in the blacklist. In most cases, it comes from a target CNAME record which is in the Blacklist. This tool allows you to check the domains causing the blocking. To use it: * Use your browser and connect to the text/html 2020-02-22T18:27:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/diagnostics_others?rev=1582396060&do=diff Other tools * List chains of Iptables of you KeexyBox (hidden tool): <https://keexybox:8003/tools/iptables-status> ---------- About KeexyBox Project: * Website * Forum * GitHub * Facebook text/html 2020-09-25T07:31:18+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/diagnostics_services_power?rev=1601019078&do=diff KeexyBox - Services and power management From the KeexyBox Web interface, you can restart or turn off the device you use for KeexyBox. It is also possible to restart the KeexyBox services. To do it: * Use your browser and connect to the KeexyBox Management Web interface. * On left menu, go to text/html 2020-09-25T07:32:07+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/diagnostics_system_state?rev=1601019127&do=diff System state This tool allows you to display the system state of the device you use for KeexyBox. To check the system state: * Use your browser and connect to the KeexyBox Management Web interface. * On left menu, go to Tools & Diagnostics -> System state. Memory and Swap show you the state of the memory. Red color is the used memory. text/html 2020-09-21T12:46:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/installation_installing_20.04?rev=1600692407&do=diff Install KeexyBox KeexyBox is a software program to be installed in Raspbian and requires a Raspberry PI box. Hardware requirement You will need the following in order to install KeexyBox: * Raspberry Pi * MicroSD card >= 16GB * Good quality micro USB power supply > 2.5A text/html 2022-05-30T11:34:26+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/installation_installing?rev=1653910466&do=diff 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: text/html 2020-08-18T16:57:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/installation_uninstall?rev=1597769872&do=diff Uninstall KeexyBox :!: Uninstalling KeexyBox will remove the application and delete all the Keexybox's data (Databases and Blacklist included). Tun the following script to uninstall KeexyBox: /opt/keexybox/keexyapp/src/Shell/scripts/uninstall.sh Reply text/html 2021-05-11T03:18:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/installation_update?rev=1620703130&do=diff Update KeexyBox Before updating Before updating, it is recommanded to export your configuration to keep a backup: * Export the Blacklist * Export users * Export devices * Export profiles Update from web admin interface Since version 20.10.2 it is possible to update KeexyBox from Web admin interface. Follow these steps: text/html 2020-09-21T12:50:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/manual_installation_20.04?rev=1600692635&do=diff Compile and install KeexyBox + Packaging it Manual installation All the instructions bellow have to be done on your RasberryPI Rasbian. Create environment Create KeexyBox project folder: mkdir -p /opt/keexybox/logs Create keexybox system user: useradd -d /opt/keexybox/ -s /bin/bash keexybox text/html 2024-04-05T06:49:43+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/manual_installation_debian12?rev=1712299783&do=diff Compile and install KeexyBox + Packaging it :!: DEBIAN 12 :!: IN PROGRESS... Manual installation Requirement The manual installation have to be done on RaspiOS or Debian. Create environment Create KeexyBox project folder: mkdir -p /opt/keexybox/logs text/html 2021-05-14T13:25:30+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/manual_installation?rev=1620998730&do=diff Compile and install KeexyBox + Packaging it Manual installation Requirement The manual installation have to be done on RaspiOS or Debian. Create environment Create KeexyBox project folder: mkdir -p /opt/keexybox/logs Create keexybox system user: text/html 2020-09-21T12:52:17+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/network_topologies_20.04?rev=1600692737&do=diff KeexyBox - Network topologies and features Depending on the needs, KeexyBox can be implemented in several ways on your home network. We present in this article all possible network topologies to help you understand how KeexyBox works and what it can bring you to improve your browsing on the Internet. text/html 2020-09-21T12:52:35+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/network_topologies?rev=1600692755&do=diff KeexyBox - Network topologies and features Depending on the needs, KeexyBox can be implemented in several ways on your home network. We present in this article all possible network topologies to help you understand how KeexyBox works and what it can bring you to improve your browsing on the Internet. text/html 2020-09-25T07:32:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/profiles_manage_domain_routing?rev=1601019149&do=diff KeexyBox - Profiles - Manage domain routing Domain routing allows you to define exceptions to the default connection type of the profile. If, for example, the connection type of the profile is set to Tor by default, here you can add domains or websites to reach without going through the Tor network. Conversely, if the connection type of the profile is set to text/html 2020-09-25T07:32:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/profiles_manage_firewall?rev=1601019158&do=diff KeexyBox - Profiles - Manage firewall With KeexyBox you can create firewall rules to accept or drop protocols to the Internet. For example, it can block peer to peer. You will need a minimum of technical knowledge of TCP/IP to create rules. The KeexyBox firewall only allows you to create rules for outgoing connections. Unlike common firewalls, the source will not be an IP address but a profile. So all users or devices using the connection profile will inherit the firewall rules defined for it. text/html 2020-09-25T07:32:21+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/profiles_manage?rev=1601019141&do=diff KeexyBox - Manage profiles Profiles are used to define the Internet connection settings for users or devices. To manage profiles: * Use your browser and connect to the KeexyBox Management Web interface. * On left menu, go to Connection settings -> Profiles. * You will be redirected to the text/html 2020-09-21T12:54:28+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/screenshots_20.04?rev=1600692868&do=diff KeexyBox - Captive Portal This page allows users to connect to the Internet. This page shows to user the status and settings of his connection. KeexyBox - Admin access Authentication page to manage KeexyBox. KeexyBox - Statistics and connected users and devices text/html 2020-09-21T12:54:58+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/screenshots?rev=1600692898&do=diff KeexyBox - Captive Portal Private Captive portal that allows users to connect to the Internet. Captive portal that allows users to register before able to connect to the Internet. Internet access registration page. Captive portal that allows users connect to the Internet without an account. text/html 2020-09-21T12:43:48+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/start_20.04?rev=1600692228&do=diff KeexyBox documentation Presentation * KeexyBox's Website: <https://keexybox.org>. * KeexyBox's Forum: <https://forum.keexybox.org>. * Network topologies and features. * Screenshots of KeexyBox. Installation, update and uninstallation * Install KeexyBox: Installation and first configuration of KeexyBox. * Update KeexyBox: Update KeexyBox. * Uninstall KeexyBox: Uninstallation of KeexyBox. text/html 2020-09-24T18:55:13+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/start?rev=1600973713&do=diff KeexyBox documentation Presentation * KeexyBox's Website: <https://keexybox.org>. * KeexyBox's Forum: <https://forum.keexybox.org>. * Network topologies and features. * Screenshots of KeexyBox. User documentations KeexyBox web interface * Access the KeexyBox Web Interface * Change laguage of KeexyBox Web interface * Access to KeexyBox Management Interface * Quit the KeexyBox Management Interface Internet access using KeexyBox Captive Portal * Connect me to the Interne… text/html 2020-08-14T10:22:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_advanced?rev=1597400532&do=diff KeexyBox - Advanced settings and configuration management Advanced settings page allows you to change any setting of KeexyBox. :!: You should not normally have to use the advanced settings page to configure your KeexyBox. Changing the settings by this way could cause KeexyBox to not working! text/html 2021-05-04T11:22:50+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_captiveportal?rev=1620127370&do=diff KeexyBox - Captive Portal settings :!: This feature is available from KeexyBox 20.10.1 :!: KeexyBox allows you to define three types of captive portal : * Private: It allows users to connect to the Internet with an account created by an Admin. * text/html 2020-09-25T07:33:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_datetime?rev=1601019205&do=diff KeexyBox - Date and time The configuration of the date and time of KeexyBox is very important because internet access schedules and the production of statistics depend on the time. To set date and time of your KeexyBox: * Use your browser and connect to the text/html 2021-05-04T10:35:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_dhcp_20.10.2?rev=1620124541&do=diff KeexyBox - DHCP settings :!: This article describes the DHCP configuration of KeexyBox up to version 20.10.2. :!: To configure DHCP from version 21.04.1, see this article. The DHCP allows you to dynamically assign an IP address and other network settings to each device on your network. For a better use of KeexyBox, it is recommended to enable it on KeexyBox and to disable it on your Internet router. text/html 2021-05-04T10:45:38+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_dhcp?rev=1620125138&do=diff KeexyBox - DHCP settings :!: This article describes the DHCP configuration of KeexyBox from version 21.04.1. :!: To configure DHCP before version 21.04.1, see this article. The DHCP allows you to dynamically assign an IP address and other network settings to each device on your network. For a better use of KeexyBox, it is recommended to enable it on KeexyBox and to disable it on your Internet router. text/html 2020-09-25T07:49:40+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_misc_20.04?rev=1601020180&do=diff KeexyBox - miscellaneous settings To modify miscellaneous settings of KeexyBox: * Use your browser and connect to the KeexyBox Management Web interface. * On left menu, go to System settings -> Miscellaneous. * You will be redirected to the Miscellaneous settings page. * Complete the form as explained below. text/html 2020-09-25T07:49:22+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_misc?rev=1601020162&do=diff KeexyBox - miscellaneous settings To modify miscellaneous settings of KeexyBox: * Use your browser and connect to the KeexyBox Management Web interface. * On left menu, go to System settings -> Miscellaneous. * You will be redirected to the Miscellaneous settings page. * Complete the form as explained below. text/html 2020-09-25T07:34:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_network?rev=1601019249&do=diff KeexyBox - Network settings You will need a minimum of technical knowledge of TCP/IP to setup the network and you must understand the different network topologies of KeexyBox. :!: KeexyBox does not currently support IPv6. We are working on it. To setup the network: * Use your browser and connect to the text/html 2020-09-25T07:34:19+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_ssl?rev=1601019259&do=diff SSL Certificate Access to your KeexyBox Web interface can be secured by connecting to it using HTTPS. For this type of connection, a SSL certificate is required. Here you can renew the self-signed certificate. To renew the self-singed certificate: text/html 2020-09-25T07:34:45+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/system_settings_wifiap?rev=1601019285&do=diff KeexyBox - Wi-Fi Access Point :!: This feature is available from KeexyBox 20.10.1 :!: KeexyBox can provide a Wi-Fi Access Point. It use hostapd to provide the service. This page allows you to setup the Access Point. :!: Steps before configuring Access Point : text/html 2020-09-25T07:35:05+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/users_manage_20.04?rev=1601019305&do=diff KeexyBox - Manage users For KeexyBox, a user is a person who can enter a login and password on the device he uses to connect it to the Internet. An Internet browser must be at least available on the device. A user can use the same credentials to connect multiples devices to the Internet. If you do not want to have entering a login and password to connect a device to the Internet go to this topic: text/html 2021-05-04T11:31:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/users_manage?rev=1620127870&do=diff KeexyBox - Manage users For KeexyBox, a user is a person who can enter a login and password on the device he uses to connect it to the Internet. An Internet browser must be at least available on the device. A user can use the same credentials to connect multiples devices to the Internet. If you do not want to have entering a login and password to connect a device to the Internet go to this topic: text/html 2020-09-25T07:35:29+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_admin_access?rev=1601019329&do=diff KeexyBox - Access to the management Web interface To switch to the KeexyBox administration interface you must follow these steps: * Use your browser and connect to the KeexyBox address. * At the top right, click on Admin and then click on Manage. * * Enter the credentials of a user with administrative permissions. text/html 2020-09-25T07:36:14+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_admin_quit?rev=1601019374&do=diff KeexyBox - Quit the management Web interface * Use your browser and connect to the KeexyBox address. * At the top right, click on Admin and then click on Quit * ---------- About KeexyBox Project: * Website * Forum * GitHub * Facebook text/html 2020-09-25T06:51:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_change_lang?rev=1601016706&do=diff KeexyBox - Change the language of the Web interface Wherever you are on the KeexyBox interface, you can change the language at any time. You just need to click on the flag at the top right, then select your language. * ---------- About KeexyBox Project: text/html 2020-09-25T07:39:02+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connect_devices?rev=1601019542&do=diff KeexyBox - Connect devices By default a device can be connected to the Internet only if its user has authenticated to the KeexyBox's captive portal. However, if you have to connect devices such as a voice assistant or IP camera, you will need to connect them to the Internet without using the captive portal. text/html 2020-09-25T07:17:46+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connect_to_keexybox_interface?rev=1601018266&do=diff KeexyBox - Connecting to the web interface Addresses of KeexyBox Web Interface Your KeexyBox is accessible from any Internet browser. If your computer or smartphone uses the KeexyBox DNS you can connect to the interface by the following addresses: text/html 2020-09-21T13:00:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connect_users_20.04?rev=1600693247&do=diff KeexyBox - Captive portal The captive portal is the web page accessed with a web browser that allows you to connect to the Internet over KeexyBox. Check your Internet connection You can check the status of your Internet connection: * Use your browser and enter the text/html 2020-09-22T13:08:31+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connect_users?rev=1600780111&do=diff KeexyBox - Private Captive portal The captive portal is the web page accessed with a web browser that allows you to connect to the Internet over KeexyBox. Connect to the Internet If your connection state is Offline as described above, you are redirected to the page that allows you to connect to the Internet. text/html 2020-09-25T07:09:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connect?rev=1601017787&do=diff KeexyBox - Connect to the Internet using Captive portal The captive portal is the web page accessed with a web browser that allows you to connect to the Internet over KeexyBox. Connect to the Internet If you have just connected your device to your local network or to the wireless access point, you should be automatically redirected to the KeexyBox captive portal page. If this is not the case, try to connect to it manually by following this text/html 2020-09-25T07:10:12+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_connection_status?rev=1601017812&do=diff KeexyBox - Check your Internet connection status on the Captive Portal Check the connection You can check the status of your Internet connection: * Use your browser and enter the KeexyBox address in the address bar. * At the top right of the page you can get an overview of the status of your Internet connection established by KeexyBox. text/html 2020-09-25T07:22:47+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_create_user_account?rev=1601018567&do=diff KeexyBox - Register to Captive Portal If you try to access the Internet using a Wireless access point which uses KeexyBox as a captive portal, you should be automatically redirected to the KeexyBox captive portal page. If this is not the case, try to connect to it manually by following this text/html 2020-09-25T12:03:41+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_delete_user_account?rev=1601035421&do=diff KeexyBox - Delete your KeexyBox Captive Portal account * Use your browser and connect to the KeexyBox Management Web interface. * Enter the login and password you use to connect to the internet. * Change your informations and click on Delete my account. ---------- About KeexyBox Project: text/html 2020-09-24T18:06:30+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_disconnect?rev=1600970790&do=diff KeexyBox - Captive Portal - Disconnect from the Internet * Use your browser and enter the KeexyBox address in the address bar. * At the top right of the page, Click on Online and then click on Disconnect. * :!: You are not able to disconnect if the device you use is connected as a device or if your connection is in text/html 2020-09-25T12:04:04+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_edit_user_account?rev=1601035444&do=diff KeexyBox - Modify your KeexyBox Captive Portal account * Use your browser and connect to the KeexyBox Management Web interface. * Enter the login and password you use to connect to the internet. * Change your informations and click on Save. ---------- About KeexyBox Project: text/html 2020-09-25T07:51:09+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_manage_connections?rev=1601020269&do=diff KeexyBox - Manage users and devices connections The KeexyBox connection manager allows the administrator to pause, disconnect, reconnect users and devices from the Internet. It also allows you to see the Internet usage of each connection. Go to the connection manager: text/html 2020-09-25T07:42:25+00:00 Anonymous (anonymous@undisclosed.example.com) https://wiki.keexybox.org/doku.php/using_statistics?rev=1601019745&do=diff KeexyBox - Display Internet usage statistics You can view statistics of the domain / websites visited by users or devices. Statistics are only made for users and devices who use a profile with the statistics option enabled. View statistics: * Use your browser and connect to the