plainblack.com
Username Password
search
Bookmark and Share

Network Settings

The Settings screen allows you to set global site settings, such as workflows, language, and rich editor configuration. To access the Settings screen, click on the Settings icon in the Admin Console

 

Upon entering the Settings screen the default view is the Company tab. This tab lists your company's name, email address, and URL.

 

The Content Tab

 

 

  • Default Version Tag Workflow: this workflow determines the default workflow assigned to version tags created on the site.

  • Version tag mode: determines how version tags on the site behave. By default, users may override this setting in their user profiles.

    • Multiple version tags per user: each user can have multiple open version tags.

    • Single version tag per user: each user can only have one open version tag on the site. If a version tag exists, that version tag will be the tag worked under by default.

    • One site-wide version tag: all users work under one site-wide version tag.

    • Commit automatically: version tags are committed automatically upon content creation/revision.

    Note: The default version tag mode for WebGUI is commit automatically. This makes the content publishing process simpler for novice users. Best practice is to leave the site wide version tag mode at commit automatically, and allow users to set their own version tag modes through their user profile if they would like something different.
  • Trash Workflow: this workflow determines what happens when assets are placed in the Trash.

  • Purge Workflow: this workflow determines what happens when assets are purged.

  • Change URL Workflow: this workflow determines what happens when an asset's URL is changed.

  • Default Homepage: you can set the default homepage for your site to any existing page in your site. This is the page users will be directed to when they type in your site's URL, or when they click on the homepage link generated by an AssetProxy of a Navigation Asset.

  • Not Found Page: if a user requests a page this does not exist in your site, this is the page the user will be directed to. You can set this page to whatever you want, such as an error page or the homepage.

  • URL Extension: allows you to add an extension, such as “php,” “html,” or “asp” to the end of your site's URL. Do NOT include the “.” (dot).

  • Maximum Attachment Size: the size (in kilobytes) of the maximum attachment size allowed to be uploaded to your site. Due to the nature of HTTP Protocol, 100MB is the maximum size you can expect to upload via WebGUI's interface.

  • Max Image Size: if images are uploaded to your site that are larger than the maximum allowed size, the image will be resized to conform to this limit. The max image size is measured in pixels, and the longest side of an image is used to determine if an image meets this size criteria.

  • Thumbnail Size: if an image is uploaded to your site it will automatically have a thumbnail image generated at the size specified here (unless overridden on a case by case basis). Thumbnail sizes are measured in pixels.

  • Enable Metadata?: if set to Yes, metadata will be enabled and allowed to be assigned to assets and tracked by WebGUI.

 

UI Tab

 

 

  • Default Rich Editor: this is the Rich Editor configuration that will be used by default in assets that use a rich editor. This can be overridden in certain assets, such as a Collaboration System.

  • Text Box Size: this determines the number of characters that can be displayed in text boxes throughout the site.

  • User Function Style: determines which style to be used to style WebGUI operations (jprofiling, message log, etc) when they are available to a user.

  • Admin Console Template: the style used by the Admin Console.

  • Use reCAPTCHA?: reCAPTCHA is a free CAPTCHA service that helps digitize books. You need a key to use this, and there is a link for this in the field's hover help.

  • reCAPTCHA Public Key and reCAPTCHA Private Key: fields where you enter the reCAPTCHA keys you set up as part of using the reCAPTCHA service.

  • Global Head Tags: any tags entered in this field will be tags for every page (including admin pages) on the site.

  • User Mobile Style: If set to Yes, the site is enabled to be displayed using a mobile page layout template. When enabled, the alternate templates are used when the browser's user agent string matches the list set in the config file.

 

Messaging Tab

The Messaging tab is where you set up email service for your site.

 

  • SMTP Server: this is the address of your local mail server. It is needed for all features that use the Internet email system (e.g. the password recovery system). Optionally, if you are running a sendmail server on the same machine as WebGUI you can specify a path to your sendmail executable. On most Linux systems this can be found at “usr/lib/sendmail”.

  • Email Footer: this footer will be processed for macros and attached to every email sent from this instance of WebGUI.

  • Return Path: determines the email address to which undeliverable email messages will be sent.

  • SMS gateway: the email address this site uses to send an SMS message.

 

Miscellaneous Tab

 

 

  • Prevent Proxy Caching: some companies have proxy servers that cause problems with WebGUI. If you are experiencing problems, and you have a proxy server, you may want to set this field to Yes. Bear in mind that this will make WebGUI's URLs less user-friendly.

  • Debug IP: this will limit debugging and/or performance output to a specific IP address or IP range. Enter the subnet in which you want to be able to view debug output in CIDR format. Multiple CIDR addresses may be entered, separated by a comma.

  • Show debugging?: setting this to Yes will show debugging information in WebGUI's output. This is primarily used for WebGUI developers, but is also helpful to Administrators for troubleshooting.

  • Show performance indicators?: if set to Yes, this will show the time, in seconds, it took to build each item on the page. This is helpful for debugging peformance problems.

  • Host To Use: determines the default host to use when generating URLs. Config Sitename will use the “sitename” variable from your config file. Env HTTP Host will use the “HTTP_HOST” variable provided by the web server.

 

Account Tab

The fields in the Account tab correspond to WebGUI's User Account System. Each major category in this screen is a tab in the User Account System, as shown below.

 

Profile

 

 

  • Style Template: the template used to display the style that encloses the Profile.

  • Edit Layout Template: the template chosen displays the various account plugins that are useable by the current user as well as the contents of the plugin currently chosen.

  • Edit Template: the main template used for editing a profile.

  • View Template: the main template used for viewing a profile.

  • Error Template: the template used for displaying profile errors.

 

Inbox

 

 

  • Style Template: the style template that wraps the Inbox.

  • Edit Layout Template: the template chosen displays the various account plugins that are useable by the current user as well as the contents of the plugin currently chosen.

  • View Template: the main template used when viewing the Inbox.

  • View Message Template: the main template used when a user views a message.

  • Send Message Template: the main template used to compose a message.

  • Inbox Message Confirm Template: the template used to display the confirmation when a message is sent.

  • Inbox Error Message Template: the template used to display an error messages in the inbox.

  • Manage Invitations Template: the template used to display the screen in which invitations are managed.

  • View Invitation Template: the template used when viewing invitations.

  • Invitation Confirmation Message Template: the template used for viewing invitation confirmations.

  • Enable user invitations?: if set to Yes, site users will be able to send others invitations to come to this site and create an account. In order to do so, anonymous registration must be enabled on the site.

  • Restrict Invitation Subject?: if set to Yes, users will not be able to alter the Default Invitation Subject when sending out invitations.

  • Default Invitation Subject: the default subject of email invitations sent out by users inviting others to the site.

  • Restrict Invitation Message?: if set to Yes, users will not be able to alter the Default Invitation Message of the site invitation.

  • Default Invitation Message: the default message included with all invitations.

 

  • Invitation Email Template: the template used when viewing an emailed invitation. The template includes the message, a link to register and any headers or footers you add.

  • Invite User Send Template: the template used to view the main user invitation screen.

  • Invite User Confirmation Template: the template used for viewing invite confirmations.

  • Inbox Rich Edit: the rich editor configuration used when composing messages through the inbox.

  • Copy Sender on Messages?: if set to Yes, the user who sent the message will be copied.

  • Send only Inbox notifications: if set to Yes, WebGUI will only send the user a notification that the user has received a message in the Inbox, instead of sending the entire message itself.

  • Inbox Notification Template: the template used when viewing an Inbox notification.

 

Friends

 

 

  • Style Template: the style the Friends screen is wrapped in.

  • Edit Layout Template: the template chosen displays the various account plugins that are useable by the current user as well as the contents of the plugin currently chosen.

  • View Template: the template used when viewing friends.

  • Edit Template: the template used for editing friends.

  • Send Friends Request Template: the template used for requesting a friend.

  • Error Template: the template used for displaying error messages in the friends screen.

  • Friends Request Confirm Template: the template used to display a friend confirmation.

  • Friends Removal Confirm Template: the template used to display the confirmation when a friend has been removed.

 

Contributions

 

 

  • Style Template: the style the contributions screen is wrapped in.

  • Layout Template: the template used to display items in within the Contributions tab. This is the physical layout of content in the screen.

  • View Contributions Template: the template used for displaying user contributions.

 

Shop

 

 

  • Style Template: the style that encloses the Shop tab content.

  • Layout Template: the template used to display items in within the Shop tab. This is the physical layout of content in the screen.

  • My Purchases Template: the template used when viewing “my purchases” through the Shop tab.

  • My Purchases Detail Template: the template used when viewing purchase details.

  • My Sales Template: the templates used when viewing “my sales” through the Shop tab.

 

Account

 

 

  • Style Template: the style that encloses the Account tab content.

  • Layout Template: the template used to display items in within the Shop tab. This is the physical layout of content in the screen.

 

Friend Manager

 

 

  • Friends Manager: the user group allowed to manage Friends, assign users to one another, and view the interface for managing Friends.

  • Groups to Manage as Friends: select the user groups whose Friends you want to manage.

  • View Template: the template used when viewing the Friend Manager.

  • Edit Friends Template: the template used to display the screen used to manage (add/remove) friends for others.

  • Override ableToBeFriend profile setting?: if a user has the ableToBeFriend field set to No in its user profile, the option to be added as a friend will not appear in the user profile for that user. However, if this field is set to Yes in this screen, the Friend Manager will be able to manage this user as a friend in the Friend Manager.

 

User Tab

 

 

  • Enable Users After Anonymous Registration?: if set to No, anonymously registered users will need to be activated by a site admin.
     
  • Anonymous Registration: if toggled to Yes, users will be allowed to register themselves
  • Automatic LDAP Registration: if set to Yes, a WebGUI user account will be created and the user logged in if the credentials entered are validated by LDAP.

  • On Create User (User): a workflow chosen here will be run each time a user anonymously registers.

  • On Create User (Admin): the workflow chosen here will run each time an Admin creates a user acount.

  • On Update User (Admin): the workflow chosen here will run each time an Admin updates a user account.

  • Enable Karma?: if set to Yes, karma will be enabled on the site. Karma is further explained in the Karma chapter.

  • Karma per login?: if karma is enabled, this is the amount of karma a user will gain each time s/he logs in.

  • Session Timeout: the amount of time a user's session remains active before that user will need to login again; this amount of time is reset each time a user views a page.

  • Allow users to deactivate their account?: is set to Yes, users will be provided a means to deactivate their accounts without your intervention.

  • Enable passive profiling?: if set to Yes, passive profiling will be enabled on your site. This will keep track of every wobject viewed by users. Be aware, passive profiling is illegal in some areas of the world, and strongly looked down upon in others. Please be aware of the legal policy in your area.

  • Redirect After Login URL: if a URL is entered here, users will be sent to this URL after logging in to the site.

  • Show Message on Login?: if set to Yes, a message will be shown to users upon logging in to the site. The message shown is entered in the Message on Login Body field.

  • Show Message Number of Times: this sets the number of times users will see the login message if the Show Message on Login? field is set to Yes.

  • Reset All Users Number of Times Seen: if set to Yes, all users will see the login message again, regardless of if they have already been shown it the number of times indicated in the Show Message Number of Times field.

  • Message on Login Body: this is where the login message is entered.

 

Authentication Tab

 

 

  • Authentication Method: this sets the default authentication method for new accounts in WebGUI. By default, the two available options are WebGUI and LDAP. Alternative methods can be used by writing a customized authentication plug-in.

    • WebGUI authentication means that users will authenticate against the username and password stored in the WebGUI database.

    • LDAP authentication means that users will authenticate against an external LDAP server.

    Authentication methods can be set upon a per user basis.

  • LDAP Connection: Choose a connection that was defined in the LDAP Connections screen in the admin console.

  • Minimum Password Length: the minimum number of characters users are required to have in their passwords.

  • Number of digits required in password: the number of digits users are required to include in their passwords.

  • Number of non-word characters required in password: the number of special, or non-word, characters users are required to have in their passwords.

  • Number of upper case characters required in password: the number of upper-case characters users are required to include in their passwords.

  • Password Timeout: the amount of time that will pass before a user is required to reset his/her password.

  • Expire passwords on user creation?: if set to Yes, a password will be expired, or made unavailable for use, to any other user after this user's account creation.

  • Send welcome message?: if set to Yes, a user-defined welcome message will be sent to new users who create an account.

  • Welcome Message: in this field, type in the welcome message to be emailed to new users upon account creation.

     

 

  • User Email Address as Username: if set to Yes, the registration will not show a username field. Instead, the submitted email address will become the user's username.

  • Allow Users to Change Username?: if set to Yes, users will be provided a method to change their username.

  • Allow Users to Change Passwords?: if set to Yes, users will be provided a method to change their passwords.

  • Allow Password Recovery?: if set to Yes, users will be given a means by which to recover their password should they forget it. This will be done by making portions of a user's profile available for the user to fill in, thus validating the user's identity and initiating password recovery.

  • Require Username for Password Recovery?: if set to Yes, a user must know his/her username in order to recover a password. This is advised; otherwise, someone need only know the other information from the user's profile to reset that user's password.

  • Validate email addresses?: if set to Yes, users must validate their email address(es) before a new password will be sent.

  • Use captcha image?: This requires a captcha image to be used at account creation time. Captcha is an image containing a word and some other interference to make the image hard to read by computers, but relatively easy to read by humans.

  • Account Template: the template used to display users account information.

  • Create Account Template: the template displayed for account creation.

  • Expired Password Template: the template used to inform a user that his/her password has expired and it is time to set a new one.

  • Login Template: the template used to display the login fields.

  • Password Recovery Template: the template used to display the password recovery screen.

  • Welcome Message Template: the template used to display the welcome message that is sent to new users.

  • Account Activation Mail Template: the template used to display the account activation message that is sent to new users.

 

Permissions

 

The Permissions tab allows you to assign group permissions to each of the admin functions listed.

Keywords:

Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved