Help & Support

Your Cbox embed code is available at your control panel. You need this code to install your Cbox on your website.

Also on that page is your Quick Link — a URL which you can use to access your Cbox directly in your browser or on your mobile device.

Once you have created your Cbox account, go to the Publish page of your control panel. The code and steps for embedding your Cbox are provided there for a number of common platforms.

If you install your Cbox and all you see is code, or nothing at all, your web host may be removing or otherwise interfering with the HTML iframe tags that Cbox uses. Your Cbox code needs to be pasted into an area of your site that accepts HTML without modification. This may mean switching your editor from "rich text" or "WYSIWYG" mode into HTML-editing or "raw" mode, or you may need to open your template files in a plain-text editor like Notepad.

Remember that you always have the option of posting or sharing your Cbox Quick Link — this gives visitors direct access to your Cbox in a full-screen layout, so it's perfect as a mobile option or for stand-alone use.

Go to the Theme editor in your control panel. There you can specify the fonts and colours of your Cbox, using a point-and-click editor. You can always reset your theme to one of the preset defaults there, if you would like to start again.

If you have a Premium or Pro Cbox you can edit CSS, which gives you complete control over presentation.

If you have a Premium or Pro Cbox, you can create a moderator name for yourself at your Users page, and then log in on your Cbox using the "profile" link. You will see a delete icon [x] next to each message in your Cbox, and you will not have to log in at your control panel at all to delete messages.

Alternatively, visit your Messages page to delete messages individually or in bulk. Deleted messages are removed from your public Cbox history, but are preserved in your Archives.

Yes. In the Theme editor, simply delete the colour codes for the main and form background ("BG") elements. This will make the Cbox transparent, allowing whatever is behind the Cbox to show through.

Note that any pop-ups generated by a transparent Cbox will have the default background colour — usually white. If your font colour is light, it may be invisible in popups. You can fix this by editing the CSS to introduce a background-color rule for popups.

At its simplest, the Custom filter is a list of words that you want hidden or replaced in your Cbox. Enter words, one per line, and if a user's name or message contains that word, it will be filtered out.

badword
badderword:betterword

When a message is applied to the above filter, "badword" will be turned into asterisks, and "badderword" will be replaced by "betterword". The ":" (colon) character separates the pattern text from the replacement text. If the colon is left out, the entire line is the word to match.

Filters can be useful for more interesting things too, however.

Styling and aliasing names

You can set colours for admins, mods and registered users on your Themes page, but you can create individualized filters for particular names or words you want to highlight.

jacob:[color=green]TheRealJacob[/color]

This user would still enter "jacob" as his name in your Cbox, but whenever he posts, or whenever someone mentions him in a message, the output will be TheRealJacob, in green.

If you want to apply style besides colour to names, you can use the [class] boxcode.

jacob:[class=vip]{$0}[/vip]

You will then need to define your custom CSS for this class.

Using and disabling boxcode

Boxcode itself can be customised, making the combination of filtering and formatting very powerful. See more.

Your custom filtering rules support boxcode, as seen in the example above, even if you have boxcode disabled for messages in your Settings. You can also match the boxcode that people use (or attempt to use) in their messages.

![br]:/
haiku:The moment two bubbles[br]are united, they both vanish.[br]A lotus blooms.

The first rule will match "[br]" appearing in messages, and replace it with a slash. But the [br]s that appear in the second rule will still work, creating line breaks, because each replacement string is boxcode-filtered independently.

If boxcode is enabled for messages, then you can create aliases and compound boxcode using partial (open) tags:

![red]:[color=#f00][b]
![/red]:[/b][/color]

When a user enters [red]this is red[/red], the filter translates this to [color=#f00][b]this is red[/b][/color], which is now valid boxcode, and will in turn become HTML.

Tip: If a rule isn't matching when it should, try putting ! at the start of the line. If a rule is matching when it shouldn't, try putting ~ at the start of the line.

Filter modes

By default, filter rules are matched anywhere that the search text is not surrounded by other letters. Starting a line with the prefix "!" (exclamation mark) makes the rule a simple substring filter instead. Such rules are stronger in the sense that they will match in more contexts. However, unintended substitution is also more likely.

By contrast, a rule that begins with "~" (tilde) is only matched when preceded by space and followed by space or punctuation. This is similar to how emoticon substitution works. Such rules are looser in the sense that they are only matched in this specific form. Unintended substitution is less likely, but the rule may not be triggered as easily as desired.

fred:Fred
!color:colour
~plane:✈

In this example, the first rule will match the "fred" in "@fred" and "(fred)", but not in "freddy" or "alfred". The second rule will match "color" as well as "colorful" (substituting "colour" and "colourful" respectively). The third rule matches only "plane" by itself or followed by punctuation.

Filter order

Names and messages are filtered first by your custom rules. Messages are then parsed for smilies, boxcode, and links, in that order, if you have these features enabled. Names do not have these built-in filters applied.

Within your custom filter itself, the order of rule-matching is from top to bottom.

hi:hello
hello:goodbye

If a user posts "hi!", then as the message passes through the above rules it will be translated first to "hello!", and then, because it now matches the second rule, it becomes "goodbye!". In general, whenever a rule matches something that appears in another rule's replacement text, the order matters, and earlier rules can influence the effect of later ones. It's not recommended to depend on this behaviour, however. To create internal shortcuts, use variables.

Variables

A line beginning with a "$" (dollar sign) defines a variable that you can use in subsequent replacement text:

$pre:[big][color=#ff0000]
$suf:[/big][/color]
jane:{$pre}Jane{$suf}
john:{$pre}{$0}{$suf}

The first two lines do not match any name or message text; they define variables representing the strings following the colon. Variables are written in to the replacement string by surrounding them with braces. Variables in replacement text are expanded before filtering itself is applied to messages. The variable $0 is special: it contains the text that matched.

This can happen when you are using the same ISP as a user who was banned on your Cbox — either you are sharing an IP address, or you are being assigned dynamic IP addresses. To unban yourself, go to your Bans page and unban the most recent bans one by one until you are able to post again.

Cbox supports private messaging to and from mod and admin users. You can enable PM for your Cbox at your Settings page.

You can also type out the PM command: enter //pm username message..., where username is the name of the person you want to send your message to. This method works if the username conforms to Cbox "strict name" or "ASCII name" policy, i.e. comprises alphanumeric characters only and includes no spaces. Otherwise, you will have to refer to the user by ID.

By default, ordinary users cannot send PMs to other ordinary users. One of the two participants in any private conversation must be a mod or admin.

Opting in and out

Registered users can opt in to sending and receiving private messages from other registered (non-mod) users, by entering //pm on. The command //pm off revokes this availability.

Errors on sending

Private messages can fail to send for a number of reasons. If you get an error, it will likely either be due to the target user not being online (see below) or due to policy regarding who can send and receive private messages (see above). If the target user is not online, you may need to wait just a few seconds before retrying. Refer to the onliners list to confirm whether Cbox recognizes the user as present.

Message delivery

Private messages are sent via the streaming interfaces. The target user must be viewing and connected. Users on old browsers or restricted networks may not be able to receive PMs. When your message has been accepted by our servers for relaying, you will see an indicator (by default, a tick symbol). When the message has been received by the target user, the indicator will change (double-tick symbol). If that doesn't happen, your message probably wasn't received. Note that Cbox does not know that a message has been read, only that it has been delivered.

Persistence

Cbox does not store private messages for future delivery. New messages are relayed only if the user has an active connection. If the user has gone offline or is otherwise unable to receive your message, it will not be sent again, and nor will it be seen by that user when he reconnects. If you do not see the two-tick "received" indicator within a few seconds of sending a message, you will need to re-send your message later.

You need some development experience to make use of this feature, with the ability to edit your site's back-end code.

Cbox Pro supports Integration, which is a way to implement single sign-on. If users already log in or register with your site, Integration means they don't have to enter their name again on your Cbox.

Configure Integration at your control panel. Example code is available there. The rest of this article deals with general concerns.

How it works

Integration is implemented using query string parameters appended to the Cbox iframe URL. The final parameter is a signature generated from the rest of the URL. You don't need any external components or callbacks, just language support for HMAC-SHA256, base64-encoding, and url-encoding.

The signature is important to secure the generated URL against tampering by the user or any other intermediary. However, most back-end platforms have built-in support for the necessary functions.

Integrating avatars and profile links

The only required parameter is nme, for the user's name, and the signature, sig. But you can also pass lnk and pic parameters to Cbox, to take advantage of name links and avatars, respectively. These should be provided as absolute URLs. For example, https://yoursite.example.com/path/to/image.gif. Note that the respective display settings need to be enabled for name links or avatars to show up.

Integrating with mod/admin permissions

Integrated users' names will be registered with Cbox automatically, if they aren't already. This means you can confer mod/admin permissions at your Users page.

You can also use Integration with Moderated chat. With Moderated mode enabled, your Integrated users by default will not have voice permission. You will be able to review their messages as a mod or admin user in your Cbox and approve them accordingly.

Security

Note that if you have existing users registered before enabling Integration, they are authenticated by Integration regardless of their password. This means if you have an existing "admin" user registered with a password on your Cbox, and you then enable Integration, the corresponding user named "admin" on your site will get that name (and permission). This can be an advantage, but if it's a risk in your case, delete all registered users before enabling Integration.

The signature in the Integrated Cbox URL protects the name and other information in transit. However, if you are concerned about leaked URLs, you can limit URL validity by passing an additional (signed) query string parameter, valid_to, which should be set to a UNIX timestamp. The URL will stop working after the time specified.

You can also change the key used to generate the signature, by changing your security tag. This invalidates all your Cbox URLs, but requires that you change your published Cbox embed code accordingly.

Debugging

If you get an error in your Cbox saying that there's a problem with Integration, the most common cause is an invalid signature.

The first thing to do is right-click and inspect the Cbox iframe URL. You should have nme=...&sig=... parameters populated in the query string. If not, check that your embed code is in place and being parsed without errors.

If the sig parameter is present in the URL, confirm that it is being generated using the correct secret key. The key is available at your Integration page.

Ensure that you are url-encoding your query string parameters exactly once, and encoding before calculating the signature. The signature itself must then also be url-encoded, and appended to the URL. If you see the sequence %25XX in the URL, that's a sign that you might be applying url-encoding to already url-encoded strings.

If you are still getting errors, contact us including the code you are using and an example URL, and we should be able to assist.

You can downgrade from Pro to Premium at your control panel. Your Pro features will be disabled automatically.

If you let your Premium plan lapse, it will not automatically revert to a Free Cbox. Your messages and settings will be saved but your Cbox will be locked. You will be able to renew at any time reactivate it. To get back on the Free plan, simply sign up for a new Cbox, using a new Cbox name.

If our service is not meeting your expectations on any plan, please contact us and we will do what we can to improve your experience.