Frequently Asked Questions

Is it recommended to install this modification on a live board?

Although the MODX file states that ‘This MOD is development quality. It is not recommended that you install it on a live forum.’, installing the modification shouldn’t cause any trouble in fact. However, the modification is still tagged as beta, so bear with me if there is a bug or two.

Where am I supposed to report bugs or suggest new features?

Please report them either to the topic at phpbb.com or create an issue at github.com. Nevertheless do not only post the plain error message, but also describe exactly what you were doing when the error occurred. This will help me reproduce and eventually fix it.

What are referral keys?

Each invitation – in case you haven’t adjusted the permissions yet – is attached such a key, which is a randomly generated string consisting of alphabetic and numeric characters. The referral key generally inheres in two tasks: It associates new users with the referring one – basically specifying their referrer automatically – and distinguishes invited users from generic ones providing the opportunity to give special advantage to the invited users. You can even restrict the registration to invited users making your board a private one.

What is a successful invitations?

The criteria for a successful invitation can be defined at the Administration Control Panel. By default, invitations are considered to be successful once the invited friend registers.

Where can I find the modification’s settings?

The settings module can be found at the Administration Control Panel by accessing the .mods tab.

I cannot find the new modules.

Please make sure you didn’t miss them accidentally or forgot to run the installer located at ./install/install_invite.php during the installation. You may want to check whether the new permissions are set by accessing the permissions tab at the Administration Control Panel as well.

An error occurred while sending the invitation.

Please check the board´s error log at the Administration Control Panel by accessing the maintenance tab. If you are not able to draw any conclusion from the error message, feel free to post it to the topic at phpbb.com or contact your host.

I’ve submitted the form and the invitation has been sent successfully. However, the recipient doesn’t receive any e-mail. What’s wrong?

Please update to the latest version. This problem only exists when using older releases and has been fixed a while ago. As the modification is using phpBB’s messenger class an error must have occurred – it just wasn’t displayed.

‘You must not use registration keys you sent to yourself.’ What does this mean?

Please update to the latest version as the localisation has been updated. This wasn’t a bug actually but you couldn’t really tell what was wrong due to the awful translation. The message itself is triggered by the setting which prevents abuse.
For the curious ones out there: Inviting yourself in order to test the modification wouldn’t work unless you disabled the setting at the Administration Control Panel. Unfortunately, it was enabled by default.
In order to prevent abuse, especially when using reward systems, the IP address of the future user were compared – so they are now – to the referring user. If both addresses were identical, this error is displayed as someone was trying to take the mickey out of us – that’s what the message states today.