Hotaru Docs

 [həʊdɒks]

Admin Settings Page - About

The admin settings page shows a list of settings pulled directly from the database with each setting name matching a global constant (hence the rather user unfriendly names such as CSS JS CACHE ON).

Site Open

SITE_OPEN: true

If set to false, 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

SITE_NAME: Hotaru CMS

Locations

Locations need to end with a forward slash (/):

THEME: default/
ADMIN_THEME: admin_default/
LANGUAGE_PACK: language_default/

Friendly urls

FRIENDLY_URLS: false (true/false)

If true, a url may look like http://www.mysite.com/sports/what-a-...y-for-fishing/

If false, it may look like http://www.mysite.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

You'll need to change this.

SITE_EMAIL: admin@mysite.com

Database cache

DB_CACHE_ON: true (true/false)
DB_CACHE_DURATION: 12 (hours)

The database cache is used for caching plugin hooks only. You should set it to false when installing or upgrading plugins or their plugin hooks will be ignored for the length of DB CACHE DURATION.

SimplePie RSS cache

RSS_CACHE_ON: true (true/false)
RSS_CACHE_DURATION: 60 (minutes)

The RSS cache is used by the front page of Admin, which shows updates form these forums. The RSS Show plugin overrides these settings.

CSS & JavaScript cache

CSS_JS_CACHE_ON: true (true/false)

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

HTML_CACHE_ON: true (true/false)

This cache is usually used for saving blocks of HTML code, such as widgets. This cache only lasts 10 minutes, but it regenerated after every update to database tables specified in the code.

Debug

DEBUG: false (true/false)

The debug option simply shows the number of database queries, page loading time and memory usage in the footer of your theme. This can be handy when testing the "weight" of a new plugin or other feature.

Getting StartedDesign and LayoutPlugin DevelopmentAdvanced TopicsFunction ReferenceTroubleshooting