Announcement

Collapse
No announcement yet.

Using Tools.php

Collapse
X
Collapse
  •  

  • Using Tools.php

    Within your vBulletin Download Package, we provide a file called tools.php, this file isn't uploaded to the server by default as it is considered to be a significant security risk. However, there are times when you need to change specific settings and aren't able to access your AdminCP directly.

    Uploading to the Server

    It is recommended that tools.php is installed in the /core/install directory. To do this, follow the steps below:

    1. Connect to your server with your favorite SFTP or SCP client.
    2. In your vBulletin package, upload the /core/install directory to your server.
    3. In your vBulletin package, find tools.php in your do_not_upload directory and upload to the /core/install directory.

    After Using Remove Tools.php

    We consider this file to be a security risk. This cannot be overstated. This file should not be stored on your server after use. It is provided as a tool of last resort. Once you have completed your tasks, you should delete it from your server. To do this, delete the /core/install/ directory.

    Using The Tools

    1. Point your browser to the file at /core/install/tools.php (e.g. https://example.com/core/install/tools.php)
    2. Enter your Customer ID.
    3. Select the tool from the menu.

    The Tools

    XML Tools

    These tools allow you to restore default information that is normally updated during an installation or upgrade. They allow you to restore a site to its default look and feel.

    • Style: Loads the vbulletin_style.xml file located in the /core/install directory and overwrites the MASTER style. All other styles inherit their templates from this hidden MASTER style. This will not affect changes made in themes or custom styles.
    • Settings: Loads the vbulletin_settings.xml file located in the /core/install directory and updates the setting table in the database. It does not overwrite your configured options.
    • Language: Loads the vbulletin_language.xml file located in the /core/install directory. Similar to the Style system, this rebuilds the MASTER language that contains all phrases that other languages are based on. This will not affect changes made in custom languages.
    • Admin Help: Loads the vbulletin_adminhelp.xml file. This is a series of phrases used for the inline help with the AdminCP.

    Datastore Tools

    This information is stored in the datastore table of your database. It allows us to consolidate frequently used information into a single table in order to reduce queries when loading pages. Sometimes, the values in this table can be out of date or corrupted. These options let you rebuild some important values.

    • Usergroup / Channel Cache: Every usergroup has a datastore record that caches custom permissions across the site. These are loaded for the users on every page load. This tool will rebuild these records should they get corrupted.
    • Options Cache: Rebuilds the datastore records that stores the compiled values of every setting under Settings -> Options. If you manually change values in the setting table, this should be run. Until you do so, your new values will have no affect.
    • Bitfield Cache: vBulletin stores a number of values in Bitfields. That is the values are stored as a portion of an integer within the database. This allows the software to store multiple settings in a single integer. This will rebuild the bitfield cache with those options.
    • Password Schemes: Unlike other datastore options, Password Schemes are not stored in a scheme table within the database but reside in a file. These schemes are cached within the datastore. Using this option imports all pwsschemes_*.xml files schemese located core/includes/xml/ directory and rebuilds the cache. This file tells vBulletin what types of password storage is available and what PHP Class processes those passwords. It also provides options like the cost for Blowfish hashing. If you ever get an error stating there are no known password types for a user, this datastore should be rebuilt. It should also be rebuilt if you ever edit/add to the pwsschemes-vbulletin.xml file.

    MySQL Tools

    These tools directly modify your modify your database and should be used with extreme caution. Before making any changes to your database you should create a complete backup.

    • Run Query: This allows you to run alter and update queries on the database. Altering the database can make your vBulletin inoperable.
    • Repair Tables: (OBSOLETE) Allows you to repair crashed MyISAM tables. You can repair MyISAM tables with this tool if your software is returning an error of "Table is marked as crashed." This tool will not fix other database errors.
    • Reset Admin Access: Allows you to promote any user to Administrator status. They would have full access to your site.
    • Scan Content Tables: Scan & Repair node, closure, and content tables. You should only do this if vBulletin Technical Support Staff advises you to do so, and make sure you have a back up first.
    • Restore Pages: This allows you to revert pages to their default configuration. This restores the route (URL), page, pagetemplate, and widgets defaults for the selected page(s). You should only use this if vBulletin Technical Support Staff advises you to do so, and after backing up your database first.
    • Fix Poll Option Cache: Regenerate the poll option cache if it is out of sync.

    Other Options

    All of the options below can be found in the AdminCP under Settings -> Options.

    • Turn On/Off Forum: Toggles the availability of your forum. The default value is On.
    • Turn On/Off Css As Files: Toggles where your CSS Files are stored. The default value is Off. The recommended value is On. If you're having problems upgrading with the Web Upgrade Wizard, setting this to Off may help.
    • Turn Off Templates As Files: Determines where your templates are stored. The default value is Off. The recommended value is Off. Only turn this on if you have very fast SSD based storage.
    • Rebuild Styles: Rebuild the internal Style Rollup values based on the Master Style and individual style customizations. This will rebuild the css cache on disk if Css As Files is on.
    • Rebuild Template Cache: Rebuild the template cache on disk. This only has an effect if Templates As Files is on
    • Default Language: Reset the site's default language. This can be useful if you receive an error stating the language cannot be found.
    • Location of Website: Change location of site. Allows you to change the location of the site if you cannot access the AdminCP. Frequently used after changing domain names for your site. (This is the $vboptions[frontendurl] setting).

    • webmastersun
      #1
      webmastersun commented
      Editing a comment
      I have heard a lot about helpful of Tools.php but to be honest I just read tutorials about it without any chances to to apply these for my forum. I bookmarked this page so I can use ways to make my work faster.

      Thanks for cool article!
    Posting comments is disabled.

About the Author

Collapse

Wayne Luke A curious juxtaposition of nature, technology and sustainability. Find out more about Wayne Luke

Article Tags

Collapse

advanced (5) android (2) api (29) array (17) beginner (17) blog (4) calendar (2) child forums (1) cms (2) forum (3) forums (4) Intermediate (7) iphone (3) mapi (30) methods (10) mobile (34) MYSQL (1) postbit (1) security (2) style (2) threads (4) usercp (1) vb5howto (5) vBulletin (5) vbulletin 4 upgrade (1)

Latest Articles

Collapse

  • vBulletin 5 Database Best Practices
    by Wayne Luke
    This is part of a best practices series to manage your vBulletin installation. The database is the heart and soul of your vBulletin site. All content and user information is stored in the database. Protect the database and you protect your site. This document will go over the creation and usage of a MySQL database for the use of vBulletin 5 Connect. If you have shared hosting and are provided a web-based control panel like cPanel, you will need to access your hosting provider's documentation on how to carry out these operations. This document assumes a general familiarity with the command line operations of your Operating System. All commands listed assume that you are accessing your server via SSH. ...
    Wed 31st Oct '18, 7:18am
  • vBulletin Password Handling
    by Wayne Luke
    Note: vBulletin Cloud sites cannot use custom password schemes at this time. The core security of your site is the User Password and how it is stored. In the beginning, vBulletin used a simple MD5 hash to represent the password. However as Floating Point Processors (i.e. GPU and ASICs) have become more powerful, this method proved to be risky and reduced security. If we significantly changed the password scheme, then users wouldn't be able to login and would need to change their passwords fir...
    Sat 27th Oct '18, 12:34pm
  • Creating the Sitemap XML for your vBulletin
    by Wayne Luke
    The XML Sitemap specification allows search engines to index your site more efficiently. vBulletin 5 Connect can create the Sitemap automatically so you can submit it to your favorite search engines. Using the default path If you are using vBulletin Cloud, you must use this option. The default value for this is core/store_sitemap. Make sure the directory is CHMOD 0777 on your server. In the AdminCP, go to Settings -> Options -> XML Sitemap and set Enable Automatic Sitemap Generation to Yes. ...
    Sat 27th Oct '18, 12:18pm
  • Installing Memcached for vBulletin
    by Wayne Luke
    Note: Installing and using Memcached requires access to the command line and the ability to install software on your server. If you are using a Shared Hosting Package, then you may not have access to this capability. If you are in doubt, please contact your hosting provider. If you are running vBulletin in a Virtual Machine or on a Dedicated Server, you can improve performance with Memcached. This allows you to move some of the caching systems from vBulletin's database and into memory. On the s...
    Sat 27th Oct '18, 12:00pm
  • Using Tools.php
    by Wayne Luke
    Within your vBulletin Download Package, we provide a file called tools.php, this file isn't uploaded to the server by default as it is considered to be a significant security risk. However, there are times when you need to change specific settings and aren't able to access your AdminCP directly. Uploading to the Server It is recommended that tools.php is installed in the /core/install directory. To do this, follow the steps below: Connect to your server with your favorite SFTP or SCP client. In you...
    Sat 27th Oct '18, 11:45am
  • Third-Party Logins: Twitter
    by Wayne Luke
    You will need to use an existing twitter account in order to use this functionality.

    Create an app using your twitter account

    In your browser go to https://apps.twitter.com/app/new

    Check App Settings

    Go to the application settings (e.g. https://apps.twitter.com/app/12345/settings where 12345 references the app created in step 2. You can access the settings by going to the list of
    your apps (https://apps.twitter.com), clicking on the app link, then clicking...
    Tue 10th Apr '18, 9:00am
Working...
X