agscala / meteor-accounts-guest

Automatically add visitor as anonymous guest with userId for MeteorJS. This is the new home of meteor-accounts-guest

accounts-guest

============

Automatically add visitor as anonymous guest with userId.

Note: This is the new home of accounts-guest, which is compatible with meteor >= 1.6.1. For older versions see artwells:accounts-guest.

Features

• each non-logged in visitor gets a userId, accessible via Accounts and Meteor:userId()
• includes configurable cleanup function
• supports truly anonymous guests which do not require accounts-password

Installation

meteor add baursn:accounts-guest

Followed by

meteor add accounts-ui

or

meteor add ian:accounts-ui-bootstrap-3

or any other accounts-ui derivative.

optionally (to clean out old guest accounts) in server-only code

Accounts.removeOldGuests([time before]);

Now Meteor.userId() will be populated for each new visitor, including across reloads

Examples

/* clean out all guest accounts more than 24 hours old (default behavior) */
Accounts.removeOldGuests();

or

/* clean out all guest accounts more than 2 hours old */
var before = new Date();
before.setHours(before.getHours() - 2);
Accounts.removeOldGuests(before);

Options (Set in server code at start up)

• AccountsGuest.enabled, default true. Automatically logs in all visitors.
• AccountsGuest.forced, default true. Will force recently logged out accounts into guest mode.
• AccountsGuest.name, default false. If true, assign the guest a friendly nickname.
• AccountsGuest.anonymous, default false. If true, do not require acccounts-password and make guests anonymous (i.e. no auto-generated username and email).

Option Examples

In code available to server, to temporarily or conditionally disable guest login

AccountsGuest.enabled = false

In code available to client, to temporarily or conditionally disable guest login after user logout

AccountsGuest.enabled = true

In code available to server, to assign the guest a friendly nickname

AccountsGuest.name = true

In code available to server, to not require acccounts-password and make guests anonymous (i.e. no auto-generated username and email).:

AccountsGuest.anonymous = true

TODO

• tests for forced, and enabled options
• Allow guest session merged into new session if a visitor logs in
• Allow merged session/other variables to be specified in config