Setting up and using a custom menu in QuickBox

v2-4-8
custom-menu

#1

Note: in order to use this method, you will need to update to the latest v2.4.8 QuickBox. To do this, login to your server via ssh or the included Web Console on your dashboard and gain root access by typing sudo su. Next, type box upgrade. Now wait for the update to finish… finito! You’re on your way to adding custom items in QuickBox.
Don’t like ssh? Don’t worry about it! Just update right from the WebUI of your Dashboard!

In this simple how-to, I will be showing you how to create your own custom links/custom menu to the QuickBox Dashboard.

It’s fairly simple and straight-forward. Let’s take a look.

  1. Open the custom.menu.php file located in the /srv/rutorrent/home/custom directory.
    You’ll see that we’ve included a quick guide there as well.
  2. Under the section titled::
    // INSERT YOUR CUSTOM EXTERNAL or INTERNAL LINKS HERE! //
    Add a link to your custom location. This is an easy way to segregate your links, from your visible menu entry.

    Example:
  • $appURL = "https://" . $_SERVER['HTTP_HOST'] . ":0000/"; -or-
  • embyURL= "https://" . $_SERVER['HTTP_HOST'] . "/emby"; -or-
  • externalsiteURL= "https://somewebsite.com";

    The Breakdown:
    • $appURL= is used to define what exactly appURL is when it is included within the menu.
    • "https://" . $_SERVER['HTTP_HOST'] . " is used to define the address of your server. This is handy for accessing the link via both IP as well as a fully qualified domain name.
    • :0000/ is used to define the port of your custom application. This only applies if there is a port to be used. For instance, emby defaults on port 8096, thus that entry would like like:
      embyURL= "https://" . $_SERVER['HTTP_HOST'] . ":8096/";
    • When using external links (outside the server) just use the actual link to the website such as the example for the $externalsiteURL example above.
  1. Next, under the section titled:
    <!-- // INSERT YOUR CUSTOM EXTERNAL or INTERNAL MENU ITEMS HERE! // -->
    You will make use of your $appURL that was defined above. Remember, you can change $appURL to anything you like. Just make sure when you use it in your menu, it stays consistence with the title you gave it above.

    Example:
    Let’s link to the QuickBox Plaza!
  • <li><a class="grayscale" href="<?php echo "$quickboxURL"; ?>" target="_blank"><img src="img/brands/quickbox.png" class="brand-ico"> <span>QuickBox Plaza</span></a></li>

    The Breakdown:
    • $quickboxURL= would be defined at the top of the file.
      It would link to the Plaza with the following:
      $quickboxURL= "https://plaza.quickbox.io";
      You can see that it is then inserted as a link here:
      href="<?php echo "$quickboxURL"; ?>"
  1. Adding Logo Images to your custom links
  • You can add custom logos to your created menu items by placing the logos within the /srv/rutorrent/home/img/brands/ directory. For best results, add images to be no greater than 128x128 pixels in size. Remember to change the image source to the name you have given your logo icon.

    Any image format is acceptable: (jpg,png,svg,gif)
    <img src="img/brands/CHANGETHIS.png" class="brand-ico">
    Whereas CHANGETHIS.png is the image.png that you would add.

Feeling sort of confused or overwhelmed b/c I am a developer and not a teacher?

No worries, we have included a living example within the file and the update applies a custom item, it’s non other than a no-follow link to the QuickBox Plaza. Feel free to keep this or remove it… it’s your custom menu, so add away!

What does this file look like on the inside?

///////////////////////////////////////////////////
 // BEGIN TUTORIAL ON ADDING IN YOUR CUSTOM LINKS //
 ///////////////////////////////////////////////////
 //
 // ..examples..
 //
 // $appURL = "https://" . $_SERVER['HTTP_HOST'] . ":0000/"; # links to custom app install on your server
 // $mysiteURL = "https://www.mydomain.com/"; # links to custom external source of your choosing
 //
 // Now, let's add them to the menu!
 //
 // <li><a class="grayscale" href="<?php echo "$appURL"; ?//>" target="_blank"><img src="img/brands/app.png" class="brand-ico"> <span>Custom App</span></a></li>
 // <li><a class="grayscale" href="<?php echo "$mysiteURL"; ?//>" target="_blank"><img src="img/brands/sitelogo.png" class="brand-ico"> <span>My External Site</span></a></li>
 //
 // You'll notice in the examples above that after (for instance) "$appURL"; ?
 // there are two forward slashes (//). Remove these on live examples.
 // These were included to avoid php collisions within the examples.
 //
 //----------------------
 // Adding Logo Images //
 //----------------------
 //
 // You can add custom logos to your created menu items by placing the logos
 // within the /srv/rutorrent/home/img/brands/ directory. For best results, add
 // images to be no greater than 128x128 pixels in size.
 // Remember to change the image source to the name you have given your logo icon.
 // Any image format is acceptable: (jpg,png,svg,gif)
 // <img src="img/brands/CHANGETHIS.png" class="brand-ico">
 //
 //
 ///////////////////////////////////////////////////
 //  END TUTORIAL ON ADDING IN YOUR CUSTOM LINKS  //
 ///////////////////////////////////////////////////
 
 
 // INSERT YOUR CUSTOM EXTERNAL or INTERNAL LINKS HERE! //
 $quickboxURL = "https://plaza.quickbox.io/";
 
 ?> <!-- Do not remove this closing (?>) -->
 
 
 <!-- // INSERT YOUR CUSTOM EXTERNAL or INTERNAL MENU ITEMS HERE! // -->
 <li><a class="grayscale" href="<?php echo "$quickboxURL"; ?>" target="_blank"><img src="img/brands/quickbox.png" class="brand-ico"> <span>QuickBox Plaza</span></a></li>


Main Menu item access for users
QuickBox Dashboard - Customize?
Custom menu reset after update
Request : Muximux
Request for Radarr
We were unable to find a vhost