Skip to content
SmartBots

Security Bot configuration

 
(9 intermediate revisions not shown)
Line 1: Line 1:
== Overview ==
== Overview ==
-
Scheduled messages allows your bot to send out automatic local chat messages for specific dates and time (SLT)
+
[[Security Bot (add-on)|Security Bot add-on]] allows your [[Personal Bots|Personal Bot]] to act as your parcel security. Below you will find all the instructions needed to configure the add-on.
-
There are two types of scheduled messages:
+
'''IMPORTANT:''' Please be advised that in-order for the add-on to work, bot must be an '''Estate Manager''' or parcel must be '''Group Owned''' and bot must have group permissions. [[Security Bot group permissions|Read more here]]
-
# One-time message
+
-
# Repeating/Periodic Message'''  
+
-
To setup one-time/periodic messages for your Local Chat add-on, navigate to your Calendar Messages from your add-on page and click '''"Schedule new message"'''
+
=== Security Setup ===
-
Click the according tabs below to read the instructions for creating each message type
+
In general, there are 3 types of security modes that you can enable. You can access this page by visiting your going over to Security Bot add-on and click '''Use ban lists'''
-
<div class=blocksMenuAuto>
+
[[File:Security_Bot_security_modes_numbered_new.png|center|link=]]
-
* One-time message
+
-
* Periodic message
+
-
</div>
+
-
<div class=blocksMenuAutoBlock>
 
-
=== Creating One-Time Message ===
+
# '''Block all + allow in allowed list:''' Bot will not allow anyone to enter the parcel unless they're added on '''allowed lists''' (See '''Managing access lists''' below)
-
[[File:Creating_one-time_message.png|center|link=]]
+
# '''Allow all + block all in blocked list:''' Bot will allow everyone to enter except for those who are added on '''blocked list'''
  +
# '''Allow all:''' Fully disables the protection and bot will let anyone in
  +
# '''Parcel name:''' Bot will operate the add-on only in specified parcel. Useful to prevent bot spamming other locations. (Such as Info HUBs after Rolling Restarts)
  +
# '''Welcome message:''' Bot sends this IM to anyone who lands as a greeting. Can be left blank for no greeting.
  +
# '''Warning delay:''' Defines the amount of time (seconds) before '''Warning message''' is sent after visitors arrival.
  +
# '''Warning message:''' The text that bot sends to visitor as a warning.
  +
# '''Kick delay:''' Defines the amount of time (seconds) before '''Kick message''' is sent after visitors arrival.
  +
# '''Kick message:''' The text that bot sends to visitor before kicking them.
-
# '''Select your bot:''' Choose which personal bot is the sender of the message
+
== Managing access lists ==
-
# '''Send on:''' Select the date of the message to be sent on.
+
-
# '''Time:''' Fill out on which time message is supposed to deliver, be advised - time format is in '''24 hour clock''' (a.k.a "Military Time")
+
-
# '''Add delivery time:''' Adds another time entry.
+
-
# '''Repeat:''' This option converts your one-time message into periodic (leave blank if message is intended for one-time sending)
+
-
# '''Message Text:''' This is the body of your message.
+
-
# '''Byte Count:''' Displays maximum length of your message text.
+
-
# '''Confirm:''' Saves your changes 
+
-
</div>
+
The access lists define who gets to skip the bot's security under '''Security Modes''' or fully workaround it.
-
<div class=blocksMenuAutoBlock>
+
* If a resident is added to '''blocked list''': Bot will immediately eject them from parcel.
  +
* If a resident is added to '''allowed list''': Bot will let them enter on any conditions.
-
=== Creating Periodic Messages ===
+
To add someone to either of the list:
  +
# Visit your add-on page & click '''Edit access lists'''
  +
# Click '''Add resident''' under corresponding list [[File:Security_Bot_access_list_highlighted.png|center|border|600px|link=]]
  +
# Enter SL name and click '''Add avatar'''[[File:Security_bot_access_lists_adding_resident.png|center|border|600px|link=]]
-
[[File:Creating_periodic_message.png|center|link=]]
+
Optionally, from the left-side you can select any of the recent visitors name.  
-
# '''Select your bot:''' Choose which personal bot is the sender of the message
+
== Setting up access word ==
-
# '''Send on:''' Select the first date of the message to be sent on.
+
-
# '''Time:''' Fill out on which time message is supposed to deliver, be advised - time format is in '''24 hour clock''' (a.k.a "Military Time")
+
-
# '''Add delivery time:''' Adds another time entry.
+
-
# '''Repeat:''' Enable this option to convert your message to periodic
+
-
# '''Repeat (Daily/Weekdays):''' Choose from the drop-down if your message should deliver daily or on specific weekdays.
+
-
# '''Every:''' Send message on every '''inserted''' value (1 day - everyday, 2 days - every 2nd day, etc) - If "Weekdays" is selected in an '''option 5''' - you choose days of the week instead of this.
+
-
# '''Message Text:''' This is the body/text of your message.
+
-
# '''Byte Count:''' Displays maximum length of your notice text.
+
-
</div>
+
'''Access word''' is a unique optional feature which acts as a password. If access word is given to bot via IMs, visitor will not get ejected. This is a useful feature to allow special guests in ''without adding them to Access lists''
-
== Message Calendar ==
+
To setup an Access word:
  +
# Visit the add-on's main page
  +
# Click '''Access word'''
  +
# Enter the special access word
-
Message Calendar allows you to keep track of your message schedule to see on which dates of the month your messages are scheduled to be sent out.  
+
[[File:Security_Bot_access_word.png|center|border|600px|link=]]
-
[[File:Messages_Calendar.png|center|link=]]
+
You can also configure the effectiveness of the access word:  
  +
* You can set the expiration date of the access word (It will no longer be effective after it's expired)
  +
* How long the access word will allow entry to a visitor
-
=== Editing/removing scheduled messages ===
+
== Setting up spam protection ==
-
Clicking on each date of the calendar will display the list of your scheduled messages for the selected date.  
+
[[File:Security_Bot_spam_protection.png|center|border|600px|link=]]
-
To remove/edit the message:  
+
'''Spam Protection''' is also one of the unique features to keep your parcel secure from unnecessary group invitations. If bot receives an invite - it will '''eject & blocklist''' the sender.
-
# Click the specific date on the calendar
+
 
-
# Hover your mouse over top-right corner of the message
+
To enable Spam Protection:
-
# The menu of following option will appear:
+
# Visit your add-on's main page
-
** '''Edit message:''' Takes you to message editor
+
# Click '''Spam Protection'''
-
** '''This occurrence only (remove):''' Removes the message for the specified date only
+
# Enable the checkmark '''Kick and ban residents who try to invite bot'''
-
** '''WHOLE sequence (remove):''' Removes the entire periodic message
+
 
  +
== Monitoring visitors live ==
  +
 
  +
Lastly, you can monitor the parcel visitors live. You can add them to '''Access lists''' directly from this page without entering their names.
  +
 
  +
[[File:Security_Bot_visitor_monitoring.png|center|border|600px|link=]]
  +
 
  +
To visit Live Monitoring page:
  +
# Visit your add-on's main page
  +
# Click '''Visitors today'''
-
[[File:Clicking_removing_message.png|center|link=]]
 
__NOTOC__
__NOTOC__

Latest revision as of 22:54, 4 October 2022

Overview

Security Bot add-on allows your Personal Bot to act as your parcel security. Below you will find all the instructions needed to configure the add-on.

IMPORTANT: Please be advised that in-order for the add-on to work, bot must be an Estate Manager or parcel must be Group Owned and bot must have group permissions. Read more here

Security Setup

In general, there are 3 types of security modes that you can enable. You can access this page by visiting your going over to Security Bot add-on and click Use ban lists

Security Bot security modes numbered new.png


  1. Block all + allow in allowed list: Bot will not allow anyone to enter the parcel unless they're added on allowed lists (See Managing access lists below)
  2. Allow all + block all in blocked list: Bot will allow everyone to enter except for those who are added on blocked list
  3. Allow all: Fully disables the protection and bot will let anyone in
  4. Parcel name: Bot will operate the add-on only in specified parcel. Useful to prevent bot spamming other locations. (Such as Info HUBs after Rolling Restarts)
  5. Welcome message: Bot sends this IM to anyone who lands as a greeting. Can be left blank for no greeting.
  6. Warning delay: Defines the amount of time (seconds) before Warning message is sent after visitors arrival.
  7. Warning message: The text that bot sends to visitor as a warning.
  8. Kick delay: Defines the amount of time (seconds) before Kick message is sent after visitors arrival.
  9. Kick message: The text that bot sends to visitor before kicking them.

Managing access lists

The access lists define who gets to skip the bot's security under Security Modes or fully workaround it.

  • If a resident is added to blocked list: Bot will immediately eject them from parcel.
  • If a resident is added to allowed list: Bot will let them enter on any conditions.

To add someone to either of the list:

  1. Visit your add-on page & click Edit access lists
  2. Click Add resident under corresponding list
    Security Bot access list highlighted.png
  3. Enter SL name and click Add avatar
    Security bot access lists adding resident.png

Optionally, from the left-side you can select any of the recent visitors name.

Setting up access word

Access word is a unique optional feature which acts as a password. If access word is given to bot via IMs, visitor will not get ejected. This is a useful feature to allow special guests in without adding them to Access lists

To setup an Access word:

  1. Visit the add-on's main page
  2. Click Access word
  3. Enter the special access word
Security Bot access word.png

You can also configure the effectiveness of the access word:

  • You can set the expiration date of the access word (It will no longer be effective after it's expired)
  • How long the access word will allow entry to a visitor

Setting up spam protection

Security Bot spam protection.png

Spam Protection is also one of the unique features to keep your parcel secure from unnecessary group invitations. If bot receives an invite - it will eject & blocklist the sender.

To enable Spam Protection:

  1. Visit your add-on's main page
  2. Click Spam Protection
  3. Enable the checkmark Kick and ban residents who try to invite bot

Monitoring visitors live

Lastly, you can monitor the parcel visitors live. You can add them to Access lists directly from this page without entering their names.

Security Bot visitor monitoring.png

To visit Live Monitoring page:

  1. Visit your add-on's main page
  2. Click Visitors today