RESTful API Challenge 🥧 (14 March - 14 April)

[billz]

To celebrate the rollout of our new RestAPI (and also acknowledge Pi Day) we’re hosting a friendly challenge to see what kinds of applications developers can create with our brand new API.

We're announcing it here a day early on GitHub discussions, so visitors to our repo can get a head start.

Details are here: https://medium.com/@raspap/restful-api-challenge-e693e305321f

[bogen85]

I updated and the web ui would not load due to this change. Currently I'm not able (well, might be able, but that is not the point, to do all the needed steps needed to file a bug report). I understand the requirements for filing a bug report, but not everyone all the time is able to perform the exercise of a clean install and reproduction...)

I updated from 3.0.9 to 3.1.0 via the web ui (as I've done for the last several updates).

After update I was getting a RASPI_RESTAPI_ENABLED not defined and the ui would not reload properly.
I made sure my OS was up to date and I rebooted.

The UI would still not load. However, the wireless access point was working.

I don't want to reinstall and start clean so I backed up var/html and removed the offending section from var/www/html/includes/sidebar.php

--- ./html/includes/sidebar.php	2024-03-14 10:21:50.299094550 -0500
+++ /var/www/html/includes/sidebar.php	2024-03-14 13:53:29.398091498 -0500
@@ -80,11 +80,6 @@
           <a class="nav-link" href="data_use"><i class="fas fa-chart-bar fa-fw mr-2"></i><span class="nav-label"><?php echo _("Data usage"); ?></a>
         </li>
         <?php endif; ?>
-        <?php if (RASPI_RESTAPI_ENABLED) : ?>
-        <li class="nav-item">
-          <a class="nav-link" href="restapi_conf"><i class="fas fa-puzzle-piece mr-2"></i><span class="nav-label"><?php echo _("RestAPI"); ?></a>
-        </li>
-        <?php endif; ?>
         <?php if (RASPI_SYSTEM_ENABLED) : ?>
         <li class="nav-item">
           <a class="nav-link" href="system_info"><i class="fas fa-cube fa-fw mr-2"></i><span class="nav-label"><?php echo _("System"); ?></a>

I rebooted and the UI will now load.
I had not modified any of the system configuration by hand, all configuration has been through the web UI.
I'm running my wireless access point in a VM as that is far easier to maintain than dedicated hardware (as I run all my firewalls and routers in VMs due to dedicated hardware for each being too difficult to maintain).

I'm running Debian Bookworm (fully up to date) and nothing else other than what is needed for RaspAP in the VM.

$ cat /etc/os-release 
PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
NAME="Debian GNU/Linux"
VERSION_ID="12"
VERSION="12 (bookworm)"
VERSION_CODENAME=bookworm
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"

[bogen85]

I could file an issue, but I would have to lie on the checklist.

[bogen85]

// $ cat html/config/config.php 
<?php

define('RASPI_BRAND_TEXT', 'RaspAP');
define('RASPI_CONFIG', '/etc/raspap');
define('RASPI_CONFIG_NETWORK', RASPI_CONFIG.'/networking/defaults.json');
define('RASPI_CONFIG_PROVIDERS', 'config/vpn-providers.json');
define('RASPI_CONFIG_API', RASPI_CONFIG.'/api');
define('RASPI_ADMIN_DETAILS', RASPI_CONFIG.'/raspap.auth');
define('RASPI_WIFI_AP_INTERFACE', 'wlan0');
define('RASPI_CACHE_PATH', sys_get_temp_dir() . '/raspap');
define('RASPI_ERROR_LOG', sys_get_temp_dir() . '/raspap_error.log');
define('RASPI_DEBUG_LOG', 'raspap_debug.log');
define('RASPI_LOG_SIZE_LIMIT', 64);

// Constants for configuration file paths.
// These are typical for default RPi installs. Modify if needed.
define('RASPI_DNSMASQ_LEASES', '/var/lib/misc/dnsmasq.leases');
define('RASPI_DNSMASQ_PREFIX', '/etc/dnsmasq.d/090_');
define('RASPI_ADBLOCK_LISTPATH', '/etc/raspap/adblock/');
define('RASPI_ADBLOCK_CONFIG', RASPI_DNSMASQ_PREFIX.'adblock.conf');
define('RASPI_HOSTAPD_CONFIG', '/etc/hostapd/hostapd.conf');
define('RASPI_DHCPCD_CONFIG', '/etc/dhcpcd.conf');
define('RASPI_DHCPCD_LOG', '/var/log/dnsmasq.log');
define('RASPI_HOSTAPD_LOG', '/tmp/hostapd.log');
define('RASPI_WPA_SUPPLICANT_CONFIG', '/etc/wpa_supplicant/wpa_supplicant.conf');
define('RASPI_HOSTAPD_CTRL_INTERFACE', '/var/run/hostapd');
define('RASPI_WPA_CTRL_INTERFACE', '/var/run/wpa_supplicant');
define('RASPI_OPENVPN_CLIENT_PATH', '/etc/openvpn/client/');
define('RASPI_OPENVPN_CLIENT_CONFIG', '/etc/openvpn/client/client.conf');
define('RASPI_OPENVPN_CLIENT_LOGIN', '/etc/openvpn/client/login.conf');
define('RASPI_WIREGUARD_PATH', '/etc/wireguard/');
define('RASPI_WIREGUARD_CONFIG', RASPI_WIREGUARD_PATH.'wg0.conf');
define('RASPI_TORPROXY_CONFIG', '/etc/tor/torrc');
define('RASPI_LIGHTTPD_CONFIG', '/etc/lighttpd/lighttpd.conf');
define('RASPI_ACCESS_CHECK_IP', '1.1.1.1');
define('RASPI_ACCESS_CHECK_DNS', 'one.one.one.one');

// Constant for the GitHub API latest release endpoint
define('RASPI_API_ENDPOINT', 'https://api.github.com/repos/RaspAP/raspap-webgui/releases/latest');

// Constant for the 5GHz wireless regulatory domain
define("RASPI_5GHZ_CHANNEL_MIN", 100);
define("RASPI_5GHZ_CHANNEL_MAX", 192);

// Enable basic authentication for the web admin.
define('RASPI_AUTH_ENABLED', true);

// Optional services, set to true to enable.
define('RASPI_WIFICLIENT_ENABLED', true);
define('RASPI_HOTSPOT_ENABLED', true);
define('RASPI_NETWORK_ENABLED', true);
define('RASPI_DHCP_ENABLED', true);
define('RASPI_ADBLOCK_ENABLED', false);
define('RASPI_OPENVPN_ENABLED', false);
define('RASPI_VPN_PROVIDER_ENABLED', false);
define('RASPI_WIREGUARD_ENABLED', false);
define('RASPI_TORPROXY_ENABLED', false);
define('RASPI_CONFAUTH_ENABLED', true);
define('RASPI_CHANGETHEME_ENABLED', true);
define('RASPI_VNSTAT_ENABLED', true);
define('RASPI_SYSTEM_ENABLED', true);
define('RASPI_MONITOR_ENABLED', false);
define('RASPI_RESTAPI_ENABLED', false);

// Locale settings
define('LOCALE_ROOT', 'locale');
define('LOCALE_DOMAIN', 'messages');

[billz]

Here's your fix:

includes/defaults.php:

'RASPI_RESTAPI_ENABLED' => true,

[bogen85]

Indeed! I reverted the patch I'd done and added the fix to the defaults array in includes/defaults.php.

Thanks!

[billz]

You bet! Thanks for pointing this out. We pushed a lot of commits into production and overlooked this.