Manual

From Habari Project

Jump to: navigation, search

Contents

Introduction

Welcome to Habari, the next-generation online publishing platform!

Habari was built from the ground-up with a firm understanding of the current state of blogging, and with a strong eye toward the future of internet publishing. Habari strives to make it as easy as possible to publish your content. It stays out of your way as much as it can, and lends a hand where it's needed.

The word "Habari" is Swahili for "news", as in "What's the news?" We feel this is an appropriate name for a blogging package not just because of the clever tagline, but because blogs are so often used to tell others what's the news in your life or your business.

As a Free Software project, Habari's most valuable asset is the community of users and developers who collaborate to improve the product. Habari is built by people just like you: folks with an interest in blogging and internet publishing.

Installation

Habari has a few Server Requirements, which you will need to meet to be able to run Habari. If you have what is required, (or better), you are good to go! As Habari is still in development, no guarantees are made that these are fully stable versions, or that updating won't break the current database structure.

To install the latest stable version of Habari:

  • Download http://habariproject.org/en/download and unzip the Habari package.
  • If you are using MySQL or PostgreSQL, obtain the connection settings needed below, or create a database for Habari on your web server.
  • Upload Habari files on your web server.
  • Point your web browser at http://example.com/ (the location of your Habari files on your server) to begin installation with the Database Setup.

The Habari installer initially presents you with a choice of languages that it will use for the interface. Select the correct locale code from the list for your language of choice. The default selection is "en-us", which is English, United States.

Clicking the question mark at the top of any section of the installer will reveal more information about each field in that section.

Depending on the Database Type you set, you may need to enter some of the following information:

  • Database Type: You can choose between MySQL, PostgreSQL, or SQLite. Your hosting company should be able to tell you what you should use.
  • Database Host: Again your hosting company should have provided this information when you first joined.
  • Username: This is the username used to connect Habari to the MySQL database.
  • Password: This is the password used to connect Habari to the MySQL database.
  • Database Name: Again your hosting company should have provided this information when you first joined.
  • Table Prefix: You will only need to change this if you have more than one version of Habari installed.

The Site Configuration settings you will need to set are:

  • Site Name: The name of your blog.
  • Username: The name or alias you wish to use to administer your blog. This should not be the same as the username for the database.
  • Password: The password associated to the above Username. Enter this in the second box, just to make sure you get it right.
  • Admin Email: This is the email address associated with the above Username. Habari will email you to let you know everything is working.

The installer recommends several plugins upon initial install. These plugins are checked in the next section, Plugin Activation. Additional optional plugins are included in the core installation, but these plugins are not checked by default. If there are additional plugin present in addition, Habari will list these here as well. Choose the plugins that should be activated upon installation by checking the box next to each.

Conclude the installation process by clicking the "Install Habari" button. When Habari completes processing, installation is complete.

The End! Habari should now be installed.

Full Installation Instructions are available, including some details of how to adjust your settings for different web servers and specific configuration information for several popular hosting companies.

If you are happy to use the current development version of Habari, the full instructions explain how to access the Habari subversion repository; however, for most normal users you will need to download the latest stable version of Habari.

Using Habari

After you have installed Habari, go to http://example.com/admin/. You will be taken to a login page. Enter your user name and password to open up Habari's administration interface. You will be greeted by the Dashboard. This page provides a snapshot of useful information, such as the total number of posts and comments on your site, the number of posts you've made, and more. Later you can install plugins to add new modules to the dashboard, greatly expanding its usefulness.

The primary way you will interact with Habari is through the main menu. The main menu is accessed by placing your mouse at the top left of the window. The menu should automatically drop down, to reveal to you the available choices. The menu items users see will be controlled by the permissions assigned to them by the site administrator. Clicking on any menu item will take you to the corresponding page within the administrative interface. For details on each menu item, see the corresponding section of this manual.

It should be noted that the main menu can also be accessed by keyboard shortcuts. If you press the Q key on your keyboard, the menu should expand. Press the Q key again to hide the menu. When the menu is displayed, each menu item has a keyboard shortcut displayed to the right. Using the keyboard shortcuts you can quickly navigate through Habari. Want to create a new entry? Press Q, then the 1 key. Want to change your site's theme? Press Q, then T. Want to add a new user? Q U.

Your First Post

You can create your first post by clicking on the main menu, then selecting "Create Entry".

You are now looking at the publish entry page, by default you have three fields into which to enter information.

Create Entry admin page
  • The Title box is the name of your entry, this can contain a single word, a sentence, numbers, or symbols producable by your keyboard. By default, the title you supply will be used to create the URL by which this post will be accessed.
  • The Content box contains the main body of your entry. In here you can put almost anything imaginable, although currently you will have to manually enter HTML for URL links and formatting such as bold or underlining. Beneath the content box is a small handlebar, which you may click and drag to adjust the amount of space used by the box.
  • The Tag box contains the 'tags', or free-form labels, you apply to your content. You can use as many different tags are you like to describe your entry. If you are writing a post about a recipe you want to try, you might tag the post with the key ingredients. This allows visitors to navigate your site by the tag words, to find other recipes that use the selected ingredient. See the tags section for a more thorough description of tags.

Pressing the Save button will save your work into the Habari database. The post will still be a Draft, which means it is not available for the public to read. You can edit and save drafts as many times as you like, to make sure you get the post just right before letting the world read it. When you are satisfied with your post, click the Publish button. This will make the post visible to the world on your front page, as well as in your Atom syndication feed. Congratulations, you've posted your first entry!

You also have an additional button between the Tag box and the Save/Publish buttons, the Settings button. It contains optional extras you may wish to use. Clicking it opens a pagesplitter (so called because it splits the page).

  • Settings:
    • Content State: You may manually adjust the status of your post. Instead of clicking the Publish button, you may select "Published" from the content state drop-down, and then click the Save button. If you want to unpublish something -- that it, keep it in the Habari database but prevent readers from seeing it -- you may change a Published post to Draft and then click Save. Plugins may add new content statuses.
    • Comments Allowed: This tick box determines whether or not your visitors can leave comments on this item. When the box is ticked comments are allowed. By default this is set to ticked. If you remove the tick and click Save, no new comments will be accepted on this item. Any existing comments will be preserved and displayed.
    • Publication Time: This is the time your post is set to be published. This is normally set by Habari. When you first begin a post, Habari will set the publication time to the current time. When you publish the post for public viewing, Habari sets the publication time to the time you hit the Publish button. The only instance when you should change the publication time is when you wish to create a scheduled post. If you set the publication time to a date and time in the future, then click the Publish button, Habari will schedule the post for publication at the time you indicated.
    • Content Address: This box lets you set a different slug for your entry. This is useful in case the main title of your entry contains unusual characters or is excessively long. The name you provide in this box will appear in the address window in your web browser, not the title of the entry.

Key Terms and Ideas

Content Types

As a tool for managing content, Habari defines two default types of content.

  • Entries are the most commonly used content type. This is the content type you use when creating a new blog post. They are displayed in reverse chronological order (newest first) on your home page and in your Atom syndication feed. You would use entries to post a review of the movie you watched yesterday, or what your weekend plans are.
  • Pages are used for static information on your site. Pages typically live outside of the date-based chronology of your site. You would use a Page to describe something that isn't associated with a specific date or time, like an "About The Author" biography.

Plugins have the ability to add additional content types.

NOTE: When discussing Habari, the term "post" will frequently be used to mean any kind of content. If the content type matters for documentation or example purposes, a specific content type will be used. Entries and Pages are both Posts.

Content Statuses

Out of the box Habari maintains three post statuses - draft, published, and scheduled. Plugins have the option of adding further statuses to this list. The Undelete plugin that comes with Habari, for example, adds the deleted status.

  • Draft. Drafts are unfinished, unpublished works. Drafts are not visible to regular visitors of your site. All new posts default to the "draft" status and remain that way until you explicitly change their status. As long as you don't publish the post, it will remain in this state so you can add to it, edit it, and change it as much as you want without being concerned that others will see it.
  • Published. Published items are available for the entire world to read, and are included in your Atom syndication feed. As soon as you click the Publish button on Habari's post composition page, the status of the post is set to published. At this point it is viewable by the public at large. You can still edit the post.
  • Scheduled. If you change a post's publication time to a future date, then click the Publish button, Habari sets its status to scheduled. The post will be visible to you when you are logged in to Habari's administrative section, but not to the general public. When the time you set for publication arrives, Habari will automatically change the status to published and make the post available for public viewing.

Tags

Tagging is a non-hierarchical way to categorize your content. When you create a post, you label it with one or more tags to show readers what other posts on your site it is related to. Tags have only a general semantic meaning, because the context of a label can change it's meaning, and this context isn't a part of the tag. Tags do, however, allow you to show the general categories of your work without forcing it into a hierarchical system of categories.

Comments

Readers can add feedback to published posts via comments. Habari requires all comments to be moderated before they are displayed on the site. Plugins can change this situations so that comments from frequent commenters are automatically approved, or comments left as spam are automatically marked as spam.

Out of the box Habari maintains three comment statuses - approved,unapproved and spam.

  • Approved - These are comments that you have either manually approved for display on the site, or that have been filtered by a plugin and accepted for display on the site.
  • Unapproved - All comments are unapproved when they are first made. It is up to you as the site administrator to either mark them for approval so they are displayed on the site, mark them as spam, or delete them.
  • Spam - Spam comments are made in the hopes that someone will click through the links that they contain. Often spam is related to gambling or sexually oriented products, but can also be random comments that bear no relation to the post on which they are made. Spam is the reason that all comments are not automatically approved. As said above, you can install plugins in your Habari installation that filter all comments, examining them for the characteristics of spam. If the comment fits the spam profile, it will either be automatically deleted, or marked as spam and retained to further train the spam filtering plugin. It is strongly recommended that you install some kind of spam filtering plugin to save your time and to protect your site.

Feeds

The term feed indicates a stream of data which is "consumed" by a special application called a feed reader or aggregator. Your blog's feed contains the same data that is presented to visitors viewing your site, but it is formatted in a way that is suitable for machine-to-machine communication, as opposed to machine-to-human communication. There are several formats for this machine-to-machine transmission, with the two most popular being RSS and Atom. Out of the box, Habari only speaks the Atom format.

RSS and Atom allow users to subscribe to your web site in their aggregator, like Bloglines or Google Reader. Their aggregator will periodically poll your website (usually once every couple of hours), checking to see if you've published any new content. If you have, your Habari installation will transmit that new content to the aggregator using the Atom format, and your posts will show up in the aggregator's list of new items.

Your main Atom feed can be located by appending /atom/1 to your site's URL. Separate feeds are also available for comments, posts with the same tag, and the comments for an individual post.

Themes

Themes allow you to customize the look and feel of the site for your readers. Habari includes several themes to choose from after installation, and many more are available from the community.

Plugins

By design, Habari by itself has a basic set of capabilities. Plugins add functionality, new capabilities, or additional content types to Habari. Habari includes several out of the box...

Timeline and Loupe

The timeline and loupe

On certain administration pages, the loupe is a sliding, expandable window that operates on the timeline of a group of data. The default position for the loupe is the far right: the most recent items of the collection. The default width of the loupe encompasses 20 items. You can click inside the loupe and drag it left and right across the timeline: this will change the items shown beneath the loupe based on the date range highlighted by the loupe. On the left and right of the loupe are handlebars, which you can click to drag left or right to expand or shrink the size of the loupe: this will increase or decrease the number of items shown below.

The loupe makes it extremely easy to display and select specific timelines of data. You can drag and expand the loupe to display all the items from June of last year to June of this year. Or you can narrow the loupe to only display items from last month, or yesterday.

Administration

The Dashboard

The Dashboard is the first page you see after you log in to Habari's administrative interface. The dashboard can be reached from any page of Habari's administrative interface by choosing Dashboard from the main menu, or by typing Q followed by D.

Dashboard admin page with default modules

The dashboard provides a summary of useful information for your site. The top section contains a couple of sentences telling you how long your site has been active, a series of high level statistics about your site, how many drafts you have awaiting completion, how many scheduled posts you have, and how many comments you have awaiting moderation.

Next is a series of modules. Modules are small sub-blocks that focus on specific details about your site. Habari comes with modules that contain lists of your recent published posts, recent comments on your blog, and recent activity that has been logged. Plugins can add various other modules dedicated to specific purposes. A plugin that redirects your feeds through the Feedburner service, for example, may use a module to let you know how many subscribers you have, while a plugin that tracks links to your site may use a module to show you the recent links.

Modules can be moved and rearranged, added, and hidden, so they stay in the positions that is most logical to you and show you the information you want to see. If you don't care about recent log activity, click the x in the upper left corner of the log module to hide it. If the first thing you want to see is any recent comments on your site, move the recent comments module to the top left of the modules section by clicking on the grey rectangle in the upper right of the module and dragging the module .

After all the visible modules, the dashboard has a dropdown list of all the modules that are available to show. To show a module you don't currently have displayed, choose the module then click the button with a + on it to the right of the list to display the module.

Managing Content

To manage your content -- draft or published, entry or page -- select one of the Manage links from the main menu. Habari creates a main Manage menu item, which has a submenu listing each type of content in your system, providing a convenient way to access a specific type of content. The destination for each of these menu links is, in fact, the same page: the menus merely provide a shortcut to filter the display by the specified content type.

Manage Posts page

Habari strives to make it as easy as possible to find and manage your content. The first thing to note when visiting the "Manage Content" page is the timeline.

Beneath the timeline are the posts returned by the current filters. Beside the timeline are the filter controls, and additional navigation controls. By default, 20 posts will be presented beneath the timeline in reverse chronological order (newest first). If you have more than 20 items that satisfy the filters, you can page forward and backward to see the next or previous set of 20 posts using the "Older" and "Newer" links at the top left and right, respectively. To the right of the "Older" link is a report of the number of posts that match the current filter, and where your current display falls within that set.

Above the timeline on the Manage Content page is the search box. You can use this box to type in search terms to find content. To find all posts that include the word "Habari", simply type "Habari" into the search box and wait a moment. The list of posts below will be updated, and the quantity indicator to the left of the filter box will be updated. Beside the search box are several links that provide shortcut filter controls. To see only entries, click the "Entry" link: this will add type:entry into the search box, restricting the list of posts to only those of type Entry. Click the "Entry" link again to remove that filter from the list. Using these buttons, you can quickly drill down to see all your content. Click the "Entry" link and the "Draft" link to see all your unpublished entries. Click the "Entry" link again to see all draft posts, regardless of content type.

Additional filters are available for manual entry. To see all posts authored by Scott, type "author:scott" into the search box. There is no shortcut link for these other filters because it's possible that a single site might have, for example, a sufficiently large number of authors as to make the links dominate the screen.

You can combine the filter links with manual search words. To see all drafts about pizza, click the "Draft" button, and then type in "pizza". Or, manually type in "status:draft pizza".

The loupe will update for the current set of filtered posts. The combination of filter controls and timeline provide for extremely flexible content navigation.

Beneath the timeline is the list of posts that match the current filters. The post title, status, author, and date are displayed above a brief snippet of the post. This snippet should provide a bit of context about the post if you can't remember it from the title. The title of the post is a hyperlink, allowing you to click it to view that post on the publish page. The status, author, and date are also hyperlinks that show you similar items (same status, same author, or same publication date). To the right of the post is a "drop button". This is a special control mechanism that acts like both a button and a drop-down list. If you place your mouse over the drop button it will expand to reveal all of the options available to you. The first item -- the one displayed before you placed your mouse over the drop button -- is the default action that will occur if you click your mouse. You may select one of the other items from the list, though, if you don't want to take the default action. When managing content, the usual values of the drop buttons will be "Delete" and "Edit".

To the left of each post is a checkbox. You can tick the boxes to mark one or more posts, allowing you to delete a group of posts. The number of posts marked will be indicated above and below the list of posts. The posts you select will be remembered, allowing you to page through all the posts that match the current filter. The number shown will remind you that you have posts selected that might not be displayed on the current page. Next to the number of selected posts (which says "None selected" if you've not yet selected any) is another checkbox. If you tick this box, all posts on the current page will be selected. Once you do so, another link will appear which allows you to select all posts which match the current filter, even those not visible.

Once you have some group of posts selected, you can delete the entire group at once by clicking the Delete Selected button to the right.

Managing Comments

To manage your comments select the Comments link from the main menu, or type Q, then C.

As with posts, the first thing to note when visiting the Comments page is the timeline and the loupe at the top of the page. The timeline works with comments the same way as it does with posts.

The Manage Comments page

Beneath the timeline are the comments returned by the current filters. Above the timeline are the search and filter controls, and additional navigation controls. By default, 20 comments will be presented beneath the timeline in reverse chronological order (newest first). If you have more than 20 items that satisfy the filters, you can page forward and backward to see the next or previous set of comments using the "Older" and "Newer" links at the top left and right, respectively. To the right of the "Older" link is a report of the number of comments that match the current filter, and where your current display falls within that set.

In the top center of the Comments page is the search box. You can use this box to type in search terms to find comments. To find all comments that include the word Habari, simply type Habari into the search box and wait a moment. The list of comments will be updated, and the quantity indicator to the left of the search box will be updated. Beside the search box are several links that provide shortcut filter controls to the different statuses and types a comment may have. To see only Approved comments, click the Approved link: this will add status:Approved to the search box, restricting the list of comments to only those which are approved. Click the Approved link again to remove that filter from the list. Using these , you can quickly drill down to see all your comments. Click the Unapproved link and the Pingback link to see all your unapproved pingbacks. Click the Unapproved link again to remove the Unapproved filter and see all pingbacks, regardless of status.

You can combine the filter links with manual filter controls and search words. To see all approved comments containing the word terrific, click the Approved link, and then type in terrific. Or, manually type in status:Approved terrific.

The timeline will update for the current set of filtered posts. The combination of filter controls, timeline and loupe provide for extremely flexible content navigation.

Beneath the timeline are the comments that match the current filters, with a set of buttons and a checkbox located above and below the comments. Each comment shows the commenter's name, url, and email address ( if they left them ), the title of the post the comment was made on, the time and date of the comment, and the text of the comment. The commenter's url serves as direct link to the commenter's site, the email address serves as a link to send them an email, and the post title serves as a link to the comment and the post on which it was made.

To the right of each comment is a drop button, as seen with on the Manage Posts pages. The default action for comments on the drop button is Unapprove - to unapprove the comment. You may select one of the other items from the list, though, if you don't want to take the default action. These other actions are Spam - to mark the comment as spam, Approve - to approve the comment, Delete - to delete a comment completely, and Edit - to take you to a new page where you can modify a comment.

To the left of the comment is a checkbox. You can tick the boxes to mark one or more comments, allowing you to execute actions against groups of comments. The number of comments marked will be indicated above and below the list of comments. The comments you select will be remembered, allowing you to page through all the comments that match the current filter. The number will remind you that you have comments selected that might not be displayed on the current page. Next to the number of selected comments (which says "None selected" if you've not yet selected any) is another checkbox. If you tick this box, all comments on the current page will be selected. Once you do so, another link will appear which allows you to select all comments which match the current filter, even those not visible.

Once you have some group of comments selected, you can execute a single action against them. Just click the button at the top or bottom of the page for the action you wish to perform. As with the drop button, your choices are to Delete the comment, mark the comments as Spam, Unapprove previously approved comments, and Approve unapproved comments.

Managing Tags

To manage your site's tags, select Tags from the main menu, or type Q, then A.

The Manage Tags page

At the very top of the tags page is a search box. After your site has been in use for a period of time, you can have quite a few tags. Use the search box to narrow the number of tags which you are viewing.

Below the search box you will see the tags which you have used on your site. These will be of various heights, as a visual cue to how frequently they have been used, and each one will have a superscript number to the right of it denoting the exact number of posts on which it has been used.

Select tags by clicking on them. A second click on a tag de-selects it.

To rename a tag, click on it, type the new name in the text box below the tags, then click the Rename button.

To merge multiple tags into one tag, click on each tag you want to merge together, type the name you want to give the tags in the text box below the tags, then click the Rename button.

To delete one or more tags, click on each tag you want to delete, then click the Delete Selected button beneath the tags.

Options

Options admin page

Options for your site include such things as the site title, tagline, number of posts per page, time zone, etc.

To edit your site's options, either select Options from the main menu, or type Q, then O.

Options are searchable by using the search form at the top right of the page.

Themes

Themes admin page

To change your theme select Themes from the main menu, or type Q, then T. This will take you to the Themes page.

The Themes page is divided into two sections. The top section contains one item, your current active theme and its configuration options. The bottom section contains all the themes that are available for you to use.

The current active theme section is split into one, two or three sections, depending on the features offered by the theme. The top section contains the name of the theme, its version, developer, a screenshot and a brief description. This section will occur for all themes. If the theme has configuration options, the theme's configuration section will occur next. If a theme has support for blocks, the blocks drag-and-drop configuration section will occur next. The Charcoal theme is an example of a theme which includes all three sections.

The bottom section of the Themes page lists all the themes with each theme showing its name, version and developer above a screenshot of what the theme looks like in use. Below this is a dropbutton that allows you to Preview or Activate a theme. Previewing a theme will temporarily switch just your view of your site to use the theme you are previewing. Other users will not see this preview. The preview will end when you end the preview manually by clicking End Preview or when your session times out. You can configure a theme whilst it is being previewed too.

Activating a theme automatically deactivates the theme that is currently active, and activates the theme you selected.

Areas and Blocks

Areas are places in a theme's templates that are designated to render block content. Blocks are a way for plugins to provide content that can be mapped to specific output locations in the theme by the user without writing code.

If the active theme has support for Areas, you will see a section where you can configure areas for your theme once the theme has been activated.

You can add blocks to your theme by selecting the appropriate New Block Type, giving it a Name that suits your purposes and clicking +. This will add a new block type. If the block is configurable, you will see a Configure link below the block just added which you can click to configure the block. Once the block is configured, if appropriate, drag-and-drop it to a named area on the right and Save your block location.

You can drag-and-drop blocks to re-arrange them and delete them from the areas, but remember to Save after making your changes to ensure they take effect.

To delete a block, remove it from the areas on the right and then Delete it from the section on the left.

Plugins

Plugins admin page

To manage your plugins, select Plugins from the main menu, or type Q, then P. You will be taken to your Plugins page.

The plugins page is divided into two main sections. At the top of the page is a list of the plugins you have activated. The bottom of the page contains a list of the plugins you have installed, but have not yet activated. Even if you have not added any plugins yourself, this section will contain the plugins that come with Habari.

To the right of each plugin is a dropdown button containing the actions that it is possible for you to perform with the plugin. For inactive plugins, the only possible action is Activate, which you may do by clicking on the dropdown button. Once you do so, the plugin is removed from the list of inactivate plugins and transferred to the list of active plugins.

Active plugins can have several actions associated with them. The most common are Configure, which opens an inline form in which you can set the configuration options for that plugin, and Deactivate, which removes the plugin from the list of active plugins and returns it to the list of inactive plugins. If there is no configuration possible for a plugin, the only action you will be able to perform with it is to deactivate it. Depending on what it does, plugins may add other options to the drop-button.

Each plugin that needs to be configured will have different options, but they all work the same general way. There will be a series of fields to fill in, then a Save and a Close button. After setting the plugin options to your satisfaction, click the Save button to save the changes to the database. Click the Close button to close the configuration dialog.

Some active plugins will have a question mark (?) to the right of their name. Clicking on the question mark will open an inline frame containing usage instructions for that plugin.

Users and Groups

Habari supports multiple users, each of which can be assigned to groups with different permissions within the system. Some users can have phenomenal cosmic powers (over the blog, that is) while some users can be restricted to simply writing new posts depending on their groups.

Users can be members of one or more groups. Groups are assigned permissions. The combined permissions assigned to all the groups to which a user belongs define the things that user is permitted to do within the blog.

When we talk about "what a user can do", what we're really saying is "things that can be done by one of the groups to which this user belongs". It's important to remember that users don't have any permission on their own. Users can only do stuff based on the permissions assigned to the groups to which they blog. But it's awkward to keep saying "This user belongs to a group with permission to do Foo", so for brevity we'll simply say "Users who can do Foo".

Users

Users with the "add, remove, and edit users" permission can, obviously, add, remove, and edit users. A user with this permission can access the Users page from the main menu. Here is presented a list of all the user accounts in the system, and a brief report on their activity within the system. Above the user list is a form to create a new user: simply supply a username, email address, and password.

If there are many users on the system, the display can be filtered by searching for part of a user name.

To the left of each user is a checkbox. This is only used when deleting a user account. Select the user(s) to be deleted, select whether to reassign that user's posts to a different user or to delete the posts from the system, and press the delete button.

Clicking on any user will display that user's details page.

User

From a user's details page one may specify additional information about a user or they may specify their own information, if they're viewing their own user detail page. Most of the data displayed on this page is purely informational, and not really used by Habari anywhere.

The Apply button is used to save any changes made on the user page. A user can also be deleted directly for their page by using the delete button. Choose whether you want to reassign posts to another users or not before using the delete button on the page.

Note that plugins can modify this page to add new fields.

Groups

Group admin page showing permissions granted to 'admins' group.

Users with the "manage groups and permissions" permission can access the Groups page from the main menu. By default, all groups defined within the system are displayed. You may modify a single group's details by selecting it from the drop-down list at the top of the page, by clicking on the group's name in the main list, or by clicking the "Edit" option from the drop-button to the right of that group.

To add a new group, simply supply a group name in the field at the bottom of the page and click the "Add Group" button. Newly created groups will have no permissions, by default.

When editing a group, you are first presented with the list of users that are members of that group. You may add additional members from the drop-down list and then clicking the "Add" button. IMPORTANT: changes to the list of users are not saved to the database until you click the "Apply" button at the bottom of the page!

Beneath the user listing is a list of all of the defined permissions within the system, with controls to enable or disable access to these permissions for the group.

Permissions

There are two kinds of permissions within Habari: binary and CRUD:

Binary Permissions

Binary permissions are either/or: a group may either do the thing, or not do the thing. For example, the "add, remove, and edit users" permission is either/or. Either a user can add and edit users, or they cannot.

There's a subtle distinction for binary permissions between "not assigned" and "denied". In either case, the group is not permitted to do the thing defined by the permission. The distinction comes into play when a user belongs to multiple groups. Let's look at a practical example to illustrate the point.

User Scott is assigned to the "Content Managers" group, which has been granted permissions to "Manage comments on all posts", "Manage comments on one's own posts", and "Manage tags". The specific assignment of these permissions allows Scott to manage the content on the blog. The "Content Managers" group is neither granted nor denied the "Change theme" permission. Since the "Change theme" permission is not specifically granted, Scott may not change the site theme.

Scott is next added to the "Site Managers" group, which has been granted permission to "Manage options" and "Change theme". Since Scott is in a group that specifically grants permission for "Change theme", Scott may now change the current theme.

After some time, the blog owner decides that he really likes the current theme, and doesn't want anyone changing it. Rather than go through each of the groups to manually remove any previously granted permission to "Change theme" the site owner makes a new group called "No Theme Changes", and assigns all the users to this group. The only permission setting for this group is to specifically deny access to the "Change theme" permission. The deny permission overrides any specifically granted permission for the same thing. Scott is now a member of the "Site Managers" and "No Theme Changes" groups. The former specifically grants him permission to change the theme, but the latter specifically revokes permission to change the theme. Denied permissions always override granted permissions.

CRUD Permissions

CRUD stands for "Create, Read, Update, Delete" and indicates that there are several related actions for that permission. For example, "Permissions on one's own posts" is CRUD. A user might be permitted to create new posts, but not update or delete posts they had previously created.

As with binary permissions, there is a difference for CRUD permissions between "not assigned" and "denied". A particular permission not assigned to one group may be assigned to another group. A user that was a member of both groups would have the permission, because one of the groups to which they belong was assigned that permission. Any CRUD permissions that are specifically denied to a group will deny that permission to all members of the group, regardless of other group membership that might grant that permission.

Using the cascading nature of groups and permissions, it is possible to create robust group assignments to enforce granular permissions. You can create "Content Managers" who have access to modify the content of the site without changing site settings or managing users. You could then create a "Users Managers" group that only has permission to manage users. As members of the "Content Managers" group gain experience and prove their trustworthiness, you can add their user accounts to the "User Managers" group so that they can begin adding new users, and managing current ones.

Default Permissions

Habari creates a set of permissions to enable managing access to its different areas. Plugins can add their own permissions to control access to their added functionality. The default permissions are listed below.

  • Super User
    • Permissions for super users: This permission implicitly grants all members of the group access to all permissions even for the ones from which any of their groups is denied.
  • Administration: These permissions control access to the different admin interface areas and are all of a binary type. If no access is defined or if access is denied to any of these permissions, the relevant admin page will be hidden from the menu.
    • Manage comments on all posts: Allow or deny editing and moderating all comments within the blog.
    • Manage comments on one's own posts: Allow or deny editing and moderating comments made on the user's authored posts
    • Manage tags: Allow or deny access to rename or delete the site's tags.
    • Manage options: Allow or deny changing the site's main options
    • Change theme: Allow or deny access to change the currently active theme.
    • Configure the active theme: Allow or deny access to change the configuration of the currently active theme.
    • Activate/deactivate plugins: Allow or deny activating or deactivating plugins.
    • Configure active plugins: Allow or deny access to change the configuration of the currently active plugins.
    • Use the importer: Allow or deny access to use the importer plugins that use the admin import page.
    • Add, remove, and edit users: Allow or deny access to fully manage the blog's users. Note that if a user doesn't have this permission, they will not be able to change their own user information.
    • Manage groups and permissions: Allow or deny access to creating, editing or deleting groups and changing their permissions.
    • Manage logs: Allow or deny access to the logs page.
  • Content: These permissions control what type of access is allowed to the content of the site. If no access is defined or if access is denied to any of these permissions, the relevant admin page will be hidden from the menu. As plugins add new content types, new permissions are added relevant to each of the types.
    • Permissions to all posts: Controls the access level to all the site's posts of any type.
    • Permissions to posts of type "entry": Controls the access level to all the site's posts of the type 'entry'.
    • Permissions to posts of type "page": Controls the access level to all the site's posts of the type 'page'.
    • Permissions on one's own posts: Controls the access level to all the posts created by the user and of any type.
    • Permissions to other users' unpublished posts: Controls the access level to other users' unpublished posts.
  • Comments
    • Make comments on any post: Allow or deny ability to post comments on site's posts.

Logs

Habari keeps records of most of the interesting things about which it knows. It records each time someone logs in, each time a new item is posted, and the like. By selecting Logs from the main menu (shortcut: Q L), you can review the recent activity on your site.

At the top of the page is the familiar loupe and filter input box, allowing you to control what log messages to display. At the top of each column of data is a drop-down allowing you to filter the logs by specific elements. For example, you can select all the log entries generated by a specific IP address, or all logs generated by a specific user. You can apply multiple filter controls, allowing you to drill down to all authentication messages from a specific IP address and a specific user.

To the left of each log entry is a checkbox, allowing you to select one or more log entries. Selected entries can be manually deleted.

It is important to note that these logs are not permanent, and will expire after some time (usually a few weeks).

Importing Content

Habari is able to import post, comment, category/tag, and user data from a growing list of importable platforms. To import content, first activate the corresponding Importer plugin on the plugins page (Q P in the Main Menu) and then follow the steps detailed on the Import page.

Once the import process is complete your old data has been copied and can be managed through Habari, and can be deleted from the other platform if desired.

Important Note: Deactivate any spamchecking plugins or plugins that contact outside sites before beginning to import your data. If active, these will greatly slow down, or even prevent, the successful completion of the import process. In the case of spamchecking plugins, comments may incorrectly be marked as unapproved if a spamchecker plugin is active.

After you have completed the import process, remember to reactivate the plugins you deactivated.

Extending Habari

By design, Habari is built with the basic set of capabilities needed by everyone to create and maintain a blog or simple website. It is, however, also designed to be highly extensible through the use of plugins and themes other than those with which it ships.

Themes

Your site's theme is its basic look and feel as seen by your visitors. Habari comes with several themes.

  • Charcoal - Charcoal is a unique theme designed to highlight some of Habari's capabilites.
  • Mzingi - Mzingi is a basic theme designed to serve as a foundation from which you can create your own themes.
  • K2 - K2 is one of the most popular themes in the blogging world.

You aren't limited to these themes in your choices. There are many more themes listed in Habari's theme repository at http://wiki.habariproject.org/en/Available_Themes

Plugins

Habari comes packaged with several plugins. These are intended to serve as examples of best practices in plugin creation for developers, and to provide useful functionality to everyone.

Miscellaneous Plugins

  • Core Dash Modules - These included a latest posts module, a latest comments module, and a log module. Activate this plugin to get an overview of the latest activity on your site whenever you log in.
  • Pingback - Enable this plugin to send pingbacks to sites to which you link in your posts.
  • Spamchecker - Activate this plugin to perform a basic spam check on comments that your site receives.
  • Undelete - We all make mistakes, including deleting posts that we later wish we had kept. Activate this plugin to retain deleted posts, so if you change your mind or discover you made a mistake after deleting something, you can recover it.
  • ThemeHelper - This plugin is relied on by some themes. It is especially helpful if you create your own themes.
  • Simple Private Posts - This plugin allows you to mark a post as private, making it available only to readers to whom you have given permission. The public at large is not able to see it.

Media Plugins

  • Habari Media Silo - In Habari, a media silo is a way to manage media that you would wish to embed into your posts. Activate the Habari Media Silo in order to be able to upload images to your site and embed them in your posts with the proper HTML tags with a simple click of the mouse.
  • Flickr Silo - Activate the Flickr Silo to access the images you have stored on Flickr with the same ease with which you manage locally stored images.
  • Viddler Silo - Activate the Viddler Silo to access the videos you have stored on Viddler.

Importers

  • Wordpress Importer - Activate the Wordpress Importer to import your content from Wordpress into Habari.

In addition to the plugins that are packaged with Habari, dozens of other plugins have been created to extended the software's functionality. These cover everything from WYSIWYG editors, to contact forms, to plugins to allow you to implement custom URLs for your site. Your can find an extensive list on the wiki plugin page, and even more at the Habari Distribution Directory.

Getting Help

Mailing Lists

There exist two mailing lists for Habari, one focused on end-user support, and the other focused on nitty-gritty development and programming issues.

habari-users is entirely focused on Habari end-user support. This is the first place to ask for help. When reporting problems, please provide as much information as you can. Be sure to accurately copy any specific error messages you receive. If you can reliably reproduce a problem, describe in detail the steps necessary to do so. It is often helpful to provide a link to your site, so that others can see the problem first-hand, but at the least please indicate who your hosting provider is.

habari-dev is focused on Habari development: programming, plugin design, and the like. All of Habari's long-term development takes place on this list, and ideas and suggested, debated, and revised. If you're interested in helping Habari programming, this is the list for you.

IRC

IRC stands for Internet Relay Chat. It is a form of realtime instant messaging that allows groups to meet and discuss subjects of common interest.

Habari maintains an irc channel on irc.freenode.net, #habari. It can either be accessed directly through your favorite irc client, or, if you're new to irc, there is a helpful Habari plugin that allows you to access the channel from within your Habari admin. The plugin, called livehelp, can be downloaded from Habari's plugin distribution page. Install it as you would any other plugin and join us if you have any questions or issues.

Reporting Bugs / Suggesting Improvements

Habari succeeds because people like you help improve it every day. One of the easiest ways to contribute to the success of Habari is to report problems. The habari-users mailing list is the first place that problems should be reported: if the issue is known, you'll be provided with confirmation of that fact and hopefully some information to help you work around the problem until it is fixed. If you identify a new problem, you may be asked to file a bug report. It's easy to do!

Habari's GitHub is the place to file bug reports and enhancement requests. Before you can file bugs, you need to register an account with GitHub.

Creating a New Ticket

The first thing you need to provide is a succinct title of the problem. Be concise, but don't be vague: the title you provide is the first thing people will read when reviewing bugs to be fixed, so make sure that the developers get a jumpstart on your problem by supplying them with a meaningful title. If you see an HTTP 500 error page every time you try to log in, a good summary might be

HTTP 500 error every time I try to log in

This immediately indicates the specific error and the action that produces it. A poor title for this problem would be

Can't log in!

This does not indicate the specific error you see.

Titles are important! Please try hard to provide a meaningful title.

In the section below the title you can assign the issue to someone and set a milestone. Leave these as they are, ie do not assign the issue to anyone or set a milestone. A Habari developer will set these as they estimate when the problem will be fixed and by whom, if applicable.

Below this you enter a full description of the problem or suggestion. Be as verbose as possible. If you have a specific error message, paste it here. If you have log data, paste it here. If you can reproduce the problem in one or more ways, describe in detail each of the ways to do so. The more information you can provide, the greater the chance of a developer fixing the problem! You can also upload screenshots if that helps to describe the problem: click the checkbox labeled "I have files to attach to this ticket". This will allow you to upload files that will be attached to your report. The version of Habari you are using, the browser and its version, and the database backend ( MySQL, SQLite, Postgres, etc. ) are also very helpful in diagnosing and fixing issues that you report.

Please feel free to use GitHub Flavored Markdown to format your issue.

Next, add a few labels to your issue so it can easily be categorized. Please try reuse a label that already exists before creating a new one. If your issue is regarding an enhancement, please ensure you use the "enhancement" tag. The Habari developers love to see suggestions for enhancements because they help steer the long-term growth of Habari.

When you're all done, click "Submit new issue". This will add your issue to the system, and a Habari developer will eventually review it. You might want to bookmark your issue, and come back to check on it periodically: the Habari developers might ask you questions in comments to your issue, seeking additional information or asking you to try a proposed fix to confirm that it works for you.

Please keep in mind when filing issues for bug reports or feature enhancements that the list of issues is completely public. DO NOT post any passwords or other sensitive information.

A note about security issues

As mentioned above, all items filed in the Habari GitHub are public. If you are reporting a security problem, or a potential security problem, we respectfully ask that you first contact security@habariproject.org so that we can review the situation with you without jeopardizing our users' sites. If you open a ticket with details of how to execute an attack against a Habari installation, someone somewhere will see that information and exploit it.

Personal tools