Hotaru Docs

 [həʊdɒks]

Admin Settings

Settings

The Admin Settings page provides system options such as site name, theme, friendly urls and site email. Additional settings are added on Plugin Settings pages.

Each setting on the Admin Settings page is pulled directly from the database with each name matching a global constant (hence the rather user unfriendly names such as CSS JS CACHE).

SITE_OPEN

If set to OFF, only users with "admin access" permissions will be able to enter the site. Others will see a message about the site being closed temporarily for maintenance.

SITE_NAME

Your website's name, e.g. "My Website"

THEME

A default Hotaru installation will use the default theme, i.e. default/

Note: It must end with a forward slash (/).

ADMIN_THEME

A default Hotaru installation will use the default Admin theme, i.e. admin_default/

Note: It must end with a forward slash (/).

FRIENDLY_URLS

If ON, a url may look like this:

http://example.com/sports/what-a-day-for-fishing/

If OFF, it may look like this:

http://example.com/index.php?page=46

Hotaru may be a little slower with friendly urls enabled because when loading a page, it has to compare the url with the page titles in the database. On the other hand, friendly urls and more readable and arguably improve rankings in search engines.

SITE_EMAIL

This email address is where all site generated emails are sent from, e.g. post notification, registration emails, database errors, etc. E.g. admin@example.com

DB_CACHE / DB_CACHE_DURATION

The database cache is only used for caching plugin hooks. By default, the DB_CACHE duration is 12 hours, but most database caching is handled by Hotaru's smartCache functions which detect updates and refresh the cache accordingly.

RSS_CACHE / RSS_CACHE_DURATION

The RSS cache is used by the Admin Home page and, potentially, plugins that use RSS.

CSS_JS_CACHE

This cache is used for combining and archiving CSS and JavaScript files included by plugins. The default duration is about 1 year because it automatically detects file changes and updates the cache accordingly, so there's no need for a duration option.

HTML_CACHE

This cache is usually used for saving blocks of HTML code, such as widgets. This cache is also updated automatically by smartCache.

DEBUG

The debug option shows the number of database queries, page loading time and memory usage in the footer of your theme. It also allows errors to shown on the screen, database errors to be emailed to the site admin, and prevents CSS and JavaScript files from being minified.

SMTP

SMTP settings are provided for web servers that require email authentication. If your server has this requirement, you should fill in these settings. Ask you web host for details of the host, port, username and password. Note: To use this SMTP email authentication option, you will need the PEAR Mail package.

SYS_FEEDBACK

Enabling system feedback allows HotaruCMS.org to alert you of Hotaru updates and collect a daily copy of your System Report.

Getting StartedDesign and LayoutPlugin DevelopmentAdvanced TopicsFunction ReferenceTroubleshooting