├── README.md ├── rdio-scanner-pi-setup └── LICENSE /README.md: -------------------------------------------------------------------------------- 1 | # Rdio Scanner on a Raspberry Pi 2 | 3 | > !!! IMPORTANT NOTICE !!! 4 | > 5 | > This installation script is no longer relevant as of [Rdio Scanner v6.0](https://github.com/chuot/rdio-scanner). 6 | > 7 | > You can now easily install your own instance of [Rdio Scanner](https://github.com/chuot/rdio-scanner) from a single executable file. Refer to the PDF document supplied with the executable at https://github.com/chuot/rdio-scanner/releases. -------------------------------------------------------------------------------- /rdio-scanner-pi-setup: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | ############################################################################### 4 | # Copyright (C) 2019-2021 Chrystian Huot 5 | # 6 | # This program is free software: you can redistribute it and/or modify 7 | # it under the terms of the GNU General Public License as published by 8 | # the Free Software Foundation, either version 3 of the License, or 9 | # (at your option) any later version. 10 | # 11 | # This program is distributed in the hope that it will be useful, 12 | # but WITHOUT ANY WARRANTY; without even the implied warranty of 13 | # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 | # GNU General Public License for more details. 15 | # 16 | # You should have received a copy of the GNU General Public License 17 | # along with this program. If not, see 18 | ############################################################################### 19 | 20 | USER=radio 21 | PASSWORD=scanner 22 | APIKEY=$(cat /proc/sys/kernel/random/uuid) 23 | 24 | TRUNKRECORDER_TAG=v3.3.7 25 | 26 | abort() { 27 | echo "Aborting!" 28 | 29 | exit 254 30 | } 31 | 32 | assert_os() { 33 | echo -n "### Checking operating system..." 34 | 35 | test -e /etc/os-release && source /etc/os-release 36 | 37 | if [ "$ID $VERSION" = "raspbian 10 (buster)" ] 38 | then 39 | echo " ok" 40 | else 41 | echo " failed" 42 | echo "" 43 | echo "This script will install all the Rdio Scanner components on a freshly installed Raspbian Buster" 44 | 45 | abort 46 | fi 47 | } 48 | 49 | assert_sudo() { 50 | echo -n "### Checking sudo capabilities..." 51 | 52 | if $(sudo -n true 2>/dev/null) 53 | then 54 | echo " ok" 55 | else 56 | echo " failed" 57 | echo "" 58 | echo "Unable to sudo without a password. Make sure that user $(whoami) has the appropriate sudoers permissions." 59 | 60 | abort 61 | fi 62 | } 63 | 64 | setup_fdkaac() { 65 | echo -n "### Checking fdkaac availability..." 66 | 67 | if [ -n "$(which fdkaac)" ] 68 | then 69 | echo " ok" 70 | else 71 | echo " installing..." 72 | 73 | test -e /usr/local/lib/libfdk-aac.a || { 74 | sudo -u $USER -i bash -c " 75 | test -d src/libfdk-aac || git clone https://github.com/mstorsjo/fdk-aac src/libfdk-aac; 76 | cd src/libfdk-aac; 77 | test -e configure || ./autogen.sh; 78 | test -e Makefile || ./configure; 79 | test -e libfdk-aac.la || make; 80 | " || abort 81 | 82 | sudo -s bash -c "cd /home/${USER}/src/libfdk-aac; make install; ldconfig" || abort 83 | } 84 | 85 | test -e /usr/local/bin/fdkaac || { 86 | sudo -u $USER -i bash -c " 87 | test -d src/fdkaac || git clone https://github.com/nu774/fdkaac.git src/fdkaac; 88 | cd src/fdkaac; 89 | test -e configure || autoreconf -i; 90 | test -e Makefile || ./configure; 91 | test -x fdkaac || make; 92 | " || abort 93 | 94 | sudo -s bash -c "cd /home/${USER}/src/fdkaac; make install" || abort 95 | } 96 | fi 97 | } 98 | 99 | setup_locale() { 100 | echo -n "### Checking system locales..." 101 | 102 | if $(grep -q "^en_US.UTF-8 UTF-8" /etc/locale.gen) 103 | then 104 | echo " ok" 105 | else 106 | echo " configuring..." 107 | 108 | sudo sed -e "s/^.*\(en_US.UTF-8 UTF-8\)$/\1/" -i /etc/locale.gen 109 | 110 | sudo locale-gen 111 | fi 112 | } 113 | 114 | setup_nginx() { 115 | echo -n "### Checking nginx availability..." 116 | 117 | if [ -d "/etc/nginx" ] 118 | then 119 | echo " ok" 120 | else 121 | echo " installing..." 122 | 123 | sudo apt install -y nginx || abort 124 | 125 | test -e /etc/nginx/sites-enabled/default && sudo rm -f /etc/nginx/sites-enabled/default 126 | 127 | sudo tee /etc/nginx/sites-available/rdio-scanner >/dev/null <<-EOT 128 | upstream rdio-scanner { 129 | server 127.0.0.1:3000; 130 | } 131 | 132 | server { 133 | listen 80 default_server; 134 | listen [::]:80 default_server; 135 | 136 | server_name _; 137 | 138 | location / { 139 | proxy_pass http://rdio-scanner; 140 | proxy_http_version 1.1; 141 | proxy_read_timeout 1d; 142 | proxy_set_header Upgrade \$http_upgrade; 143 | proxy_set_header Connection "upgrade"; 144 | proxy_set_header Host \$host; 145 | } 146 | } 147 | EOT 148 | 149 | test -L /etc/nginx/sites-enabled/rdio-scanner || sudo ln -s /etc/nginx/sites-available/rdio-scanner /etc/nginx/sites-enabled/rdio-scanner 150 | 151 | sudo systemctl restart nginx 152 | fi 153 | } 154 | 155 | setup_nodejs() { 156 | echo -n "### Checking Node.js availability..." 157 | 158 | if [ -n "$(which node 2>/dev/null)" -a "$($(which node) -v)" \> "v14" ] 159 | then 160 | echo " ok" 161 | else 162 | echo " installing..." 163 | 164 | curl -sL https://deb.nodesource.com/setup_14.x | sudo bash - 165 | 166 | sudo apt install -y nodejs 167 | fi 168 | } 169 | 170 | setup_prerequisites() { 171 | pkgs="autoconf automake build-essential cmake ffmpeg git gnuradio gnuradio-dev gr-osmosdr libboost-all-dev libcurl4-openssl-dev libhackrf-dev libssl-dev libuhd-dev pkg-config sox sqlite3" 172 | 173 | echo -n "### Checking prerequisites..." 174 | 175 | if $(LC_ALL=C dpkg-query -f '${Status}\n' -W $pkgs 2>&1 | grep -q -e 'not-installed' -e 'no packages found matching') 176 | then 177 | echo " installing..." 178 | 179 | sudo apt install -y $pkgs 180 | 181 | sudo udevadm trigger 182 | else 183 | echo " ok" 184 | fi 185 | } 186 | 187 | setup_rdio_scanner() { 188 | clone() { 189 | echo -n "### Checking Rdio Scanner..." 190 | 191 | if [ -d "/home/${USER}/rdio-scanner" ] 192 | then 193 | echo " ok" 194 | else 195 | echo " installing..." 196 | 197 | sudo -u $USER -i git clone https://github.com/chuot/rdio-scanner.git || abort 198 | fi 199 | } 200 | 201 | backend_modules() { 202 | echo -n "### Checking Rdio Scanner backend modules..." 203 | 204 | if [ -d "/home/${USER}/rdio-scanner/server/node_modules" ] 205 | then 206 | echo " ok" 207 | else 208 | echo " installing..." 209 | 210 | sudo -u $USER -i bash -c "cd rdio-scanner/server && npm i" || abort 211 | fi 212 | } 213 | 214 | frontend_modules() { 215 | echo -n "### Checking Rdio Scanner frontend modules..." 216 | 217 | if [ -d "/home/${USER}/rdio-scanner/client/node_modules" ] 218 | then 219 | echo " ok" 220 | else 221 | echo " installing..." 222 | 223 | sudo -u $USER -i bash -c "cd rdio-scanner/client && NG_CLI_ANALYTICS=ci npm i" || abort 224 | fi 225 | } 226 | 227 | config() { 228 | echo -n "### Checking Rdio Scanner config..." 229 | 230 | if [ -e "/home/${USER}/rdio-scanner/server/config.json" ] 231 | then 232 | echo " ok" 233 | else 234 | echo " configuring..." 235 | 236 | sudo -u $USER tee /home/${USER}/rdio-scanner/server/config.json >/dev/null <<-EOT 237 | { 238 | "nodejs": { 239 | "env": "production", 240 | "host": "0.0.0.0", 241 | "port": 3000 242 | }, 243 | "sequelize": { 244 | "dialect": "sqlite", 245 | "storage": "database.sqlite" 246 | }, 247 | "rdioScanner": { 248 | "access": null, 249 | "apiKeys": [ 250 | "$APIKEY" 251 | ], 252 | "pruneDays": 7, 253 | "systems": [ 254 | { 255 | "id": 11, 256 | "label": "RSP25MTL1", 257 | "talkgroups": [ 258 | { 259 | "id": 54241, 260 | "label": "TDB A1", 261 | "name": "MRC TDB Fire Alpha 1", 262 | "tag": "Fire Dispatch", 263 | "group": "Fire" 264 | }, 265 | { 266 | "id": 54242, 267 | "label": "TDB B1", 268 | "name": "MRC TDB Fire Bravo 1", 269 | "tag": "Fire Tac", 270 | "group": "Fire" 271 | }, 272 | { 273 | "id": 54243, 274 | "label": "TDB B2", 275 | "name": "MRC TDB Fire Bravo 2", 276 | "tag": "Fire Tac", 277 | "group": "Fire" 278 | }, 279 | { 280 | "id": 54248, 281 | "label": "TDB B3", 282 | "name": "MRC TDB Fire Bravo 3", 283 | "tag": "Fire Tac", 284 | "group": "Fire" 285 | }, 286 | { 287 | "id": 54251, 288 | "label": "TDB B4", 289 | "name": "MRC TDB Fire Bravo 4", 290 | "tag": "Fire Tac", 291 | "group": "Fire" 292 | }, 293 | { 294 | "id": 54261, 295 | "label": "TDB B5", 296 | "name": "MRC TDB Fire Bravo 5", 297 | "tag": "Fire Tac", 298 | "group": "Fire" 299 | }, 300 | { 301 | "id": 54244, 302 | "label": "TDB B6", 303 | "name": "MRC TDB Fire Bravo 6", 304 | "tag": "Fire Tac", 305 | "group": "Fire" 306 | }, 307 | { 308 | "id": 54129, 309 | "label": "TDB B7", 310 | "name": "MRC TDB Fire Bravo 7", 311 | "tag": "Fire Tac", 312 | "group": "Fire" 313 | }, 314 | { 315 | "id": 54125, 316 | "label": "TDB B8", 317 | "name": "MRC TDB Fire Bravo 8", 318 | "tag": "Fire Tac", 319 | "group": "Fire" 320 | }, 321 | { 322 | "id": 54005, 323 | "label": "2MT FD", 324 | "name": "MRC Deux-Montagnes Fire Dispatch", 325 | "tag": "Fire Dispatch", 326 | "group": "Fire" 327 | }, 328 | { 329 | "id": 54004, 330 | "label": "NC INC GEN", 331 | "name": "North Crown Fire General", 332 | "tag": "Fire Tac", 333 | "group": "Fire" 334 | }, 335 | { 336 | "id": 54124, 337 | "label": "BL INC GEN1", 338 | "name": "Blainville Fire General 1", 339 | "tag": "Fire Tac", 340 | "group": "Fire" 341 | }, 342 | { 343 | "id": 54239, 344 | "label": "STE-ADP FD", 345 | "name": "Ste-Anne-des-Plaines Fire Dispatch", 346 | "tag": "Fire Dispatch", 347 | "group": "Fire" 348 | }, 349 | { 350 | "id": 54200, 351 | "label": "SE INC ANN", 352 | "name": "St-Eustache Announcement", 353 | "tag": "Fire Dispatch", 354 | "group": "Fire" 355 | }, 356 | { 357 | "id": 54201, 358 | "label": "SE INC GEN", 359 | "name": "St-Eustache General", 360 | "tag": "Fire Dispatch", 361 | "group": "Fire" 362 | }, 363 | { 364 | "id": 54202, 365 | "label": "SE INC OP1", 366 | "name": "St-Eustache Operations", 367 | "tag": "Fire Tac", 368 | "group": "Fire" 369 | }, 370 | { 371 | "id": 54203, 372 | "label": "SE INC PRV", 373 | "name": "St-Eustache Prevention", 374 | "tag": "Fire Talk", 375 | "group": "Fire" 376 | }, 377 | { 378 | "id": 54206, 379 | "label": "SE CCU", 380 | "name": "St-Eustache Emergency", 381 | "tag": "Emergency Ops", 382 | "group": "Emergency" 383 | }, 384 | { 385 | "id": 56201, 386 | "label": "DSURGEN", 387 | "name": "YUL Security Dispatch", 388 | "tag": "Security", 389 | "group": "Security" 390 | }, 391 | { 392 | "id": 56202, 393 | "label": "DSURTAC", 394 | "name": "YUL Security Tactical", 395 | "tag": "Security", 396 | "group": "Security" 397 | }, 398 | { 399 | "id": 56203, 400 | "label": "DSUROP", 401 | "name": "YUL Security Operations", 402 | "tag": "Security", 403 | "group": "Security" 404 | }, 405 | { 406 | "id": 56211, 407 | "label": "DINCOPS", 408 | "name": "YUL Fire Dispatch", 409 | "tag": "Fire Dispatch", 410 | "group": "Fire" 411 | }, 412 | { 413 | "id": 56212, 414 | "label": "DINCTAC", 415 | "name": "YUL Fire Dispatch", 416 | "tag": "Fire Tac", 417 | "group": "Fire" 418 | }, 419 | { 420 | "id": 56218, 421 | "label": "DCCU", 422 | "name": "YUL CCU", 423 | "tag": "Emergency Ops", 424 | "group": "Emergency" 425 | }, 426 | { 427 | "id": 56221, 428 | "label": "DBATIM", 429 | "name": "YUL Batiment", 430 | "tag": "Utility", 431 | "group": "Utility" 432 | }, 433 | { 434 | "id": 56222, 435 | "label": "DSCHAMP", 436 | "name": "YUL SCHAMP", 437 | "tag": "Utility", 438 | "group": "Utility" 439 | }, 440 | { 441 | "id": 56223, 442 | "label": "DFOULE", 443 | "name": "YUL Foule", 444 | "tag": "Utility", 445 | "group": "Utility" 446 | }, 447 | { 448 | "id": 56224, 449 | "label": "DACCESS", 450 | "name": "YUL Access", 451 | "tag": "Utility", 452 | "group": "Utility" 453 | }, 454 | { 455 | "id": 56225, 456 | "label": "DELECTR", 457 | "name": "YUL Electricity", 458 | "tag": "Utility", 459 | "group": "Utility" 460 | }, 461 | { 462 | "id": 56226, 463 | "label": "DPISTE", 464 | "name": "YUL Piste", 465 | "tag": "Utility", 466 | "group": "Utility" 467 | }, 468 | { 469 | "id": 56227, 470 | "label": "DTABLIER", 471 | "name": "YUL Tablier", 472 | "tag": "Utility", 473 | "group": "Utility" 474 | }, 475 | { 476 | "id": 56228, 477 | "label": "DVTP", 478 | "name": "YUL VTP", 479 | "tag": "Utility", 480 | "group": "Utility" 481 | }, 482 | { 483 | "id": 56229, 484 | "label": "DPONT", 485 | "name": "YUL Pont", 486 | "tag": "Utility", 487 | "group": "Utility" 488 | }, 489 | { 490 | "id": 56232, 491 | "label": "DINSTALL", 492 | "name": "YUL Install", 493 | "tag": "Utility", 494 | "group": "Utility" 495 | }, 496 | { 497 | "id": 56204, 498 | "label": "MSURGEN", 499 | "name": "YMX Security Dispatch", 500 | "tag": "Security", 501 | "group": "Security" 502 | }, 503 | { 504 | "id": 56213, 505 | "label": "MINCOPS", 506 | "name": "YMX Fire Dispatch", 507 | "tag": "Fire Dispatch", 508 | "group": "Fire" 509 | }, 510 | { 511 | "id": 56214, 512 | "label": "MINCTAC", 513 | "name": "YMX Fire Tactical", 514 | "tag": "Fire Tac", 515 | "group": "Fire" 516 | }, 517 | { 518 | "id": 56219, 519 | "label": "MCCU", 520 | "name": "YMX CCU", 521 | "tag": "Emergency Ops", 522 | "group": "Emergency" 523 | }, 524 | { 525 | "id": 56231, 526 | "label": "MPISTE", 527 | "name": "YMX Piste", 528 | "tag": "Utility", 529 | "group": "Utility" 530 | } 531 | ], 532 | "units": [ 533 | { 534 | "id": 4424001, 535 | "label": "CAUCA" 536 | } 537 | ] 538 | }, 539 | { 540 | "id": 15, 541 | "label": "RSP25MTL5", 542 | "talkgroups": [ 543 | { 544 | "id": 54153, 545 | "label": "LA INC 1", 546 | "name": "L'Assomption Fire Dispatch", 547 | "tag": "Fire Dispatch", 548 | "group": "Fire" 549 | }, 550 | { 551 | "id": 54171, 552 | "label": "MA INC 1", 553 | "name": "Mascouche Fire Dispatch", 554 | "tag": "Fire Dispatch", 555 | "group": "Fire" 556 | }, 557 | { 558 | "id": 54141, 559 | "label": "RY INC 1", 560 | "name": "Repentigny Fire Dispatch 1", 561 | "tag": "Fire Dispatch", 562 | "group": "Fire" 563 | }, 564 | { 565 | "id": 54142, 566 | "label": "RY INC 2", 567 | "name": "Repentigny Fire Operations", 568 | "tag": "Fire Tac", 569 | "group": "Fire" 570 | }, 571 | { 572 | "id": 54143, 573 | "label": "RY INC SPE", 574 | "name": "Repentigny Fire Special", 575 | "tag": "Fire Tac", 576 | "group": "Fire" 577 | }, 578 | { 579 | "id": 54144, 580 | "label": "RY INC PRV", 581 | "name": "Repentigny Fire Prevention", 582 | "tag": "Fire Talk", 583 | "group": "Fire" 584 | }, 585 | { 586 | "id": 54145, 587 | "label": "RY CCU", 588 | "name": "Repentigny CCU", 589 | "tag": "Emergency Ops", 590 | "group": "Emergency" 591 | }, 592 | { 593 | "id": 54231, 594 | "label": "TB INC 1", 595 | "name": "Terrebonne Fire Dispatch", 596 | "tag": "Fire Dispatch", 597 | "group": "Fire" 598 | }, 599 | { 600 | "id": 54232, 601 | "label": "TB INC 2", 602 | "name": "Terrebonne Fire Operations", 603 | "tag": "Fire Tac", 604 | "group": "Fire" 605 | } 606 | ], 607 | "units": [ 608 | { 609 | "id": 4424001, 610 | "label": "CAUCA" 611 | } 612 | ] 613 | } 614 | ] 615 | } 616 | } 617 | EOT 618 | fi 619 | } 620 | 621 | build() { 622 | echo -n "### Checking Rdio Scanner frontend app..." 623 | 624 | if [ -d "/home/${USER}/rdio-scanner/client/dist" ] 625 | then 626 | echo " ok" 627 | else 628 | echo " building..." 629 | 630 | sudo -u $USER -i bash -c "cd rdio-scanner/client && npm run build" || abort 631 | fi 632 | } 633 | 634 | systemd_service() { 635 | echo -n "### Checking Rdio Scanner server systemd service..." 636 | 637 | if [ -e "/etc/systemd/system/rdio-scanner.service" ] 638 | then 639 | echo " ok" 640 | else 641 | echo " configuring..." 642 | 643 | sudo tee /etc/systemd/system/rdio-scanner.service >/dev/null <<-EOT 644 | [Unit] 645 | Description=Rdio Scanner 646 | After=network.target 647 | 648 | [Service] 649 | User=$USER 650 | Group=$USER 651 | WorkingDirectory=/home/${USER}/rdio-scanner/server 652 | ExecStart=/usr/bin/node index.js 653 | Restart=always 654 | 655 | [Install] 656 | WantedBy=multi-user.target 657 | EOT 658 | 659 | sudo systemctl daemon-reload 660 | fi 661 | } 662 | 663 | systemd_timer() { 664 | echo -n "### Checking Rdio Scanner server systemd timer..." 665 | 666 | if [ -e "/etc/systemd/system/rdio-scanner.timer" ] 667 | then 668 | echo " ok" 669 | else 670 | echo " configuring..." 671 | 672 | sudo tee /etc/systemd/system/rdio-scanner.timer >/dev/null <<-EOT 673 | [Unit] 674 | Description=Runs rdio-scanner.service 60 seconds after boot up 675 | 676 | [Timer] 677 | OnBootSec=60s 678 | Unit=rdio-scanner.service 679 | 680 | [Install] 681 | WantedBy=multi-user.target 682 | EOT 683 | 684 | sudo systemctl daemon-reload 685 | 686 | sudo systemctl enable rdio-scanner.timer 687 | fi 688 | } 689 | 690 | clone 691 | backend_modules 692 | frontend_modules 693 | config 694 | build 695 | systemd_service 696 | systemd_timer 697 | } 698 | 699 | setup_swap() { 700 | echo -n "### Checking swap size..." 701 | 702 | if [ $(free | awk '/Swap:/{ print $2 }') -ge 1048572 ] 703 | then 704 | echo " ok" 705 | else 706 | echo " resizing..." 707 | 708 | sudo dphys-swapfile swapoff 709 | 710 | sudo sed -e 's/^.*CONF_SWAPSIZE=.*$/CONF_SWAPSIZE=1024/' -i /etc/dphys-swapfile 711 | 712 | sudo dphys-swapfile setup 713 | 714 | sudo dphys-swapfile swapon 715 | fi 716 | } 717 | 718 | setup_trunk_recorder() { 719 | clone() { 720 | echo -n "### Checking Trunk Recorder..." 721 | 722 | if [ -d "/home/${USER}/src/trunk-recorder" ] 723 | then 724 | echo " ok" 725 | else 726 | echo " installing..." 727 | 728 | test -d /home/${USER}/src || sudo -u ${USER} -i mkdir src 729 | 730 | sudo -u $USER -i bash -c "cd src && git clone https://github.com/robotastic/trunk-recorder.git" || abort 731 | fi 732 | } 733 | 734 | configure() { 735 | echo -n "### Checking Trunk Recorder Makefile..." 736 | 737 | if [ -e "/home/${USER}/src/trunk-recorder/Makefile" ] 738 | then 739 | echo " ok" 740 | else 741 | echo " configuring..." 742 | sudo -u $USER -i bash -c "cd src/trunk-recorder && git checkout ${TRUNKRECORDER_TAG} && cmake ." || abort 743 | fi 744 | } 745 | 746 | build() { 747 | echo -n "### Checking Trunk Recorder build..." 748 | 749 | if [ -x "/home/${USER}/src/trunk-recorder/recorder" ] 750 | then 751 | echo " ok" 752 | else 753 | echo " compiling..." 754 | sudo -u $USER -i bash -c "cd src/trunk-recorder && make" || abort 755 | fi 756 | } 757 | 758 | install() { 759 | echo -n "### Checking Trunk Recorder installation..." 760 | 761 | if [ -e "/home/${USER}/trunk-recorder/recorder" ] 762 | then 763 | echo " ok" 764 | else 765 | echo " installing..." 766 | 767 | test -d "/home/${USER}/trunk-recorder" || sudo -u $USER -i mkdir trunk-recorder 768 | 769 | test -x "/home/${USER}/src/trunk-recorder/recorder" && sudo -u $USER -i bash -c "cp src/trunk-recorder/recorder trunk-recorder" 770 | fi 771 | } 772 | 773 | scripts() { 774 | echo -n "### Checking Trunk Recorder scripts..." 775 | 776 | if [ -d "/home/${USER}/trunk-recorder/scripts" ] 777 | then 778 | echo " ok" 779 | else 780 | echo " configuring..." 781 | 782 | sudo -u $USER -i mkdir trunk-recorder/scripts 783 | 784 | sudo -u $USER tee "/home/${USER}/trunk-recorder/scripts/upload-call" >/dev/null <<-EOT 785 | #!/bin/bash 786 | 787 | basename="\${2%.*}" 788 | 789 | curl -s http://127.0.0.1:3000/api/trunk-recorder-call-upload \\ 790 | -F "key=${APIKEY}" \\ 791 | -F "system=\${1:-0}" \\ 792 | -F "audio=@\${basename}.wav;type=audio/wav" \\ 793 | -F "meta=@\${basename}.json;type=application/json" 794 | 795 | rm -f \${basename}.* 796 | EOT 797 | 798 | sudo -u $USER -i bash -c "chmod a+x trunk-recorder/scripts/*" 799 | fi 800 | } 801 | 802 | talkgroups() { 803 | echo -n "### Checking Trunk Recorder talkgroups..." 804 | 805 | if [ -d "/home/${USER}/trunk-recorder/talkgroups" ] 806 | then 807 | echo " ok" 808 | else 809 | echo " configuring..." 810 | 811 | sudo -u $USER -i mkdir trunk-recorder/talkgroups 812 | 813 | sudo -u ${USER} tee "/home/${USER}/trunk-recorder/talkgroups/RSP25MTL1.csv" >/dev/null <<-EOT 814 | 54241,d3e1,D,ALPHA 1,MRC TDB Fire Alpha 1,Fire Dispatch,FIRE DISPATCH,1 815 | 54242,d3e2,D,BRAVO 1,MRC TDB Fire Bravo 1,Fire Tac,FIRE TAC,1 816 | 54243,d3e3,D,BRAVO 2,MRC TDB Fire Bravo 2,Fire Tac,FIRE TAC,1 817 | 54248,d3e8,D,BRAVO 3,MRC TDB Fire Bravo 3,Fire Tac,FIRE TAC,1 818 | 54251,d3eb,D,BRAVO 4,MRC TDB Fire Bravo 4,Fire Tac,FIRE TAC,1 819 | 54261,d3f5,D,BRAVO 5,MRC TDB Fire Bravo 5,Fire Tac,FIRE TAC,1 820 | 54244,d3e4,D,BRAVO 6,MRC TDB Fire Bravo 6,Fire Tac,FIRE TAC,1 821 | 54129,d371,D,BRAVO 7,MRC TDB Fire Bravo 7,Fire Tac,FIRE TAC,1 822 | 54125,d36d,D,BRAVO 8,MRC TDB Fire Bravo 8,Fire Tac,FIRE TAC,1 823 | 54005,d2f5,D,D-M FD,Deux-Montagnes Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 824 | 54239,d3df,D,SADP FD,Ste-Anne-des-Plaines Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 825 | 56201,db89,D,DSURGEN,YUL Security Dispatch,Security,SECURITY,2 826 | 56202,db8a,D,DSURTAC,YUL Security Tactical,Security,SECURITY,2 827 | 56203,db8b,D,DSUROP,YUL Security Operations,Security,SECURITY,2 828 | 56211,db93,D,DINCOPS,YUL Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 829 | 56212,db94,D,DINCTAC,YUL Tactical,Fire Tac,FIRE TAC,1 830 | 56218,db9a,D,DCCU,YUL CCU,Mesure d'urgence,EMERGENCY,3 831 | 56221,db9d,D,DBATIM,YUL Batiment,Utilities,UTILITY,3 832 | 56222,db9e,D,DSCHAMP,YUL SCHAMP,Utilities,UTILITY,3 833 | 56223,db9f,D,DFOULE,YUL Foule,Utilities,UTILITY,3 834 | 56224,dba0,D,DACCES,YUL Acces,Utilities,UTILITY,3 835 | 56225,dba1,D,DELECTR,YUL Electricity,Utilities,UTILITY,3 836 | 56226,dba2,D,DPISTE,YUL Piste,Utilities,UTILITY,3 837 | 56227,dba3,D,DTABLIER,YUL Tablier,Utilities,UTILITY,3 838 | 56228,dba4,D,DVTP,YUL VTP,Utilities,UTILITY,3 839 | 56229,dba5,D,DPONT,YUL Pont,Utilities,UTILITY,3 840 | 56232,dba8,D,DINSTALL,YUL Install,Utilities,UTILITY,3 841 | 56204,db8c,D,MSURGEN,YMX Security Dispatch,Security,SECURITY,3 842 | 56213,db95,D,MINCOPS,YMX Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 843 | 56214,db96,D,MINCTAC,YMX Fire Tactical,Fire Tac,FIRE TAC,1 844 | 56219,db9b,D,MCCU,YMX CCU,Mesure d'urgence,EMERGENCY,3 845 | 56231,dba7,D,MPISTE,YMX PISTE,Utilities,UTILITY,3 846 | EOT 847 | 848 | sudo -u ${USER} tee "/home/${USER}/trunk-recorder/talkgroups/RSP25MTL5.csv" >/dev/null <<-EOT 849 | 54153,d389,D,ASSOMP FD,L'Assomption Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 850 | 54171,d39b,D,MASCOU FD,Mascouche Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 851 | 54141,d37d,D,REPENT FD1,Repentigny Fire Dispatch 1,Fire Dispatch,FIRE DISPATCH,1 852 | 54142,d37e,D,REPENT FD2,Repentigny Fire Dispatch 2,Fire Tac,FIRE TAC,1 853 | 54143,d37f,D,REPENT FO,Repentigny Fire Operations,Fire Tac ,FIRE TAC,1 854 | 54144,d380,D,REPENT FP,Repentigny Fire Prevention,Fire Talk,FIRE TALK,1 855 | 54145,d381,D,REPENT EM,Repentigny Emergency Measure,Emergency,EMERGENCY,1 856 | 54231,d3d7,D,TERREB FD,Terrebonne Fire Dispatch,Fire Dispatch,FIRE DISPATCH,1 857 | 54232,d3d8,D,TERREB FO,Terrebonne Fire Operations,Fire Tac,FIRE TAC,1 858 | EOT 859 | 860 | sudo -u $USER -i bash -c "cd trunk-recorder; ./scripts/upload-systems" 861 | fi 862 | } 863 | 864 | config() { 865 | echo -n "### Checking Trunk Recorder configuration..." 866 | 867 | if [ -e "/home/${USER}/trunk-recorder/config.json" ] 868 | then 869 | echo " ok" 870 | else 871 | echo " configuring..." 872 | 873 | sudo -u $USER tee "/home/${USER}/trunk-recorder/config.json" >/dev/null <<-EOT 874 | { 875 | "callTimeout": 5, 876 | "captureDir": "/tmp/${USER}", 877 | "frequencyFormat": "mhz", 878 | "sources": [ 879 | { 880 | "center": 773031250, 881 | "device": "rtl=00000001", 882 | "digitalRecorders": 6, 883 | "driver": "osmosdr", 884 | "error": 0, 885 | "gain": 36.4, 886 | "rate": 2400000 887 | } 888 | ], 889 | "systems": [ 890 | { 891 | "audioArchive": false, 892 | "control_channels": [ 893 | 772031250, 894 | 772281250, 895 | 772531250, 896 | 772781250, 897 | 773281250, 898 | 773531250, 899 | 773781250, 900 | 774031250 901 | ], 902 | "hideEncrypted": true, 903 | "hideUnknownTalkgroups": true, 904 | "modulation": "qpsk", 905 | "recordUnknown": false, 906 | "shortName": "RSP25MTL1", 907 | "talkgroupsFile": "talkgroups/RSP25MTL1.csv", 908 | "type": "p25", 909 | "uploadScript": "scripts/upload-call 1" 910 | }, 911 | { 912 | "audioArchive": false, 913 | "control_channels": [ 914 | 772556250, 915 | 772306250, 916 | 772806250, 917 | 773306250, 918 | 773556250, 919 | 773806250 920 | ], 921 | "hideEncrypted": true, 922 | "hideUnknownTalkgroups": true, 923 | "modulation": "qpsk", 924 | "recordUnknown": false, 925 | "shortName": "RSP25MTL5", 926 | "talkgroupsFile": "talkgroups/RSP25MTL5.csv", 927 | "type": "p25", 928 | "uploadScript": "scripts/upload-call 5" 929 | } 930 | ], 931 | "ver": 3 932 | } 933 | EOT 934 | fi 935 | } 936 | 937 | volk_profile() { 938 | echo -n "### Checking Trunk Recorder volk profile..." 939 | 940 | if [ -e "/home/${USER}/.volk/volk_config" ] 941 | then 942 | echo " ok" 943 | else 944 | echo " configuring..." 945 | 946 | sudo -u $USER -i volk_profile 947 | fi 948 | } 949 | 950 | systemd_service() { 951 | echo -n "### Checking Trunk Recorder server systemd service..." 952 | 953 | if [ -e "/etc/systemd/system/trunk-recorder.service" ] 954 | then 955 | echo " ok" 956 | else 957 | echo " configuring..." 958 | 959 | sudo tee /etc/systemd/system/trunk-recorder.service >/dev/null <<-EOT 960 | [Unit] 961 | Description=Trunk-Recorder 962 | 963 | [Service] 964 | User=$USER 965 | Group=$USER 966 | Environment=LC_ALL=en_US.utf8 967 | WorkingDirectory=/home/${USER}/trunk-recorder 968 | ExecStart=/home/${USER}/trunk-recorder/recorder 969 | Restart=always 970 | 971 | [Install] 972 | WantedBy=multi-user.target 973 | EOT 974 | 975 | sudo systemctl daemon-reload 976 | 977 | sudo systemctl start trunk-recorder.service 978 | fi 979 | } 980 | 981 | systemd_timer() { 982 | echo -n "### Checking Trunk Recorder server systemd timer..." 983 | 984 | if [ -e "/etc/systemd/system/trunk-recorder.timer" ] 985 | then 986 | echo " ok" 987 | else 988 | echo " configuring..." 989 | 990 | sudo tee /etc/systemd/system/trunk-recorder.timer >/dev/null <<-EOT 991 | [Unit] 992 | Description=Runs trunk-recorder.service 30 seconds after boot up 993 | 994 | [Timer] 995 | OnBootSec=30s 996 | Unit=trunk-recorder.service 997 | 998 | [Install] 999 | WantedBy=multi-user.target 1000 | EOT 1001 | 1002 | sudo systemctl daemon-reload 1003 | 1004 | sudo systemctl enable trunk-recorder.timer 1005 | fi 1006 | } 1007 | 1008 | clone 1009 | configure 1010 | build 1011 | install 1012 | scripts 1013 | config 1014 | volk_profile 1015 | systemd_service 1016 | systemd_timer 1017 | } 1018 | 1019 | setup_user() { 1020 | echo -n "### Checking user \"${USER}\"..." 1021 | 1022 | if [ -n "$(id $USER 2>/dev/null)" ] 1023 | then 1024 | echo " ok" 1025 | else 1026 | echo " adding..." 1027 | 1028 | sudo useradd -G adm,audio,cdrom,dialout,games,gpio,i2c,input,netdev,plugdev,spi,sudo,users,video \ 1029 | -m -p $(echo $PASSWORD | openssl passwd -1 -stdin) -U $USER && 1030 | echo "User $USER created with default password \"${PASSWORD}\" (remember to change it)" 1031 | 1032 | echo -e "\nexport NODE_OPTIONS=--max-old-space-size=1024" | sudo tee -a "/home/${USER}/.profile" >/dev/null 1033 | 1034 | echo "$USER ALL=(ALL) NOPASSWD: ALL" | sudo tee "/etc/sudoers.d/010_${USER}-nopasswd" >/dev/null && 1035 | echo "Configure no password sudoers privileges for user $USER" 1036 | 1037 | sudo chmod 440 /etc/sudoers.d/010_${USER}-nopasswd 1038 | fi 1039 | } 1040 | 1041 | start_services() { 1042 | echo -n "### Starting services..." 1043 | 1044 | sudo systemctl start trunk-recorder.service 1045 | 1046 | sleep 10; 1047 | 1048 | sudo systemctl start rdio-scanner.service 1049 | 1050 | echo " started" 1051 | } 1052 | 1053 | deprecated() { 1054 | cat <<-EOF 1055 | !!! IMPORTANT NOTICE !!! 1056 | 1057 | This installation script is no longer relevant as of Rdio Scanner v6.0. 1058 | 1059 | You can now easily install your own instance of Rdio Scanner from a single executable file. 1060 | Refer to the PDF document supplied with the executable at https://github.com/chuot/rdio-scanner/releases. 1061 | 1062 | EOF 1063 | 1064 | exit 0 1065 | } 1066 | 1067 | deprecated 1068 | 1069 | assert_os 1070 | assert_sudo 1071 | setup_swap 1072 | setup_locale 1073 | setup_nodejs 1074 | setup_prerequisites 1075 | setup_user 1076 | setup_rdio_scanner 1077 | setup_nginx 1078 | setup_fdkaac 1079 | setup_trunk_recorder 1080 | start_services 1081 | 1082 | cat <<-EOT 1083 | ### 1084 | ### The installation is now done! 1085 | ### 1086 | ### You can access Rdio Scanner at $(ip -4 -br addr | awk '/UP/ { gsub(/\/.*/, ""); print "http://"$3}') 1087 | ### 1088 | ### Remember to change ${USER}'s password from the default, which is "${PASSWORD}" 1089 | ### 1090 | EOT 1091 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------