 |
| |
Config.yml is the main configuration YAML file used by Sipwise NGCP. After every changes it need to run the command ngcpcfg apply to apply changes (followed by ngcpcfg push in the PRO version to apply changes to sp2). The following is a brief description of the main variables contained into /etc/ngcp-config/config.yml file.
The following is the asterisk section:
asterisk:
log:
facility: local6
rtp:
maxport: 20000
minport: 10000
sip:
bindport: 5070
dtmfmode: rfc2833
voicemail:
enable: 'no'
fromstring: 'Voicemail server'
greeting:
busy_custom_greeting: '/home/user/file_no_extension'
busy_overwrite_default: 'no'
busy_overwrite_subscriber: 'no'
unavail_custom_greeting: '/home/user/file_no_extension'
unavail_overwrite_default: 'no'
unavail_overwrite_subscriber: 'no'
mailbody: 'You have received a new message from ${VM_CALLERID} in voicebox ${VM_MAILBOX} on ${VM_DATE}.'
mailsubject: '[Voicebox] New message ${VM_MSGNUM} in voicebox ${VM_MAILBOX}'
max_msg_length: 180
maxgreet: 60
maxmsg: 30
maxsilence: 0
min_msg_length: 3
normalize_match: '^00|\+([1-9][0-9]+)$'
normalize_replace: '$1'
serveremail: voicebox@sip.sipwise.comThe following is the backup tools section:
backuptools:
cdrexport_backup:
enable: 'no'
etc_backup:
enable: 'no'
mail:
address: noc@company.org
error_subject: '[ngcp-backup] Problems detected during daily backup'
log_subject: '[ngcp-backup] Daily backup report'
send_errors: 'no'
send_log: 'no'
mysql_backup:
enable: 'no'
exclude_dbs: 'syslog sipstats information_schema'
rotate_days: 7
storage_dir: '/var/backup/ngcp_backup'
temp_backup_dir: '/tmp/ngcp_backup'The following is the cdr export section:
cdrexport: daily_folder: 'yes' export_failed: 'no' export_incoming: 'no' exportpath: '/home/jail/home/cdrexport' full_names: 'yes' monthly_folder: 'yes'
The following is the check tools section:
checktools:
collcheck:
cpuidle: 0.1
dfused: 0.9
eximmaxqueue: 15
loadlong: 2
loadmedium: 2
loadshort: 3
maxage: 600
memused: 0.7
siptimeout: 15
swapfree: 0.5
asr_nsr_statistics: 1
exim_check_enable: 0
force: 0
kamailio_check_dialog_active_enable: 1
kamailio_check_dialog_early_enable: 1
kamailio_check_dialog_incoming_enable: 1
kamailio_check_dialog_local_enable: 1
kamailio_check_dialog_outgoing_enable: 1
kamailio_check_dialog_relay_enable: 1
kamailio_check_usrloc_regdevices_enable: 1
kamailio_check_usrloc_regusers_enable: 1
mpt_check_enable: 1
mysql_check_enable: 1
mysql_check_replication: 1
oss_check_provisioned_subscribers_enable: 1
sip_check_enable: 1
sipstats_check_num_packets: 1
sipstats_check_num_packets_perday: 1
sipstats_check_partition_size: 1
snmpd:
communities:
public:
- localhostThe following is the cleanup tools section:
cleanuptools: acc_cleanup_days: 90 archive_targetdir: '/var/backups/cdr' binlog_days: 15 cdr_archive_months: 12 cdr_backup_months: 6 cdr_backup_retro: 3 compress: gzip sql_batch: 10000 trash_cleanup_days: 30
The following is the database section:
database: bufferpoolsize: 24768M
The following is the fax server section:
faxserver:
default_owner: 4312345
failfax_recv_email: root@localhost
failfax_send_email: failfax@ngcp.sipwise.local
fax_gateways:
- sip:127.0.0.1:5070
hylafax:
jobretry: 1
start: 'yes'
iaxmodem:
start: 'yes'
type: software
mail_from: 'Sipwise NGCP FaxServer <voipfax@ngcp.sipwise.local>'
webfax_user: ngcpwebfaxThe following is the general section:
general: adminmail: adjust@example.org companyname: sipwise lang: en
The following is the heartbeat section:
heartbeat:
hb_watchdog:
action_max: 5
enable: 'yes'
interval: 10
transition_max: 10
pingnodes:
- 10.60.1.1
- 192.168.3.4The following is the legal intercept section:
intercept:
captagent:
port: 18090
schema: http
enabled: 'no'The following is the kamailio section:
kamailio:
lb:
debug: 'no'
extra_sockets: ~
max_forwards: 70
nattest_exception_ips:
- 1.2.3.4
- 5.6.7.8
pkg_mem: 16
port: 5060
security:
dos_ban_enable: 'yes'
dos_ban_time: 300
dos_reqs_density_per_unit: 50
dos_sampling_time_unit: 5
dos_whitelisted_ips: ~
dos_whitelisted_subnets: ~
failed_auth_attempts: 3
failed_auth_ban_enable: 'yes'
failed_auth_ban_time: 3600
shm_mem: 2012
start: 'yes'
strict_routing_safe: 'no'
tcp_children: 8
tcp_max_connections: 2048
tls:
enable: 'no'
port: 5061
sslcertfile: '/etc/kamailio/kamailio-selfsigned.pem'
sslcertkeyfile: '/etc/kamailio/kamailio-selfsigned.key'
udp_children: 8
use_dns_cache: 'on'
proxy:
allow_info_method: 'no'
allow_peer_relay: 'no'
allow_refer_method: 'no'
authenticate_bye: 'no'
cf_depth_limit: 10
children: 8
debug: 'no'
default_expires: 3600
enum_suffix: e164.arpa.
filter_100rel_from_supported: 'yes'
fritzbox:
enable: 'no'
prefixes:
- 112
- 110
- 118[0-9]{2}
foreign_domain_via_peer: 'no'
ignore_auth_realm: 'no'
keep_original_to: 'no'
max_expires: 43200
max_gw_lcr: 128
max_registrations_per_subscriber: 5
min_expires: 60
nathelper_dbro: 'no'
natping_interval: 30
natping_processes: 7
nonce_expire: 300
pbx:
hunt_display_indicator: '[h]'
perform_peer_lcr: 0
pkg_mem: 16
port: 5062
presence:
enable: 'yes'
proxy_lookup: 'no'
set_ruri_to_peer_auth_realm: 'no'
shm_mem: 2012
start: 'yes'
tcp_children: 4
use_enum: 'no'
usrloc_dbmode: 1The following is the mediator section:
mediator: interval: 10
The following is the nginx section:
nginx: status_port: 8081 xcap_port: 1080
The following is the ntp server section:
ntp:
servers:
- 0.debian.pool.ntp.org
- 1.debian.pool.ntp.org
- 2.debian.pool.ntp.org
- 3.debian.pool.ntp.orgThe following is the ossbss section:
ossbss:
apache:
autoprov:
certfile: '/etc/ngcp-config/ssl/myserver.crt'
certkeyfile: '/etc/ngcp-config/ssl/myserver.key'
host: localhost
port: 1444
sslcertfile: '/etc/ngcp-config/ssl/myserver.crt'
sslcertkeyfile: '/etc/ngcp-config/ssl/myserver.key'
sslclientauth: 'yes'
port: 2443
proxyluport: 1080
restapi:
sslcertfile: '/etc/ngcp-panel/api_ssl/api_ca.crt'
sslcertkeyfile: '/etc/ngcp-panel/api_ssl/api_ca.key'
serveradmin: support@sipwise.com
servername: "\"myserver\""
ssl_enable: 'yes'
sslcertfile: '/etc/ngcp-config/ssl/myserver.crt'
sslcertkeyfile: '/etc/ngcp-config/ssl/myserver.key'
frontend: fcgi
htpasswd:
-
pass: '{SHA}w4zj3mxbmynIQ1jsUEjSkN2z2pk='
user: ngcpsoap
logging:
apache:
acc:
facility: daemon
identity: oss
level: info
err:
facility: local7
level: info
ossbss:
facility: local0
identity: provisioning
level: DEBUG
web:
facility: local0
level: DEBUG
provisioning:
allow_ip_as_domain: 1
allow_numeric_usernames: 0
auto_allow_cli: 1
carrier:
account_distribution_function: roundrobin
prov_distribution_function: roundrobin
credit_warnings:
-
domain: example.com
recipients:
- nobody@example.com
threshold: 1000
faxpw_min_char: 0
log_passwords: 0
no_logline_truncate: 0
pw_min_char: 6
routing:
ac_regex: '[1-9]\d{0,4}'
cc_regex: '[1-9]\d{0,3}'
sn_regex: '[1-9]\d+'
tmpdir: '/tmp'The following is the PBX section:
pbx: bindport: 5085 enable: 'no' highport: 55000 lowport: 50001 media_processor_threads: 10 session_processor_threads: 10 xmlrpcport: 8095
The following is the prosody section:
prosody: ctrl_port: 5582 log_level: info
The following is the pushd section:
pushd:
apns:
certificate: ''
enable: 'no'
endpoint: gateway.sandbox.push.apple.com
feedback_endpoint: feedback.sandbox.push.apple.com
feedback_interval: 3600
key: ''
socket_timeout: 0
enable: 'no'
gcm:
enable: 'no'
key: ''
port: 45060
processes: 4
ssl: 'yes'
unique_device_ids: 'no'The following is the QOS section:
qos: tos_rtp: 184 tos_sip: 184
The following is the rate-o-mat section:
rateomat: enable: 'yes' loopinterval: 10 splitpeakparts: 0
The following is the redis section:
redis: database_amount: 16 port: 6379 syslog_ident: redis
The following is the reminder section:
reminder: retries: 2 retry_time: 60 sip_fromdomain: voicebox.sipwise.local sip_fromuser: reminder wait_time: 30 weekdays: '2, 3, 4, 5, 6, 7'
The following is the rsyslog section:
rsyslog:
elasticsearch:
action:
resumeretrycount: '-1'
bulkmode: 'on'
dynSearchIndex: 'on'
enable: 'yes'
queue:
dequeuebatchsize: 300
size: 5000
type: linkedlist
external_address:
external_log: 0
external_loglevel: warning
external_port: 514
external_proto: udp
ngcp_logs_preserve_days: 93The following is the rtp proxy section:
rtpproxy: allow_userspace_only: 'yes' maxport: 40000 minport: 30000 rtp_timeout: 21600 rtp_timeout_onhold: 3600
The following is the security section:
security:
firewall:
blacklist_networks_4: ~
blacklist_networks_6: ~
enable: 'yes'
sipwise_support_access: 'no'
whitelist_networks_4: ~
whitelist_networks_6: ~The following is the SEMS section:
sems:
bindport: 5080
conference:
enable: 'yes'
max_participants: 10
debug: 'no'
highport: 50000
lowport: 40001
media_processor_threads: 10
prepaid:
enable: 'yes'
sbc:
calltimer_enable: 'yes'
calltimer_max: 3600
outbound_timeout: 6000
sdp_filter:
codecs: PCMA,PCMU,telephone-event
enable: 'yes'
mode: whitelist
session_timer:
enable: 'yes'
max_timer: 7200
min_timer: 90
session_expires: 300
session_processor_threads: 10
vsc:
block_override_code: 80
cfb_code: 90
cfna_code: 93
cft_code: 92
cfu_code: 72
clir_code: 31
directed_pickup_code: 99
enable: 'yes'
park_code: 97
reminder_code: 55
speedial_code: 50
unpark_code: 98
voicemail_number: 2000
xmlrpcport: 8090The following is the sshd section:
sshd:
listen_addresses:
- 0.0.0.0The following is the voice sniffer section:
voisniff:
admin_panel: 'no'
daemon:
bpf: 'port 5060 or 5062 or ip6 proto 44 or ip[6:2] & 0x1fff != 0'
external_interfaces: 'eth0 eth1'
filter:
exclude:
-
active: 0
case_insensitive: 1
pattern: '\ncseq: *\d+ +(register|notify|options)'
include: []
internal_interfaces: lo
mysql_dump_threads: 4
start: 'no'
threads_per_interface: 10
partitions:
increment: 700000
keep: 10The following is the WEB Admin interface (www_admin) section:
www_admin:
ac_dial_prefix: 0
apache:
autoprov_port: 1444
billing_features: 1
callingcard_features: 0
callthru_features: 0
cc_dial_prefix: 00
conference_features: 1
contactmail: adjust@example.org
dashboard:
enabled: 1
default_admin_settings:
call_data: 0
is_active: 1
is_master: 0
read_only: 0
show_passwords: 1
domain:
preference_features: 1
rewrite_features: 1
vsc_features: 0
fastcgi_workers: 2
fax_features: 1
fees_csv:
element_order:
- source
- destination
- direction
- zone
- zone_detail
- onpeak_init_rate
- onpeak_init_interval
- onpeak_follow_rate
- onpeak_follow_interval
- offpeak_init_rate
- offpeak_init_interval
- offpeak_follow_rate
- offpeak_follow_interval
- use_free_time
http_admin:
autoprov_port: 1444
port: 1443
serveradmin: support@sipwise.com
servername: "\"myserver\""
ssl_enable: 'yes'
sslcertfile: '/etc/ngcp-config/ssl/myserver.crt'
sslcertkeyfile: '/etc/ngcp-config/ssl/myserver.key'
http_csc:
autoprov_bootstrap_port: 1445
autoprov_port: 1444
port: 443
serveradmin: support@sipwise.com
servername: "\"myserver\""
ssl_enable: 'yes'
sslcertfile: '/etc/ngcp-config/ssl/myserver.crt'
sslcertkeyfile: '/etc/ngcp-config/ssl/myserver.key'
logging:
apache:
acc:
facility: daemon
identity: oss
level: info
err:
facility: local7
level: info
peer:
preference_features: 1
peering_features: 1
security:
password_allow_recovery: 0
password_max_length: 40
password_min_length: 6
password_musthave_digit: 0
password_musthave_lowercase: 1
password_musthave_specialchar: 0
password_musthave_uppercase: 0
password_sip_autogenerate: 0
password_sip_expose_subadmin: 1
password_web_autogenerate: 0
password_web_expose_subadmin: 1
speed_dial_vsc_presets:
vsc:
- '*0'
- '*1'
- '*2'
- '*3'
- '*4'
- '*5'
- '*6'
- '*7'
- '*8'
- '*9'
subscriber:
auto_allow_cli: 0
extension_features: 0
voicemail_features: 1The following is the WEB Subscriber selfcare (www_csc) section:
www_csc:
ac_dial_prefix: 0
apache:
port: 443
serveradmin: support@sipwise.com
servername: myserver
ssl_enable: 'yes'
sslcertfile: '/etc/ngcp-config/ssl/myserver.crt'
sslcertkeyfile: '/etc/ngcp-config/ssl/myserver.key'
cc_dial_prefix: 00
display_account_info: 0
enable: 'no'
fastcgi_workers: 2
logging:
apache:
acc:
facility: daemon
identity: csc
level: info
err:
facility: local7
level: info
main_menu:
account: 1
addressbook: 1
callblock: 1
callforward: 1
calllist: 1
desktop: 1
device: 0
fax: 1
reminder: 1
voicebox: 1
payment_features: 0
sip_server: sip.yourdomain.tld
site_config:
company:
city: ''
email: ''
fax: ''
hotline: ''
logo: https://please.adjust.invalid/path/to/logo.gif
name: 'Your Company'
phone: ''
street: ''
webserver: ''
default_language: en
default_uri: '/desktop'
languages:
- en
- es
- fr
- de
- it
title: 'Sipwise NGCP CSC'
site_domain: sip.yourdomain.tld
tftp_server: tftp.yourdomain.tld| |  | |
 |