The settings.php File

settings.php is a low-level configuration file for TubePress.

Inside the TubePress Content Directory, in the config subdirectory, TubePress will look for a file named settings.php. If this file exists, TubePress will parse and apply it's contents as low-level configuration.

For standalone PHP users, editing this file is done as part of the initial setup and upgrade procedures. However, both standalone PHP and WordPress users may edit this file to suit their needs.

settings.php Reference

A default settings.php looks something like this:

<?php

return array(

    'user' => array(
    
        'urls' => array(
        
            //'base' => 'http://foo.com/path/to/tubepress',
        
            //'userContent' => 'http://foo.com/path/to/tubepress-content',
        
            //'ajax' => 'http://foo.com/path/to/tubepress/ajaxEndpoint.php',
        ),
    ),

    'system' => array(

        'cache' => array(

            //'killerKey' => 'tubepress_clear_system_cache',
        
            //'directory' => '/some/directory',
        
            //'enabled' => true,
        
            //'serializationEncoding' => 'base64'
        ),

        'add-ons' => array(
    
            //'blacklist' => array(),
        ),

        'classloader' => array(
    
            //'enabled' => true,
        ),
    )
);

As you can see, settings.php returns an associative array, essentially all of which is commented out. To change any setting, you'll simply uncomment the appropriate line and fill in a new value. Let's go through each setting one-by-one.

  • user / urls / base
     

    The web-accessible URL of your TubePress installation. This can be an absolute URL (e.g. http://foo.com/path/to/tubepress) or a relative URL that begins with a / (e.g. /path/to/tubepress)

    By default, this value is auto-detected everywhere except in standalone PHP installations.
     

  • user / urls / userContent
     

    The web-accessible URL of your TubePress Content Directory (usually named tubepress-content. This can be an absolute URL (e.g. http://foo.com/path/to/tubepress-content) or a relative URL that begins with a / (e.g. /path/to/tubepress-content)

    By default, this value is auto-detected everywhere except in standalone PHP installations.
     

  • user / urls / ajax
     

    The URL where TubePress should send all of its client-side Ajax requests. This can be an absolute URL (e.g. http://foo.com/path/to/ajax.php) or a relative URL that begins with a / (e.g. /path/to/ajax.php)

    By default, this value is auto-detected everywhere except in standalone PHP installations.
     

  • system / cache / killerKey
     

    The name of the query string parameter that, when set to true will trigger a flush of the system cache. Changing this is recommended to prevent users from randomly clearing your system cache. For instance, given a killerKey value of foobar, adding ?foobar=true to the end of a URL would trigger a system cache flush.

    By default, this value is tubepress_clear_system_cache.
     

  • system / cache / directory
     

    The absolute path to a filesystem directory on your web server where TubePress should store its system cache. Your web server must have write access to this directory.

    By default, TubePress tries to create and use a unique directory inside your web server's temp directory (e.g. /tmp/tubepress-system-cache-388298359).
     

  • system / cache / enabled
     

    Set to false to completely disable the system cache. This almost never recommended, though can be useful during heavy theme or add-on development.

    By default, this value is true.
     

  • system / cache / serializationEncoding
     

    During construction of the system cache, TubePress gather a large amount of textual information from themes and add-ons. This information is stored internally in a PHP file, and some characters may cause issues when reading/writing the cache file. Therefore TubePress allows you to encode this textual information before storing it.

    The allowed choices for this setting are none, base64 gzip-then-base64, or urlencode. The default value is base64
     

  • system / add-ons / blacklist
     

    An array of TubePress add-on names that should not be loaded. This can lead to a slight performance boost, though usually isn't worth the effort.

    By default, this is an empty array (i.e. array())
     

  • system / classloader / enabled
     

    TubePress utilizes its own high-performance classloader to locate and load its class files. If you would like to instead rely on an external classloader, you can disable TubePress's classloader by setting this value to false.

    By default, this value is true.
     



Last Updated Jul 08, 2016 03:42PM PDT
c65861bf7a72e1a8878bdf73cabbbdbf@tubepress.desk-mail.com
http://assets1.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete