Skip to main content

Getting Started Guide

Introduction

This guide walks you through installing and configuring Sociable on your Joomla website. Sociable transforms your site into a fully-featured social networking platform with user profiles, activity feeds, groups, messaging, and gamification features.

Prerequisites

Before installing Sociable, ensure you have:

  • Joomla 5.0 or later
  • PHP 8.1 or later
  • MySQL 8.0+ or MariaDB 10.4+
  • The latest CjLib package installed (download from shondalai.com)

Installation

  1. Download the Sociable package from shondalai.com
  2. Go to System → Install → Extensions in Joomla administrator
  3. Upload and install the package file
  4. The installer will deploy all components, plugins, and modules

For detailed Joomla extension installation instructions, see the official Joomla documentation.

Post-Installation Setup

Enable Required Plugins

After installation, ensure all essential plugins are enabled:

  1. Go to System → Manage → Plugins
  2. Search for "Sociable"
  3. Enable the following plugins:
    • System - Sociable (required for authentication overrides and AJAX handling)
    • User - Sociable (required for automatic profile creation)
    • Content - Sociable (optional, for activity stream integration)
    • Privacy - Sociable (optional, for GDPR compliance)
    • Authentication - Sociable (optional, for social login)

Access the Admin Dashboard

Navigate to Components → Sociable to access the administrator dashboard. The dashboard provides:

  • User statistics and growth metrics
  • Activity overview
  • Quick access to configuration
  • Recent activity monitoring

Configuration

Sociable provides comprehensive settings organized into logical sections. Access settings through Components → Sociable → Settings.

General Settings

SettingDescriptionDefault
Community NameName displayed across your social networkMy Social Network
DescriptionBrief description of your community-
Default TimezoneTimezone for date/time displayUTC
Date FormatHow dates are formattedY-m-d
Items Per PageNumber of items in paginated lists20

Profile Settings

SettingDescriptionDefault
Allow RegistrationAllow new users to registerYes
Require ApprovalNew registrations require admin approvalNo
Default VisibilityDefault profile visibility (public/friends/private)Public
Allow Custom HandleLet users set custom profile handlesYes
Minimum Handle LengthMinimum characters for handles3
Max Bio LengthMaximum characters for bio500

Activity Settings

SettingDescriptionDefault
Require Post ApprovalPosts require approval before publishingNo
Allow Media UploadsAllow media attachments on postsYes
Max Media Size (MB)Maximum upload size10
Max Media Per PostMaximum attachments per post10
Enable ReactionsAllow reactions on postsYes
Enable CommentsAllow comments on postsYes
Enable SharingAllow sharing postsYes

Group Settings

SettingDescriptionDefault
Allow Group CreationLet users create groupsYes
Require Group ApprovalNew groups require admin approvalNo
Default Max MembersDefault member limit per group1000

Event Settings

SettingDescriptionDefault
Enable EventsShow and allow access to event pagesYes
Allow Event CreationAllow users to create eventsYes
Enable RSVPAllow RSVP functionalityYes
Enable InvitesAllow event invitationsYes
Show Past EventsDisplay past events sectionsYes

Connection Settings

SettingDescriptionDefault
Enable FollowingAllow one-way follow relationshipsYes
Enable FriendshipsAllow bidirectional friend connectionsYes
Enable BlockingAllow users to block each otherYes
Require Friend ApprovalFriend requests need approvalYes

Messages Settings

SettingDescriptionDefault
Enable Messages PageEnable private messagingYes
Allow AttachmentsAllow file attachments in messagesYes
Max Attachment Size (MB)Maximum attachment size10
Max Message LengthMaximum characters per message5000
Enable Read ReceiptsShow message read statusYes
Enable Typing IndicatorsShow typing statusYes

Gamification Settings

SettingDescriptionDefault
Enable PointsAward points for activitiesYes
Enable BadgesAward achievement badgesYes
Badge TiersComma-separated tier namesBronze,Silver,Gold,Platinum,Diamond
Enable LeaderboardShow public leaderboardYes
Leaderboard SizeNumber of users shown100

Notification Settings

SettingDescriptionDefault
Enable EmailSend email notificationsYes
Enable PushSend push notificationsYes
Enable In-AppShow in-app notificationsYes
Digest FrequencyEmail digest frequencyWeekly

Moderation Settings

SettingDescriptionDefault
Enable ReportingAllow users to report contentYes
Auto-hide ThresholdAuto-hide after X reports5
Enable Spam FilterEnable spam detectionYes

Authentication Settings

SettingDescriptionDefault
Override Joomla LoginRedirect Joomla login to SociableYes
Override Joomla RegistrationRedirect registration to SociableYes
Login Redirect URLPost-login redirect destination/
Registration Redirect URLPost-registration redirect/welcome

Social Login (OAuth)

Configure social login providers:

Google OAuth:

  • Enable Google Login
  • Google Client ID
  • Google Client Secret

Facebook OAuth:

  • Enable Facebook Login
  • Facebook App ID
  • Facebook Client Secret

Apple OAuth:

  • Enable Apple Login
  • Apple Client ID
  • Apple Team ID
  • Apple Key ID
  • Apple Client Secret

Storage Settings

SettingDescriptionDefault
Storage TypeLocal filesystem or S3Local
Local PathPath for local uploadsmedia/com_sociable/uploads
S3 BucketAmazon S3 bucket name-
S3 RegionAWS regionus-east-1

Create menu items to provide access to Sociable pages:

  1. Go to Menus → [Your Menu] → Add New Menu Item
  2. Select Sociable from the menu item type list
  3. Available menu item types:
    • Feed - Main activity feed page
    • Profile - User profile page
    • Groups - Groups listing
    • Events - Events listing
    • Messages - Private messaging
    • Notifications - Notification center
    • Search - User search
    • Settings - User settings

Tip: Create a dedicated hidden menu for Sociable SEF URLs, then create a menu alias to one item in your main navigation.

Initial User Sync

When Sociable is installed for the first time, existing Joomla users need to be synced:

  1. Go to Components → Sociable → Users
  2. Click the Sync Users button in the toolbar
  3. Wait for the sync process to complete

The User - Sociable plugin automatically creates profiles for new users after the initial sync.

Theme Customization

Customize the appearance of your social network:

  1. Go to Components → Sociable → Theme Settings
  2. Select a color theme
  3. Choose display mode (light/dark/system)
  4. Customize style options:
    • Navigation position (left sidebar or top toolbar)
    • Card styles (corners, shadows, borders)
    • Avatar shape (circle, rounded, square)
    • Button styles
    • Content spacing
    • Action bar appearance

Changes are applied immediately across all Sociable pages.

Email Templates

Customize notification emails:

  1. Go to Components → Sociable → Email Templates
  2. Browse templates by category:
    • Engagement (likes, comments, shares)
    • Connections (follows, friend requests)
    • Groups (invites, approvals)
    • Gamification (badges, points)
    • System (welcome, verification)
  3. Click a template to edit
  4. Customize the subject and body
  5. Use placeholders for dynamic content

Next Steps

After completing basic setup: