Profile2-Settings

Owned by Former user (Deleted)
Last updated: May 05, 2014
5 min read

Settings

Profile2 uses the following sakai.properties:

# Upload limit for profile pictures, in MB
profile2.picture.max=2

# Convert images from old profile to new?
profile2.convert=false

# Allow users to post status updates to Twitter? (true/false, default true)
profile2.integration.twitter.enabled=true

# Allow users to change their profile picture? (true/false, default true)
profile2.picture.change.enabled=true

# Can users upload an image or just link to an existing one? (upload/url, default upload)
# As of 1.4 this also supports the 'official' value, see the section below.
profile2.picture.type=upload

################################
## Available as of version 1.2:
################################

# Allow users to change their privacy settings? (true/false, default true)
profile2.privacy.change.enabled=true

# Override the default privacy settings with these options (0=everyone, 1=only connections, 2=only me)
# This will set the defaults for a person with no existing privacy record
# or when the privacy settings are locked (change.enabled=false)
# Key: 0=everyone, 1=only connections, 2=only me, 3=nobody
# If not specified, all properties below default to the values below
# Also note not all properties have the full range (0,1,2,3). Each is documented underneath the property itself.

profile2.privacy.default.profileImage=0
# 0,1 only
profile2.privacy.default.basicInfo=0
# 0,1,2
profile2.privacy.default.contactInfo=0
# 0,1,2
profile2.privacy.default.personalInfo=0
# 0,1,2
profile2.privacy.default.birthYear=true
# true/false
profile2.privacy.default.search=0
# 0,1 only
profile2.privacy.default.myFriends=0
# 0,1,2
profile2.privacy.default.myStatus=0
# 0,1 only

################################
## Available as of version 1.3:
################################

# List of userIds (not eids) that will never show in searches or friends lists (comma separated no spaces, default=postmaster)
profile2.invisible.users = postmaster

# Set this to tell the ProfileManager to get it's data from Profile2.
# If left unset, any tools that use the ProfileManager from the original profile tool (ie Roster)
# will continue to use the data from org.sakaiproject.api.app.profile.LegacyProfileManager.
# So you must set this to enable the integrations.
# If you are using a version of Sakai prior to 2.7, you need to apply the patch attached to
# http://jira.sakaiproject.org/browse/SAK-17573 in order for this property to have any effect
# NO LONGER SUPPORTED IN v10+
profile.manager.integration.bean=org.sakaiproject.profile2.legacy.ProfileManager


# Additional privacy defaults. These replace the old profile2.privacy.default.academicInfo setting
profile2.privacy.default.staffInfo=0
# 0,1,2
profile2.privacy.default.studentInfo=0
# 0,1,2

##########################################
## Available as of version 1.3.9 onwards:
##########################################

# Optional parameters if you have registered a Twitter application and want to use that as the registered application instead of Profile2.
# See the section on registering a Twitter application, as this is rather involved.
profile2.twitter.oauth.key=
profile2.twitter.oauth.secret=

# Profile2 provides a formatted entity via EntityBroker at /direct/profile/{userid}/formatted.
# However large amounts of data, particularly in the personal summary section of a user's profile, can make this view rather large.
# This property can restrict how much is shown, defaults to 1000 characters.
profile2.formatted.profile.summary.max=1000

###########################################
## Available as of version 1.3.10 onwards:
###########################################

# Sets the ability for a user to change their profile image on a per user type basis.
# If not set, defaults to the value of profile2.picture.change.enabled which defaults to true.
profile2.picture.change.USER_TYPE.enabled=true (true/false, defaults to profile2.picture.change.enabled setting)

################################
## Available as of version 1.4:
################################

profile2.privacy.default.businessInfo=0
# 0,1 only
profile2.privacy.default.myPictures=0
# 0,1 only
profile2.privacy.default.messages=1
# 1,3 only
profile2.privacy.default.myKudos=0
# 0,1 only
profile2.privacy.default.socialInfo=0
# 0,1,2
# Enable/disable the gallery feature? (true/false, default true)
profile2.gallery.enabled=true

# Enable/disable the business profile feature? (true/false, default false)
profile2.profile.business.enabled=false

### OFFICIAL IMAGE SUPPORT

# To enable support for using official images, set to true:
profile2.official.image.enabled=false (true/false, default false)

# If enabled, where should Profile2 look for the officially provided images?
# If 'url', you need to add a URL for each user to the PROFILE_IMAGES_OFFICIAL_T table in the database.
# If 'provider', you need your UserDirectoryProvider implementation to add a BASE64 encoded image to a property
# on the User object. This is already in place for the LDAP provider, just setup the jpegPhoto attribute.
# See http://jira.sakaiproject.org/browse/SAK-17816.
profile2.official.image.source=url (url/provider, default url)

# If enabled and you set the source to 'provider' above you also need to specify the attribute,
# if different to this value.
profile2.official.image.attribute=jpegPhoto (default jpegPhoto)

# Note that if you want to use *only* officially provided images you also should set
# profile2.picture.type=official
# If you want to allow a user to choose either the official image or an uploaded/url one of their choice,
# do not set type=official and rather set profile2.picture.type=url/upload. They will then be able to choose
# to use either the official image, or one they select.
# Remember, you can always disable changes altogether via profile2.picture.change.enabled=false

### SEARCH OPTIONS

# The maximum number of search results that should be returned per search (default=50)
profile2.search.maxSearchResults=50

# The maximum number of search results per page (default=25)
profile2.search.maxSearchResultsPerPage=25

### IMPORT PROFILES FROM A CSV FILE
# You can now import profile data from a CSV file. The CSV file must be located on the Sakai server.
# For the format of the CSV file, see
# https://jira.sakaiproject.org/browse/PRFL-684?focusedCommentId=140799&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-140799
profile2.import=false (set to true to enable and also set the profile2.import.csv field)
profile2.import.csv=/path/to/file/import.csv

### DISABLING CERTAIN SECTIONS

# Show any of the profile fields? (true/false, default true)
# Useful if you want people to have profiles but not have any information
# Users will then only have a name and image
# Use in combination with the privacy defaults/locking to set this as desired otherwise it will show redundant options.
profile2.profile.fields.enabled=true

# Allow status updates and display? (true/false, default true)
profile2.profile.status.enabled=false

#######################
## Updated properties:
#######################

# As of 1.4, the following properties are no longer supported:
profile2.privacy.default.search (removed, see http://jira.sakaiproject.org/browse/PRFL-293)
profile2.integration.twitter.source (removed, see http://jira.sakaiproject.org/browse/PRFL-94)
profile2.privacy.default.academicInfo (replaced with studentInfo and staffInfo for more granular settings)

################################
## Available as of version 1.5:
################################

# GRAVATAR SUPPORT

# Allow users to set gravatars as their images
profile2.gravatar.image.enabled=true (true/false, default true)

# WALL PAGE

# Enable/disable the Profile2 wall page globally
profile2.wall.enabled=true (true/false, default true)
# Use the wall page as the default Profile2 page
profile2.wall.default=false (true/false, default false)

# ADDITIONAL PRIVACY DEFAULTS


# Default wall privacy option
profile2.privacy.default.myWall=0
# 0,1 only# Default online status privacy option
profile2.privacy.default.onlineStatus=0
# 0,1 only

# FORUMS INTEGRATION

# Should users profiles be linked in forum posts?
profile2.profile.link.enabled=true (true/false, default true)

# USER TYPE IMAGE
# Set the image for the user based on their user type (true/false, default false)
# If enabled, you also need to set the full URL to images for each user type.
# If a user type has no associated image it will fall back to whatever other image is set, either via upload/url/official/gravatar, or the default.
# To restrict a user from changing the image, combine with profile2.picture.change.enabled=true
profile2.user.type.image.enabled=false
profile.user.type.image.guest=http://url.to/some/image.jpg
profile.user.type.image.registered=http://url.to/some/otherimage.png


# EMAIL NOTIFICATION ON PROFILE CHANGE
# You can configure an email to be sent to a specific user whenever anyone updates their profile. (true/false, default false)
# This defaults off and must be explicitly configured. The user gets a notification only, no actual profile content is sent.
# They still need to login to view the info and the same permissions are applied.
# Therefore it is recommended the eid property be set to a super user.
profile2.profile.change.email.enabled=false
profile2.profile.change.email.eid=admin
 
################################
## Available as of version 11:
################################
 
# Enable/disable the staff profile feature? (true/false, default true)
profile2.profile.staff.enabled=true

# Enable/disable the student profile feature? (true/false, default true)
profile2.profile.student.enabled=true

# Enable/disable the social profile feature? (true/false, default true)
profile2.profile.social.enabled=true

# Enable/disable the interests profile feature? (true/false, default true)
profile2.profile.interests.enabled=true
 
# Official images can now be stored on a filesystem. Use this setting in combination with profile2.official.image.directory and optionally choose a pattern
profile2.official.image.source=filesystem

# Base directory for the official photos on the filesystem (default = /official-photos)
profile2.official.image.directory=/official-photos
 
# Choose a pattern for the layout of images in this directory
# Options:
# ONE_DEEP which is of the form: BASEDIR/j/jsmith26.jpg
# TWO_DEEP which is of the form: BASEDIR/j/s/jsmith26.jpg (default)
# ALL_IN_ONE which is if you have all images in the same directory, ie: BASEDIR/jsmith26.jpg, BASEDIR/fsmith31.jpg
profile2.official.image.directory.pattern = TWO_DEEP

### IMPORTANT NOTE ###
# As of 1.6, to view official images from within a site, you must have the roster.viewofficialphoto permission set.
 
# Enable/disable the messaging feature? (true/false, default true)
profile2.messaging.enabled=true
 
# Convert images from URL to local storage (added in PRFL-740)
profile2.import.images=true
 
# Specify the access level role to be used when creating worksites. Defaults to ROLE_ACCESS.
profile2.worksite.access.role=access
 
# If using official images via a URL, the default behaviour is to redirect to that image.
# You can optionally tell Profile2 to fetch the data on your behalf and render it the same as an uploaded image rather than performing a redirect
# This will mean the URL is not exposed to students, which may or may not be a privacy issue for you.
# Note that enabling this may reduce performance. (true/false, default false)
profile2.official.image.url.secure=false