• File types list

    File types list

    The File Types Settings is where you define the different file types (based on their extensions) that can be uploaded as attachments to posts, comments & private messages or even furthermore renamed or edited in b2evolution’s File Manager.

    Each file type can also be associated to an icon, a MIME type and a View Type. The View Type determines how the file can be displayed in b2evolution. For example Images, Videos and Audio files can be displayed inline, in the content of a post, whereas PDF files could only be added as attachments to be downloaded or displayed in another window.

    SECURITY: This is also where you define which file types are "locked" and reserved to be managed exclusively by System Administrators. Files which contain executable code such as .php files or even javascript code such as .html files should be restricted to admins. They are restricted (red lock icon) by default.)

    Additional security considerations

    In b2evolution’s default configuration:

    • Files with a green lock can be uploaded by any user, including Visitors with no authentication. This is used to allow attaching images to comments.
    • Files with an orange lock can be uploaded by Trusted Users only. By default, there are no trusted users on a fresh b2evolution installation.
    • Files with a red lock can be uploaded by administrators only. This is used for adding third party skins and/or plugins to the installation. By default, only the admin account can do this.

    You can finely configure which of your User Groups should have permission to upload/edit files of each security level (green/orange/red) by editing the File Permissions of each User Group.

    See also:

  • Special Front Page (disp=front)

    Special Front Page (disp=front)

    The following parameters could be set for the special front page of your site:

    1. Indexing: Adds a <meta name="robots" content="NOINDEX, FOLLOW"> tag to the headline of the special front page. The NOINDEX parameter aims to prevent search engines robots to index the page that contains it, and the FOLLOW tells search engines that it may follow any of the links contained in the page.
    2. Make canonical:
      • 301 redirect to canonical URL when possible
      • Use self-referencing rel="canonical" tag
      • Use rel="canonical" if not 301 redirected
  • I need further assistance...

    There are several FAQs in this manual:

    If you can’t find an answer in any of these, please ask your question in the forums.

  • Global Hits Summary

    Global Hits Summary

    The Global hits sub-tab shows a bar graph and a table of daily totals that summarize each type of hit made on your site. If you are looking for the total number of hits regardless their type, look at the right column, specifically the right corner displays the total count of them.

    If it is good to know the total number of hits you get in a period of time, it is even more interesting to know how those visitors found your site. b2evolution tracks all the visits and let you check granulated data that may work for any kind of statistics and optimizations that you would to perform, using that valuable information as a main source of reference.

    The global hits in this view are categorized as following, according several pre-defined types, most of them by their User Agent record.

    1. RSS/Atom: feed readers. These are not even identified by the User Agent but by the fact that they hit XML feed pages.
    2. Standard/Robots: search engines crawlers/spiders that identify themselves as such.
    3. Standard/Browsers: browsers such as Google Chrome or Mozilla Firefox (but also includes crawlers that pose as browsers).
    4. Ajax: any asynchronus request received via XMLHttpRequest.
    5. Service: hits referred from b2evolution’s folder /htsrv. This folder holds the html services entry points.
    6. Admin: this is not really a referer type but more a hit type reached from inside of any admin page.
    7. Other: unknown user agents.

    The cells in the results table contain a number that means the count of visit detected as a particular type (columns) on a particular date (rows). Also, by clicking on any of the links, you will be redirected to the All hits tab that offers a detailed view of each one of the hits included in the count. The total column in the table (the last one at the right) shows the totals of hits received on each date, and the last row shows the totals of hits categorized according the types described above.

    Blacklisted

    In older version of b2evolution, one summary item which does not appear separately elsewhere is the ‘Blacklisted’ column. This somewhat confusingly-named item does not refer to blacklisted sites but visits from your own blog to your own blog. In other words, the hits that are called ‘blacklisted’ are really people driving around inside your blog. So a high ‘blacklisted’ score shows that visitors are using many pages within your blog, as opposed to just visiting one page and then leaving.

  • Advanced User Permissions

    This screen allows to set Membership and/or individual Advanced Permissions for each User on the current Collection. This is useful when you really need to give one specific permission to one specific user. However, most of the time, the best practice will be to use Advanced Group Permissions instead.

    Advanced User Permissions

    See List of Permissions for details on each of the possible permissions.

  • Front & Back-office Edit Screens

    In b2evolution, you can always edit a Post/Item in the Back Office. This is the most complete/full-featured edit screen:

    Front &amp; Back-office Edit Screens

    But, in some cases, if collection allows "In-skin editing", for example in the case of Forums, it is also possible to access a more limited version of the edit screen directly in the Front Office: Inskin Edit Screen

    Front &amp; Back-office Edit Screens
  • Why do I need Server Side Analytics (SSA)?

    All analytics packages attempt to show you how your Site Visitors and Site Users actually use your site. Where they come from, what they look at, how long they stay, what they’re searching for, etc. Some will be better suited than others for analyzing some particular areas of interest, user behaviors, etc.

    Why not just use Google Analytics?

    Google Analytics (set up instructions) will give you great information that b2evolution may not be able to give you.

    However, b2evolution’s built-in Server Side Analytics can also give you great information that Google cannot give you; for example: activity from robots, crawlers/spiders, RSS readers, API calls, AJAX queries and service requests. Google Analytics also won’t let you see or identify spammers.

    Both systems have an area of overlap and each has it’s own set of extra features unique to them.

    Why did b2evolution develop its own Analytics solution?

    b2evolution’s built in tracking system was developed at first to fight off comment spam and automated account creation spam. This required to track all incoming requests in order to analyze them (mostly in real time) to detect abuse.

    Once this data was collected, it was pretty easy to add a presentation layer allowing the Site Admin to explore this data.

    From there on we added graphs and additional bells & whistles with each new version…

    What is special about b2evolution’s Server Side Analytics (SSA) ?

    • Track everything ! Google Analytics can only track Page Views from Visitors using a Web Browser with Java Script enabled. b2evolution will track all Page Views:
      • Even if Javascript is turned off
      • RSS and Atom feed requests
      • robot, crawler and spider activity
      • spammer activity
      • API calls
      • AJAX requests
      • Incomplete pageloads (even if the user aborts loading the page, the view is counted)
    • Identify and block spammer activity. Spammers never load the Javascript Analytics packages and stay under the radar. With Servier Side Analytics you can see what they do, identify them and block them.
    • Drill down to the AJAX request level! b2evolution’s SSA will let you drill down to the level where you can see each page a user looked at, chronologically, including each AJAX request he made by hovering over elements on a page. This level of detail is typically not available on External Analytics packages.
    • Network speed: b2evolution doesn’t require an extra javascript to be loaded and executed. It saves network and client processing time (at the expense of server processing time – but the server side was needed for spam fighting anyways).
    • Serving device specific content: the embedded system allows b2evolution to serve a different skin to web browsers, tablets and smartphones for example.
    • Under development: b2evolution will be able to perform highly efficient A/B testing and (combined with Goal tracking) will be able to automatically select the best presentation for specific user segments.
  • Collection Skin Settings

    This sub-tabs shows the skins that will be used by b2evolution to display your collection on a desktop browser / a mobile phone / a tablet device.

    These are the skins that b2evolution will use by default, that is: unless a different skin has been requested by the user or configured in a stub file.

    This screen will also let you change settings specific to these skins.

    Standard Skin

    This sub-tab displays the current skin in use when displaying content on a standard desktop browser. This also displays contains settings to customize the skin to your liking.

    Collection Skin Settings

    A few common settings:

    • Layout Settings: this panel contains options that control the general layout and display of the skin.
    • Colorbox Image Zoom: this panel contains options for enabling the use of the colorbox script for Javascript zooming, allow voting on images used in the post, comments, or user images. You can also opt to display these votes in this panel.
    • Username Options: this panel contains options to allow use of colored usernames to differentiate male from female users, enable bubble tips on usernames, and use autocomplete of usernames.
    • When access is denied or requires login…: this panel contains options to display specific containers on the login screen.

    Some skins will have additional settings that you can change.

    If you click the Choose a different skin button, you will be taken to a gallery of built-in skins that you can use to pick a different skin.

    There is also a Reset params button which will reset the skin parameters to the default settings. This button can be helpful if you made some changes, didn’t like what you saw and want to revert to the factory settings.

    Phone and Tablet Skins

    Collection Skin Settings
    Phone skin using the same standard skin

    The phone and tablet skins used by default are the same as the standard skin. If you want to use a different skin for users who visit your site with a mobile phone and/or a tablet, go to the appropriate sub-tab and click on the Choose a different skin button and you will be taken to a gallery of mobile phone or tablet skins that you can use.

  • Manage Skins

    This screen lists and lets you manage all installed skins in your site. It can be accessed via the collection settings and also through the System menu.

    Full story »

  • Collection Type Panel

    Collection Type Panel

    This is the type of your collection.

    Full story »

  • Widget List

    Widget List

    Widgets are basically anything that allows you to perform a specific function or access a specific service. Widgets can be an application, a web component, a little block of text or anything that can be displayed in certain areas (containers) in your blog. A more detailed information about widgets can be found in the Widgets page.

    Full story »

  • Slugs List

    Slugs List

    This page allows you to manage all the Item Slugs of the site.

    The slugs list contains the following columns:

    1. Slug. The name of each slug. Important: if you have any doubt about the meaning or how to compose these names, we encourage you to read Slugs.
    2. Type. Type of element that the slug are referred to. b2evolution is able to manage slugs for two different types of elements: Items and help articles.
    3. Target. This is a composed cell that shows information about where the slug is pointing out. This is comprised of:
      • Object ID. It is an unique code generated by b2evolution at the moment of creating the item.
      • Permanent link to full entry (Permalink).
      • Edit this item… button that redirects you to the edition view of the item itself.
      • Item title. Clicking on the title redirects to the back-office view of the item.
    4. Actions. Let you to edit or delete the slug by clicking on the corresponding icon.

    Creating a new slug

    You can create a new slug from scratch by clicking on the +New slug button found in the Slugs panel header.

  • Poll the antispam blacklist

    This task will poll the central antispam blacklist and refresh your local DB with the latest spam strings from the central base.

  • Email Campaigns List

    This screen shows the list of all Email Campaigns and lets you create new ones.

    Email Campaigns List

    Each campaign is shown with open & click stats.

    Each campaign is tied to a specific List. However it is possible to change the the list of a campaign after it has already been sent. This allows to send the same campaign to another list, without sending duplicates to users who might be subscribed to both lists.

    It is possible to mark a message as a "Welcome" message for its List. In that case, new subscribers to the List will automatically receive this Campaign email.

    Furthermore, if a Campaign is a Welcome email it may also be marked as an Activation email. This is useful if users are auto-subscribed to a list on sign up. In that case, they would receive the Welcome email in addition to the default "Activate your account" email. BY marking a Welcome email as an activation email, you prevent this double-send. Only the Welcome email will be sent and the default activation email will no longer be send. Of course, this only makes sense if your Welcome/Activation email includes and [activate:] button.

  • Organization Tab

    Adding a new organization

    In order to add a new organization you should click on the link: "Add organization", type the name and URL of the organization, click on the button below as requested:

    1. Record: creates the record for the new organization and redirects to the results table.
    2. Record, then Create New: creates the record for the new organization and goes back to the same empty form.
    3. Record, then Create Similar: creates the record for the new organization and goes back to the same form filled up with the data just added.

    Editing an organization and reviewing its members

    Organization Tab
    Editing an organization and reviewing its members

    Going to the edit form of the organization, either by clicking on its name or on the "Edit" icon at the results table, you could perform two main actions: 1) edit the organization information itself and 2) review the list of users that either has been postulated by theirself to be members of the organization or has been added directly by an authorized user ( an administrator ). From this list you could accept new users to be members of the organization, in order to do this you should notice the content of the "Accepted" column for each user. Those users that has a red bullet are still on status "Pending to be accepted" and those with a green check sign are now accepted members of the organization and its name is visible on the user’s profile. This status could be toggled by clicking on the described icons.

    Adding users to an organization

    Organization Tab
    Adding users to an organization

    The action of adding users to an organization must be performed from the user profile form of each particular user. To do that, you should select the wished organization at the dropdown select menu that appears in the section "Identity". From the same view you could associate the user with several organizations in one step by clicking on the green plus sign. Doing this will create a new dropdown select menu each time until the number of available organizations be reached. Do not forget to click on the "Save changes !" button below.

    A regular user could associate himself with one or several organizations by following the process described above from his profile edition form, his associations will be marked as "Pending to be accepted" for default, and will have to wait until an administrator performs the accepting action. If the user that is performing the association from the another user profile form ( or from his own ) is an administrator, then the associations will be marked as "Accepted" by default, and the user will be member of the organization in just one step. The red bubble and check sign icons will work exactly as described above.

    In order to fully delete the association between an user and any organization, you just have to select the option "None" at the corresponding dropdown select menu and click on "Save changes !".

    At the moment that an user is accepted in at least one organization, the information of all those where he has been accepted will be shown on his public user profile as followed:

    Organization Tab
    Organizations list at the user profile
  • Receiving emails Panel

    In this section you can set your basic email preferences.

    Receiving emails Panel

    In order to come to this screen, put the mouse over your username (or full name) on the evoBar and click the option Notifications….

    Email address: Your email address in the site. If the Reactivate after email change parameter is checked (see Account Activation Settings), any changed email address must be re-activated. In those cases, the site will send an activation link by email to the new address in order to confirm the ownership before to fully accept it. Note: the envelope icon at the right of the field will lead you to your email client in order to send a message to this address.

    Email format: Specifies the format of the emails that the site will send you. There are three options:

    1. Automatic (HTML + Plain text): A mix between both formats. This kind of messages will adapt to your email client, if it accepts HTML code, then the message will be shown that way, if not, it will fallback to plain text.
    2. HTML: All the messages you will receive from the site are formatted using HTML code.
    3. Plain text: All the messages you will receive from the site are formatted as plain text.
  • Multiple authors

    Multiple authors

    When your blog is meant to be managed by several users with different kind of permissions, this parameters could be useful:

    1. Use advanced perms: checking this you will enable two additional tabs to control specific permissions over posts, comments and media files on this blog/collection. Those permissions could be granted per user or groups of users. Default value: disabled. More information about Advanced permissions could be found in this page: User Permissions and its links.
    2. Use workflow: now moved to Workflow Features Panel.
  • Browsing posts pages (disp=posts)

    Browsing posts pages (disp=posts)

    The following parameters could be set for the main page or post list of your site:

    1. First posts page: Adds a <meta name="robots" content="NOINDEX, NOFOLLOW"> tag to the headline of the main page. The NOINDEX parameter aims to prevent search engines robots to index the page that contains it, and the NOFOLLOW aims to prevent those robots to follow any of the links contained in the page.
    2. Next posts pages:
      • META NOINDEX - Page 2,3,4… It does exactly the same that point number 1 in this list, but starting from the second page of the list of posts.
      • NOFOLLOW on links to Page 2,3,4… Adds a rel="NOFOLLOW" parameter to the <a> tags used to go to the next pages at the posts list.
    3. Make canonical:
      • 301 redirect to canonical URL when possible
      • Use self-referencing rel="canonical" tag
      • Use rel="canonical" if not 301 redirected
    4. Post titles: defines the behavior of the posts’ titles at the list. The possible options are:
      • Link to the permanent url of the post
      • Link to the Link to URL parameter specified in the post (if any)
      • Link to the Link to URL if specified, otherwise fall back to permanent url
      • No links on titles
    5. Post contents: defines what content will be shown after the title of the posts. You could decide one of these options:
      • Post excerpts
      • Standard post contents (stopping at [teaserbreak])
      • Full post contents (including after [teaserbreak])
    6. Permalinks: to define where the permalinks in the post list should link.
      • Link to single post. Go to the content of the post.
      • Link to post in archive. Go to the list of items published in the same time frame. This time frame is set as post made in the same Month and Year.
      • Link to post in sub-category. Go to the list of all the posts that belong to the same category of the current. It is the same as to browsing or searching by categories.
  • Tracking Panel

    Tracking Panel

    Enabling Tracking of unread content allow 2 things:

    • users will be able to distinguish what they have already read from what they haven’t (useful in Forums for example)
    • widgets like the Seen By Widget will be able to display who has read the new/changed items (useful in Intranet for
      example)
    • widgets like the Must Read Items menu link widget will be able to display which posts the current User still needs to read.
  • Collection base URL

    The Collection base URL panel lets you configure what the root URL of your collection will look like.

    This requires Collection Admin permission.

    Collection base URL

    SSL

    You can select the protocol to be used by the collection.

    Collection URL name:

    This is a short name used to uniquely identify this collection. It can be used in the URL schemes below. It is also used as default for the media directory location.

    Collection base URL:

    In most situations, you will end up wanting your root URL to be very short and look something like http://example.com/ or http://example.com/urlname with no unnecessary characters added.

    You can typically achieve this by selecting either "Extra path on baseurl", "Subdomain of basehost" or "Absolute url" here.

    When possible, it is a good idea to only use URLs relative to the Base URL ($baseurl) from your _basic_config.php file. This allows to easily restore a backup on another domain (for testing or for development). It will work immediately provided the configuration file is properly set up on each server/each domain.

    IMPORTANT: your .htaccess File must be properly set up for this to fully work. See also the Important section below.

    The reason there are many options available here instead of just, say "Absolute URL", is for portability of your site. By using the other options, you will be using URLs relative to your Base URL ($baseurl) which will make it very easy to move your site to another domain, including to a development machine for local testing of changes.

    URL preview:

    This is a preview of what your base URL will look like. Use it to check your configuration.

    Important!

    Remember your .htaccess File must be properly set up for these settings to fully work.

    Most web browsers cache redirections very aggressively which sometimes makes it hard to verify that a new URL works. Try to clear your browser caches, relaunch it or use a different browser to check when anything related to URLs doesn’t work as expected.

  • Search Results Panel

    Search Results Panel

    This panel allows you to configure how results are displayed per page on disp = search. You can adjust the following settings:

    • Number of results per search results page
    • Search results sort order
    • What types of contents to include in search results (Posts / Comments / Files / Categories / Tags)
    • Scoring for each type of content
  • List Collections (REST)

    GET <baseurl>/api/v1/collections

    Parameters

    Possible request params

    Name

    Type

    Description

    Default

    page

    integer

    Page number

    1

    per_page

    integer

    Number of results per page (0 for all results)

    10

    q

    string

    Search string by collection fields, see a param `fields` below.

    fields

    string

    What collection fields use to search by param `q`.
    Possible values: `id`, `shortname`.

    shortname

    list_in_frontoffice

    string

    Filter collections by possible values:
    - `all` - Load all collections Needs CHECK:that can be seen by currently logged in User/CHECK
    - `public` - Load only collections depending on their Show in Front-office list setting.

    public

    restrict_to_available_fileroots

    integer

    Possible values: `1` - Load ONLY the collections with available file roots to view by the current user

    Response

    Response is an array of the following properties:

    Name

    Type

    Description

    found

    integer

    Number of found collections

    page

    integer

    Current page

    page_size

    integer

    Number of collections per page

    pages_total

    integer

    Number of total pages

    colls

    array

    Array of collections list, see the properties in the table below

    Name

    Type

    Description

    id

    integer

    Collection ID

    urlname

    string

    Short string to be used in URLs

    kind

    string

    main / std / photo / group / forum / manual

    shortname

    string

    Short string to be used menus

    name

    string

    Full name of the collection

    tagline

    string

    Tagline

    desc

    string

    Long Description

  • Automations List

    Automations List

    Shows the list of all automations.

    Each automation can be tied to several Email Lists.

    • "AS" means "Auto Start": users who join the list will auto start in this automation.
    • "AE" means "Auto Exit": users who leave the list will auto exit from the automation.
  • Changing the Collection Type

    Changing the Collection Type

    This allows you to change the type of a collection.

    Do this for example if you started with a photo album but want to transform it into a blog. Or if you started with a blog and realize it would be better presented as a hierarchic manual.

    Full story »

  • Email Plugins Settings

    Email Plugins Settings

    This allows admins to define which renderer plugins will be applied to Email Campaigns.

    See: Plugin / Apply Rendering

  • Cookie Settings

    Cookie Settings

    These settings let you control the cookie domain and cookie path of the cookies that b2evolution will set (especially the Session Cookie) when a user browses this collection.

    You should normally not change this, except if you are using multiple domains or complex paths and you want users to be able to log in on a parent domain or parent path. But, again, the best way to do this is to configure b2evolution’s Baseurl as the highest level URL that is a parent to all the other ones. For example, if you want www.yoursite.com, blog1.yousite.com and blog2.yousite.com to share the same cookies (and sessions), you should probably ste your baseurl to http://yoursite.com/.

  • Assets URLs / CDN support

    Assets URLs / CDN support

    This allows you to use a Content Distribution Network.

    This is also useful in case you are using a Multi Domain Setup, so you can choose which domain to use for loading your /rsc/ assets, your /media/ files and additional assests used by /skins/.

  • B2 API

    The b2 API is one of the API supported by b2evolution.

    Supported methods as of b2evolution version 2.4:

    • b2.newPost : new post call allowing to specify a category
    • b2.getCategories
    • b2.getPostURL : retrieves the permalink of a given post

    This is the legacy API from b2. It was primarily meant to extend the Blogger API with missing features.

  • Browser Hits

    Browser Hits

    For each collection, you can get a graph of browser hits broken down by refered searches (from search engines), other referers, direct accesses/bookmarks, self refered (site navigation), special referers, referer spam and admin interface hits if you choose to log them.

    This page uses a common summarizing layout that displays a bar graph at the top and a table below. However, in this case, it includes only data taken from hits identified as made using a web browser (as opposed to an indexing robot/spider or an XML feed reader).

    The results are categorized according the following criteria:

    1. Refering searches: Hits coming from search engines such as Google, Yahoo, Microsoft Live, Ask or more.
    2. Referers: Hits coming from other sites linking to your blog.
    3. Direct accesses: Hits from people who typed in your URL or have it bookmarked.
    4. Self referred: Hits from people who are following an internal link on your site/blog.
    5. Ajax: any asynchronus request received via XMLHttpRequest. Consider that this number may not match with the Ajax value displayed in the Global Hits Summary, because hits made by Robots and/or Crawlers have been trimmed from this results.
    6. Special referers: Hits from webmails, caches, redirectors, etc.
    7. Referer spam: Hits coming from sites identified as spam in your blacklist.
    8. Admin: Hits within the Admin interface (also includes previews).
  • Custom Fields

    You will find an example of a post with custom fields when you install b2evolution with the demo content:

    Custom Fields

    Defining custom fields

    You can define custom fields in the Item Type Form.

    Custom fields can have different types: numbers (floating point numbers with double precision), text strings (varchars), URLs, text, etc.

    Note about numbers: Although you could store numbers as text strings, storing them in number fields will make a difference when you try to sort posts based on the numbers stored here (numbers will sort as 1, 2, 3, 9, 10, 11 whereas text strings would sort as 1, 10, 11, 2, 3, 9).

    You can define as many custom fields of each type as you want and give them a name each. Each custom field has a field index which can be generated from the field name. The field index is the trimmed lowercase value of the field name where the white spaces are converted to one single underline character. Field indexes must be unique in a collection ( this way field names are also unique ).

    Sample field names and corresponding field indexes:

    • ‘Color’ => color
    • ‘Name of custom field’ => name_of_custom_field
    • ‘Max speed (km/h)’ => max_speed_km_h

    Entering data into custom fields

    The fields defined here will appear in the Custom Fields section of the Item Edit Screen.

    Custom Fields

    Displaying the data entered in custom fields

    There are basically 3 ways to display custom fields: