Changeset 9787

Show
Ignore:
Timestamp:
05/30/10 11:26:29 (2 years ago)
Author:
p_lindheimer
Message:

closes #4253 cleanup default amportal.conf file (note: the patch still did not apply but the full copy was used so it should be good but please confirm)

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • freepbx/branches/2.8/amportal.conf

    r9483 r9787  
    1818# Run /usr/src/AMP/apply_conf.sh after making changes to this file 
    1919 
    20 # AMPDBHOST: the host to connect to the database named 'asterisk' 
     20# FreePBX Database configuration 
     21# AMPDBHOST: Hostname where the FreePBX database resides 
     22# AMPDBENGINE: Engine hosting the FreePBX database (e.g. mysql) 
     23# AMPDBNAME: Name of the FreePBX database (e.g. asterisk) 
     24# AMPDBUSER: Username used to connect to the FreePBX database 
     25# AMPDBPASS: Password for AMPDBUSER (above) 
     26# AMPENGINE: Telephony backend engine (e.g. asterisk) 
     27# AMPMGRUSER: Username to access the Asterisk Manager Interface 
     28# AMPMGRPASS: Password for AMPMGRUSER 
     29
    2130AMPDBHOST=localhost 
    22  
    23 # AMPDBUSER: the user to connect to the database named 'asterisk' 
     31AMPDBENGINE=mysql 
     32# AMPDBNAME=asterisk 
    2433# AMPDBUSER=asteriskuser 
    25  
    26 # AMPDBENGINE: the type of database to use 
    27 AMPDBENGINE=mysql 
    28  
    29 # AMPDBPASS: the password for AMPDBUSER 
    3034# AMPDBPASS=amp109 
    31  
    32 # AMPENGINE: the telephony backend engine to use 
    3335AMPENGINE=asterisk 
    34  
    35 # AMPMGRUSER: the user to access the Asterisk manager interface 
    3636AMPMGRUSER=admin 
    37  
    38 # AMPMGRPASS: the password for AMPMGRUSER 
    3937AMPMGRPASS=amp111 
    4038 
    41 # AMPBIN: where command line scripts live 
     39# AMPBIN: Location of the FreePBX command line scripts 
     40# AMPSBIN: Location of (root) command line scripts 
     41
    4242AMPBIN=/var/lib/asterisk/bin 
    43  
    44 #AMPSBIN: where (root) command line scripts live 
    45 AMPSBIN=/usr/sbin 
    46  
    47 # AMPWEBROOT: the path to Apache's webroot (leave off trailing slash) 
     43AMPSBIN=/usr/local/sbin 
     44 
     45# AMPWEBROOT: Path to Apache's webroot (leave off trailing slash) 
     46# AMPCGIBIN: Path to Apache's cgi-bin dir (leave off trailing slash) 
     47# AMPWEBADDRESS: The IP address or host name used to access the AMP web admin 
     48
    4849AMPWEBROOT=/var/www/html 
    49  
    50 # AMPCGIBIN: the path to Apache's cgi-bin dir (leave off trailing slash) 
    5150AMPCGIBIN=/var/www/cgi-bin  
    52  
    53 # AMPWEBADDRESS: the IP address or host name used to access the AMP web admin 
    54 #AMPWEBADDRESS=192.168.1.101 
    55 AMPWEBADDRESS= 
    56  
    57 # FOPWEBROOT:web root for the Flash Operator Panel 
     51# AMPWEBADDRESS=x.x.x.x|hostname 
     52 
     53# FOPWEBROOT: Path to the Flash Operator Panel webroot (leave off trailing slash) 
     54# FOPPASSWORD: Password for performing transfers and hangups in the Flash Operator Panel 
     55# FOPRUN: Set to true if you want FOP started by freepbx_engine (amportal_start), false otherwise 
     56# FOPDISABLE: Set to true to disable FOP in interface and retrieve_conf.  Useful for sqlite3  
     57# or if you don't want FOP. 
     58
     59FOPRUN=true 
    5860FOPWEBROOT=/var/www/html/panel 
    59  
    60 # FOPPASSWORD: the secret code for performing transfers and hangups in the Flash Operator Panel 
    6161FOPPASSWORD=passw0rd 
    6262 
    63 # FOPSORT: FOP should sort extensions by Last Name [lastname] or by Extension [extension] 
    64 FOPSORT=extension 
    65  
    66 # FOPRUN: set to true if you want FOP started by freepbx_engine (amportal_start), false otherwise 
    67 FOPRUN=true 
    68  
    69 # AUTHTYPE: authentication type to use for web admin 
    70 # If type set to 'database', the primary AMP admin credentials will be the AMPDBUSER/AMPDBPASS above 
    71 # valid: none, database 
     63# FOPSORT=extension|lastname 
     64# DEFAULT VALUE: extension 
     65# FOP should sort extensions by Last Name [lastname] or by Extension [extension] 
     66 
     67# This is the default admin name used to allow an administrator to login to ARI bypassing all security. 
     68# Change this to whatever you want, don't forget to change the ARI_ADMIN_PASSWORD as well 
     69ARI_ADMIN_USERNAME=admin 
     70 
     71# This is the default admin password to allow an administrator to login to ARI bypassing all security. 
     72# Change this to a secure password. 
     73ARI_ADMIN_PASSWORD=ari_password 
     74 
     75# AUTHTYPE=database|none 
     76# Authentication type to use for web admininstration. If type set to 'database', the primary 
     77# AMP admin credentials will be the AMPDBUSER/AMPDBPASS above. 
    7278AUTHTYPE=none 
    7379 
    74 # AMPADMINLOGO: Defines the logo that is to be displayed at the TOP RIGHT of the admin screen. 
    75 #         This enables you to customize the look of the administration screen. 
     80# AMPADMINLOGO=filename 
     81# Defines the logo that is to be displayed at the TOP RIGHT of the admin screen. This enables 
     82# you to customize the look of the administration screen. 
    7683# NOTE: images need to be saved in the ..../admin/images directory of your AMP install 
    7784# This image should be 55px in height 
    7885AMPADMINLOGO=logo.png 
    7986 
    80 # USECATEGORIES: Controls if the menu items in the admin interface are sorted by category (true), 
    81 #                or sorted alphebetically with no categories shown (false). Defaults to true. 
    82 #USECATEGORIES=false 
    83  
    84 # AMPEXTENSIONS: the type of view for extensions admin  
    85 # If set to 'deviceanduser' Devices and Users will be administered seperately, and Users will be able to "login" to devices. 
    86 # If set to 'extensions' Devices and Users will be administered in a single screen. 
     87# USECATEGORIES=true|false 
     88# DEFAULT VALUE: true 
     89# Controls if the menu items in the admin interface are sorted by category (true), or sorted  
     90# alphabetically with no categories shown (false). 
     91 
     92# AMPEXTENSIONS=extensions|deviceanduser 
     93# Sets the extension behavior in FreePBX.  If set to 'extensions', Devices and Users are 
     94# administered together as a unified Extension, and appear on a single page. 
     95# If set to 'deviceanduser', Devices and Users will be administered seperately.  Devices (e.g.  
     96# each individual line on a SIP phone) and Users (e.g. '101') will be configured  
     97# independent of each other, allowing association of one User to many Devices, or allowing  
     98# Users to login and logout of Devices. 
    8799AMPEXTENSIONS=extensions 
    88100 
    89 # ENABLECW: Enable call waiting by default when an extension is created (DEFAULT is yes) 
    90 # Set to 'no' to if you don't want phones to be commissioned with call waiting already 
    91 # enabled. The user would then be required to dial the CW feature code (*70 default) to  
    92 # enable their phone. Most installations should leave this alone. It allows multi-line 
    93 # phones to receive multiple calls on their line appearances. 
    94 ENABLECW=yes 
    95  
    96 #CWINUSEBUSY: Set to yes for extensions that have CW enabled to report as busy if 
    97 # they don't answer (resulting in busy voicemail greeting). Otherwise they simply 
    98 # report as no-answer (e.g. busy greeting servers no purpose 
    99 CWINUSEBUSY=yes 
    100  
    101 # AMPBADNUMBER: Set to false if you do not want the bad-number context generated which 
    102 # traps any bogus number or feature code and plays a message to the effect. If you use 
    103 # the Early Dial feature on some Grandstream phones, you will want to set this to false 
    104 AMPBADNUMBER=true 
    105  
    106 # The following are used to optionally have the FreePBX backup program optionally 
    107 # send the generated backup to an ftp server 
    108 
    109 # FTPBACKUP=YES to enable 
    110 # FTPUSER, FTPPASSWORD, FTPSERVER must be set 
    111 # FTPSUBDIR is an optional subdirectory at the ftp server, it will cause ftp to do a cd 
    112 
    113 # There is no error checking so you should check to make sure these are set correctly. The 
    114 # ftp is saved after the backup, so it will not cause the local backup file to be effected 
    115 
    116 # FTPBACKUP=yes 
    117 #FTPUSER=asterisk 
    118 #FTPPASSWORD=password 
    119 #FTPSUBDIR=mybackupfolder 
    120 #FTPSERVER=myftpserver 
    121  
    122 # SSH BACKUP INFO: must have a valid SSHRSAKEY file and server, only supported through 
    123 # ssh. SUBDIR is optional and will be created if it does not exist. 
    124 
    125 # If SSHUSER is not set, it will default to the current user which is asterisk in any 
    126 # standard configuration. 
    127 
    128 #SSHBACKUP=yes 
    129 #SSHUSER=backups 
    130 #SSHRSAKEY=/etc/asterisk/backup_rsa 
    131 #SSHSUBDIR=mysubdir 
    132 #SSHSERVER=mybackupserver.com 
    133  
    134 # AMPPROVROOT=/var/ftp /tftpboot 
    135 # One or more directories where there are provisioning files that should be included in the backup. Currently 
    136 # these get backed up only, the FreePBX utility does not automatically restore them. 
    137 
    138 #AMPPROVROOT=/var/ftp /tftpboot 
    139 # AMPPROVEXCLUDE=/var/ftp/exclude-from-file-list 
    140 # a file containing a list of file/directories to exclude, (will be used in tar's --exclude-from argument) 
    141 
    142 #AMPPROVEXCLUDE=/var/ftp/exclude-from-file-list 
    143  
    144 #AMPBACKUPSUDO=false|true 
    145 # This option allows you to use sudo when backing up files. Usefull ONLY when using AMPPROVROOT 
    146 # Allowes backup and restore of files specified in AMPPROVROOT, based on permissions in /etc/sudoers 
    147 #   for example, adding the following to sudoers:  
     101# ENABLECW=true|false 
     102# DEFAULT VALUE: true 
     103# Enable call waiting by default when an extension is created. Set to 'no' to if you don't want  
     104# phones to be commissioned with call waiting already enabled. The user would then be required 
     105# to dial the CW feature code (*70 default) to enable their phone. Most installations should leave 
     106# this alone. It allows multi-line phones to receive multiple calls on their line appearances. 
     107 
     108# CWINUSEBUSY=true|false 
     109# DEFAULT VALUE: true 
     110# For extensions that have CW enabled, report unanswered CW calls as 'busy' (resulting in busy  
     111# voicemail greeting). If set to no, unanswered CW calls simply report as 'no-answer'. 
     112 
     113# AMPBADNUMBER=true|false 
     114# DEFAULT VALUE: true 
     115# Generate the bad-number context which traps any bogus number or feature code and plays a 
     116# message to the effect. If you use the Early Dial feature on some Grandstream phones, you 
     117# will want to set this to false. 
     118 
     119# AMPBACKUPSUDO=true|false 
     120# DEFAULT VALUE: false 
     121# This option allows you to use sudo when backing up files. Useful ONLY when using AMPPROVROOT 
     122# Allows backup and restore of files specified in AMPPROVROOT, based on permissions in /etc/sudoers 
     123# for example, adding the following to sudoers would allow the user asterisk to run tar on ANY file 
     124# on the system: 
    148125# asterisk localhost=(root)NOPASSWD: /bin/tar 
    149126# Defaults:asterisk !requiretty 
    150 # would allow the user asterisk to run tar on ANY file on the system. 
    151127# PLEASE KEEP IN MIND THE SECURITY RISKS INVOLVED IN ALLOWING THE ASTERISK USER TO TAR/UNTAR ANY FILE 
    152 #AMPBACKUPSUDO=true 
    153  
    154 #AMPPROVEXCLUDELIST=/dir file 
    155 # a list of files/directories to exclude, (will be used in tar's --exclude argument) 
    156 
    157 #AMPPROVEXCLUDELIST=/etc/selinux /tftpboot/polycom /tftpboot/*.ld /tftpboot/*.cmp /tftpboot/*.st 
    158  
    159 #AMPBACKADMIN=true|false 
    160 #option to exclude the admin/ web dir from backups. This is will result in significantly smaller backups 
    161 # defaults to true - always backup admin dir 
    162 #AMPBACKADMIN=true 
    163  
    164 # If CUSTOMASERROR is set to false, then the Destination Registry will not report unknown destinations as errors 
    165 # this should be left to the default true and custom destinations should be moved into the new custom apps registry 
    166 # CUSTOMASERROR=false 
    167  
    168 # if DYNAMICHINTS is set to true, Core will not statically generate hints. Instead it will make a call to the 
    169 # AMPBIN php script, generate_hints.php, through an Asterisk's #exec call. This requires Asterisk.conf to be 
    170 # configured with "execincludes=yes" set in the [options] section. 
    171 # DYNAMICHINTS=true 
    172  
    173 # XTNCONFLICTABORT, BADDESTABORT 
    174 # setting either of these to true will result in retrieve_conf aborting during a reload if an extension 
     128 
     129# CUSTOMASERROR=true|false 
     130# DEFAULT VALUE: true 
     131# If false, then the Destination Registry will not report unknown destinations as errors. This should be 
     132# left to the default true and custom destinations should be moved into the new custom apps registry. 
     133 
     134# DYNAMICHINTS=true|false 
     135# DEFAULT VALUE: false 
     136# If true, Core will not statically generate hints, but instead make a call to the AMPBIN php script,  
     137# and generate_hints.php through an Asterisk's #exec call. This requires Asterisk.conf to be configured  
     138# with "execincludes=yes" set in the [options] section. 
     139 
     140# XTNCONFLICTABORT=true|false 
     141# BADDESTABORT=true|false 
     142# DEFAULT VALUE: false 
     143# Setting either of these to true will result in retrieve_conf aborting during a reload if an extension 
    175144# conflict is detected or a destination is detected. It is usually better to allow the reload to go 
    176 # through and then correct the problem but these can be set if a more strict behavior is desired 
    177 # both default to false if not set 
    178 XTNCONFLICTABORT=false 
    179 BADDESTABORT=false 
    180  
    181 # SERVERINTITLE if set to true, the browser title will be preceded with the server name. default false 
    182 SERVERINTITLE=false 
    183  
    184 # USEDEVSTATE = true|false # DEFAULT VALUE false 
     145# through and then correct the problem but these can be set if a more strict behavior is desired. 
     146 
     147# SERVERINTITLE=true|false 
     148# DEFAULT VALUE: false 
     149# Precede browser title with the server name. 
     150 
     151# USEDEVSTATE = true|false 
     152# DEFAULT VALUE: false 
    185153# If this is set, it assumes that you are running Asterisk 1.4 or higher and want to take advantage of the 
    186 # func_devstate.c backport available from Asterisk 1.6 which allows custom hints to be created to support 
     154# func_devstate.c backport available from Asterisk 1.6. This allows custom hints to be created to support 
    187155# BLF for server side feature codes such as daynight, followme, etc. 
    188 
    189 USEDEVSTATE=true 
    190  
    191 # MODULEADMINWGET=true|false # DEFAULT VALUE false 
     156 
     157# MODULEADMINWGET=true|false 
     158# DEFAULT VALUE: false 
    192159# Module Admin normally tries to get its online information through direct file open type calls to URLs that 
    193 # go back to the freepbx.org server. If it fails, typically because of content filters in firewalls that don't 
    194 # like the way PHP formats the requests, the code will fall back and try a wget to pull the information. 
     160# go back to the freepbx.org server. If it fails, typically because of content filters in firewalls that 
     161# don't like the way PHP formats the requests, the code will fall back and try a wget to pull the information. 
    195162# This will often solve the problem. However, in such environment there can be a significant timeout before 
    196 # the failed file open calls to the URLs return and there are often 2-3 of these that occur. Setting this value 
    197 # will force FreePBX to avoid the attempt to open the URL and go straight to the wget calls. 
    198 
    199 MODULEADMINWGET=false 
    200  
    201 # AMPDISABLELOG=true|false # DEFAULT VALUE true 
     163# the failed file open calls to the URLs return and there are often 2-3 of these that occur. Setting this 
     164# value will force FreePBX to avoid the attempt to open the URL and go straight to the wget calls. 
     165 
     166# AMPDISABLELOG=true|false 
     167# DEFAULT VALUE: true 
    202168# Whether or not to invoke the FreePBX log facility 
    203169 
    204 # AMPSYSLOGLEVEL=LOG_EMERG|LOG_ALERT|LOG_CRIT|LOG_ERR|LOG_WARNING|LOG_NOTICE|LOG_INFO|LOG_DEBUG|LOG_SQL|SQL # DEFAULT VALUE LOG_ERR 
    205 # Where to log if enabled, SQL, LOG_SQL logs to old MySQL table, others are passed to syslog system to determine where to log 
    206  
    207 # AMPENABLEDEVELDEBUG=true|false # DEFAULT VALUE false 
     170# AMPSYSLOGLEVEL=LOG_EMERG|LOG_ALERT|LOG_CRIT|LOG_ERR|LOG_WARNING|LOG_NOTICE|LOG_INFO|LOG_DEBUG|LOG_SQL|SQL 
     171# DEFAULT VALUE: LOG_ERR 
     172# Where to log if enabled, SQL, LOG_SQL logs to old MySQL table, others are passed to syslog system to 
     173# determine where to log 
     174 
     175# AMPENABLEDEVELDEBUG=true|false 
     176# DEFAULT VALUE: false 
    208177# Whether or not to include log messages marked as 'devel-debug' in the log system 
    209178 
    210 # AMPMPG123=true|false # DEFAULT VALUE true 
    211 # When set to false, the old MoH behavior is adopted where MP3 files can be loaded and WAV files converted to MP3 
    212 # The new default behavior assumes you have mpg123 loaded as well as sox and will convert MP3 files to WAV. This is 
    213 # highly recommended as MP3 files heavily tax the system and can cause instability on a busy phone system. 
     179# AMPMPG123=true|false  
     180# DEFAULT VALUE: true 
     181# When set to false, the old MoH behavior is adopted where MP3 files can be loaded and WAV files converted 
     182# to MP3. The new default behavior assumes you have mpg123 loaded as well as sox and will convert MP3 files 
     183# to WAV. This is highly recommended as MP3 files heavily tax the system and can cause instability on a busy 
     184# phone system. 
    214185 
    215186# CDR DB Settings: Only used if you don't use the default values provided by FreePBX. 
     
    222193# CDRDBTABLENAME: Name of the table in the db where the cdr is stored cdr is default  
    223194 
    224 # AMPVMUMASK: defaults to 077 allowing only the asterisk user to have any permission on VM files. If set to something 
    225 #             like 007, it would allow the group to have permissions. This can be used if setting apache to a different 
    226 #             user then asterisk, so that the apache user (and thus ARI) can have access to read/write/delete the 
    227 #             voicemail files. If changed, some of the voicemail directory structure may have to be manually changed. 
     195# AMPVMUMASK=mask  
     196# DEFAULT VALUE: 077  
     197# Defaults to 077 allowing only the asterisk user to have any permission on VM files. If set to something 
     198# like 007, it would allow the group to have permissions. This can be used if setting apache to a different 
     199# user then asterisk, so that the apache user (and thus ARI) can have access to read/write/delete the 
     200# voicemail files. If changed, some of the voicemail directory structure may have to be manually changed. 
    228201 
    229202# DASHBOARD_STATS_UPDATE_TIME=integer_seconds 
     
    235208# less frequently (such as Asterisk Uptime) based on the INFO value 
    236209 
    237 # FOPDISABLE=true|false # DEFAULT VALUE false 
    238 # Disables FOP in interface and retrieve_conf.  Useful for sqlite3 or if you don't want FOP. 
    239  
    240210# ZAP2DAHDICOMPAT=true|false 
    241211# DEFAULT VALUE: false 
     
    248218# CHECKREFERER=true|false 
    249219# DEFAULT VALUE: true 
    250 # When set to the default value of true, all requests into FreePBX that might possibly add/edit/delete settings will 
    251 # be validated to assure the request is coming from the server. This will protect the system from CSRF (cross site  
    252 # request forgery) attacks. It will have the effect of preventing legitimately entering URLs that could modify 
    253 # settings which can be allowed by changing this field to false 
    254 
     220# When set to the default value of true, all requests into FreePBX that might possibly add/edit/delete 
     221# settings will be validated to assure the request is coming from the server. This will protect the system 
     222# from CSRF (cross site request forgery) attacks. It will have the effect of preventing legitimately entering 
     223# URLs that could modify settings which can be allowed by changing this field to false. 
    255224 
    256225# USEQUEUESTATE=true|false 
    257226# DEFAULT VALUE: false 
    258227# Setting this flag will generate the required dialplan to integrate with the following Asterisk patch: 
    259 # https://issues.asterisk.org/view.php?id=15168 
     228# https://issues.asterisk.org/view.php?id=15168 
    260229# This feature is planned for a future 1.6 release but given the existence of the patch can be used prior. Once 
    261230# the release version is known, code will be added to automatically enable this format in versions of Asterisk 
     
    264233# USEGOOGLEDNSFORENUM=true|false 
    265234# DEFAULT VALUE: false 
    266 # Setting this flag will generate the required global variable so that enumlookup.agi will use Google DNS 8.8.8.8 
    267 # when looking up ENUMS 
    268 # Not all DNS deals with NAPTR record, but Google does. There is a drawback to this as Google tracks every 
    269 # lookup. If you are not comfortable with this, do not enable this setting. Please read Google FAQ about this: 
    270 # http://code.google.com/speed/public-dns/faq.html#privacy 
     235# Setting this flag will generate the required global variable so that enumlookup.agi will use Google DNS 
     236# 8.8.8.8 when performing an ENUM lookup. Not all DNS deals with NAPTR record, but Google does. There is a 
     237# drawback to this as Google tracks every lookup. If you are not comfortable with this, do not enable this 
     238# setting. Please read Google FAQ about this: http://code.google.com/speed/public-dns/faq.html#privacy 
    271239 
    272240# MOHDIR=subdirectory_name 
    273241# This is the subdirectory for the MoH files/directories which is located in ASTVARLIBDIR 
    274242# if not specified it will default to mohmp3 for backward compatibility. 
    275 MOHDIR=moh 
    276243 
    277244# RELOADCONFIRM=true|false 
    278245# DEFAULT VALUE: true 
    279 # When set to false, will by-pass the confirm on Reload Box 
     246# When set to false, will bypass the confirm on Reload Box 
    280247 
    281248# FCBEEPONLY=true|false 
     
    284251# CallForward, CallWaiting, DayNight, DoNotDisturb and FindMeFollow 
    285252 
    286 DISABLECUSTOMCONTEXTS=true 
    287253# DISABLECUSTOMCONTEXTS=true|false 
    288254# DEFAULT VALUE: false 
    289 # Normally FreePBX auto-generates a custom context that may be usable for adding custom dialplan to modify the normal behavior 
    290 # of FreePBX. It takes a good understanding of how Asterisk processes these includes to use this and in many of the cases, there 
    291 # is no useful application. All includes will result in a WARNING in the Asterisk log if there is no context found to include 
    292 # though it results in no errors. If you know that you want the includes, you can set this to true. If you comment it out FreePBX 
    293 # will revert to legacy behavior and include the contexts. 
    294  
    295 ARI_ADMIN_USERNAME=admin 
    296 # This is the default admin name used to allow an administrator to login to ARI bypassing all security. 
    297 # Change this to whatever you want, don't forget to change the ARI_ADMIN_PASSWORD as well 
    298  
    299 ARI_ADMIN_PASSWORD=ari_password 
    300 # This is the default admin password to allow an administrator to login to ARI bypassing all security. 
    301 # Change this to a secure password. 
     255# Normally FreePBX auto-generates a custom context that may be usable for adding custom dialplan to modify the 
     256# normal behavior of FreePBX. It takes a good understanding of how Asterisk processes these includes to use 
     257# this and in many of the cases, there is no useful application. All includes will result in a WARNING in the 
     258# Asterisk log if there is no context found to include though it results in no errors. If you know that you 
     259# want the includes, you can set this to true. If you comment it out FreePBX will revert to legacy behavior 
     260# and include the contexts. 
     261