Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: updated @ 2023-08-09T11:09:28.285735
HTML
headtrue
encodingUTF-8
<!DOCTYPE html
  SYSTEM "about:legacy-compat">
<html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="UTF-8"><meta name="copyright" content="(C) Copyright 2023"><meta name="DC.rights.owner" content="(C) Copyright 2023"><meta name="DC.type" content="topic"><meta name="prodname" content="For Mediatrix Sentinel Units"><meta name="version" content="DGW 49.12.28842941"><meta name="DC.date.modified" content="2023-0308-2809"><meta name="DC.date.issued" content="2023-0308-2809"><meta name="DC.date.available" content="2023-0308-2809"><meta name="ChapterNumbering" content="no"><meta name="DC.format" content="HTML5"><meta name="DC.identifier" content="topic_title_Virtual_Machine__VM__Installation_d1e13"><link href="https://fonts.googleapis.com/css?family=Open+Sans" rel="stylesheet"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/45482024/commonltr.css"><link rel="stylesheet" type="text/css" href="https://documentation.media5corp.com/download/attachments/45482024/custom.css"><title>Installing a FreePBX Virtual Machine</title></head><body class="nobody"><header role="banner"><div class="topicmeta title">Installing a FreePBX Virtual Machine</div><div class="topicmeta date">2023-0308-28<09</div><div class="topicmeta product">For Mediatrix Sentinel Units </div><div class="topicmeta version">DGW 49.12.2884<2941</div><div class="topicmeta pdf"><a href="https://documentation.media5corp.com/download/attachments/45482024/Installing%20a%20FreePBX%20Virtual%20Machine.pdf" rel="nofollow">Download PDF Document</a></div><hr><span style="float: inline-end;"></span></header><nav role="toc"><ul><li><a href="#topic_title_Virtual_Machine__VM__Installation_d1e13">Virtual Machine (VM) Installation</a><ul><li><a href="#reference_apw_54c_ss">Important Information Before you Start</a></li><li><a href="#task_d2r_2yk_ls">Installing the FreePBX on the Virtual Machine </a></li><li><a href="#task_z5n_dnz_lv">Disabling Swap on Linux</a></li></ul></li><li><a href="#reference_j4g_nbv_gfb">Online Help</a></li><li><a href="#concept_v4k_q3h_1r">DGW Documentation</a></li><li><a href="#concept_fqm_rv4_k4">Copyright Notice</a></li></ul></nav><main role="main"><article role="article" aria-labelledby="ariaid-title1"><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="nested0" aria-labelledby="ariaid-title1" id="topic_title_Virtual_Machine__VM__Installation_d1e13">
   <h1 class="title topictitle1" id="ariaid-title1">Virtual Machine (VM) Installation</h1>
<article class="topic reference nested1" aria-labelledby="ariaid-title2" id="reference_apw_54c_ss">
  <h2 class="title topictitle2" id="ariaid-title2">Important Information Before you Start</h2>
  <div class="body refbody">
    <section class="section">Before proceeding with the FreePBX installation on the VM, please make sure you have
      uploaded the iso image or you have a bootable USB with the image, and that you have followed
      one of these documentations. This technical bulletin assumes that you have successfully
      completed one of the following docs.</section>
    <section class="section">
      <ul class="ul" id="reference_apw_54c_ss__ul_hnx_qkn_cv_22">
        <li class="li"><a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Installing+a+Virtual+Machine+Using+an+ISO+Image" target="_blank">Installing a Virtual Machine Using an ISO Image</a>
        </li>
        <li class="li"><a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Installing+a+Virtual+Machine+Using+a+USB+External+Device" target="_blank">Installing a Virtual Machine Using a USB External
            Device</a>
        </li>    
      </ul>
    </section>
    <section class="section">
      Once the installation is completed, do not forget to monitor the lifespan of the SSD and disable the swap on Linux.
      <ul class="ul" id="reference_apw_54c_ss__ul_hnx_qkn_cv_45">
        <li class="li"><a class="xref" href="https://documentation.media5corp.com/display/DGWLATEST/Monitoring+the+Lifespan+of+an+SSD" target="_blank">Monitoring lifespan of an SSD</a>
        </li>
      </ul>
    </section>
    <section class="section">The technical bulletin has been created using a Sentinel400 with 2GB RAM and 16GB SDD
      on version Dgw 44.0.1535. The FreePBX version is Sangoma 7. The iso used is:
      <em class="ph i">SNG7-FPBX-64bit-1805-2.iso</em>.</section> 
  </div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title3" id="task_d2r_2yk_ls">
    <h2 class="title topictitle2" id="ariaid-title3">Installing the FreePBX on the Virtual Machine </h2>
    <div class="body taskbody">
          <section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
                <span class="ph cmd">When the <span class="keyword wintitle">VM</span> is first
                    created, it is in the <span class="keyword wintitle">Stopped</span> state.<br><img class="image" id="task_d2r_2yk_ls__image_zh5_lrw_4hb1_1" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_stop_state.PNG" width="800"><br>
                </span>
                <div class="itemgroup info"> 
                    <ul class="ul" id="task_d2r_2yk_ls__ul_hnx_qkn_cv_2">
                        <li class="li">Set the VNC ID accordingly (you can leave it to 0)</li>
                        <li class="li">Set <span class="keyword wintitle">Usb</span> to
                                <span class="keyword wintitle">All</span>.</li>
                        <li class="li">Set <span class="keyword wintitle">Startup</span> to
                                <span class="keyword wintitle">Auto</span> if
                            you want to start up the VM as soon as the Sentinel is restarted.</li>
                        <li class="li">Click <span class="keyword wintitle">Play</span> to start the VM</li>
                    </ul>
                </div>   
            </li><li class="li step stepexpand">
                <span class="ph cmd"> Connect using VNC client to the IP address of the network port with virtual
                    switch enabled. <br><img class="image" id="task_d2r_2yk_ls__image_lhp_htw_4hb2" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step2.PNG" width="800"><br></span>
                <div class="itemgroup info"> 
                    <ul class="ul" id="task_d2r_2yk_ls__ul_hnx_qkn_cv_3">
                        <li class="li">There are 2 options to perform the installation, step-by-step or fully
                            automated. In case you select<span class="keyword wintitle"> Fully Automatic</span>, the
                            root password is set to
                            <span class="keyword wintitle">SangomaDefaultPassword</span>.</li>
                        <li class="li">Supported VNC Clients are: VNC for Chrome, UltraVNC, TightVNC, VNC
                            Viewer.</li>
                    </ul>
                    <div class="note note note_note"><span class="note__title">Note:</span> DO NOT select output to SERIAL, as it will not display anything on the VNC Viewer. </div>
                </div> 
                
            </li><li class="li step stepexpand">
                <span class="ph cmd"> Start the installation step by step by selecting the FreePBX standard
                    installation: <br><img class="image" id="task_d2r_2yk_ls__image_lhp_htw_5hb3" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step2-1.PNG" width="800"><br></span>
            </li><li class="li step stepexpand">
                <span class="ph cmd"> Once the installer is launched, if you selected step by step, you will need to
                    connect to a new vnc client to start the installation<br><img class="image" id="task_d2r_2yk_ls__image_lhp_htw_6hb4" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step3.PNG" width="800"><br></span>
            </li><li class="li step stepexpand">
                <span class="ph cmd"> The installation will automatically start, and you will have to configure the ROOT password.
                    <br><img class="image" id="task_d2r_2yk_ls__image_lhp_htw_7hb5" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step5.PNG" width="800"><br></span>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Once the installation is completed, in case you have chosen step by step
                    installation, you will be prompt with the reboot screen. In this case the
                    installation took more than 60 minutes. <br><img class="image" id="task_d2r_2yk_ls__image_lhp_htw_8hb6" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step6.PNG" width="800"><br></span>
            </li><li class="li step stepexpand">
                <span class="ph cmd">After reboot, you should be able to see the installation information on the VNC
                    client. This is the same screen if you choosed the fully automated installation
                    after login as root.                 
                   <br><img class="image" id="task_d2r_2yk_ls__image_u2t_ghc_s2s7" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step7.PNG" width="800"><br></span>
            </li><li class="li step stepexpand">

                <span class="ph cmd">Follow the on-screen instructions for the initial login and the FreePBX Web
                    interface will appear. You will need to create a new user and password. After
                    creating the user, you will be prompted to the main FreePBX screen. <a name="fnsrc_1" href="#fntarg_1"><sup>1</sup></a>
                    <br><img class="image" id="task_d2r_2yk_ls__image_u2t_ghc_s4s9" src="https://documentation.media5corp.com/download/attachments/45482024/VM_FreePBX_Installation_step9.PNG" width="800"><br>
                </span>
            </li></ol></section>
    </div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic task nested1" aria-labelledby="ariaid-title4" id="task_z5n_dnz_lv">
    <h2 class="title topictitle2" id="ariaid-title4">Disabling Swap on Linux</h2>
    <div class="body taskbody">
        <section class="section context"><div class="tasklabel"><strong class="sectiontitle tasklabel">Context</strong></div>Disabling swapping in the Operating System will optimise the virtual machine in
            such a way to reduce the wear-and-tear of the Solid State Drive.<div class="note note note_note"><span class="note__title">Note:</span> If the
                Solid State Drive fails because it is inadequately used by a third-party software or
                the operating system, the warranty of the Mediatrix unit will no longer be
                valid.</div></section>
        <section><div class="tasklabel"><strong class="sectiontitle tasklabel">Steps</strong></div><ol class="ol steps"><li class="li step stepexpand">
                <span class="ph cmd">Open the VNC Client located on a computer of the network connected to the
                    unit.</span>
                <div class="itemgroup info">
                    <div class="note note note_note"><span class="note__title">Note:</span> UltraVNC Viewer, TightVNC Viewer and VNC Viewer are presently
                        supported.</div>
                </div>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Open .../etc/sysctl.conf file</span>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Add vm.swappiness = 0 to the file.</span>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Open ... /etc/fstab.</span>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Add noatime to the following lines</span>
                <ol type="a" class="ol substeps" id="task_z5n_dnz_lv__substeps_yh3_hnz_lv">
                    <li class="li substep">
                        <span class="ph cmd">§ UUID=32b414c0-This-is-an-example / ext4 defaults, noatime 1 1</span>
                    </li>
                    <li class="li substep">
                        <span class="ph cmd">§ UUID=b4598e44-This-is-an-example /boot ext4 defaults, noatime 1
                            2</span>
                    </li>
                </ol>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Comment out</span>
                <ol type="a" class="ol substeps" id="task_z5n_dnz_lv__substeps_g5w_3nz_lv">
                    <li class="li substep">
                        <span class="ph cmd">§ # UUID=72355f7a-497d-This-is-an-example swap swap defaults 0 0</span>
                    </li>
                </ol>
            </li><li class="li step stepexpand">
                <span class="ph cmd">Use the Shutdown command and then restart the Virtual Machine.</span>
                <div class="itemgroup info">
                    <div class="note important note_important"><span class="note__title">IMPORTANT:</span> Do no use the Linux <span class="keyword cmdname">reboot</span> command as
                        the filesystem may not get mounted properly.</div>
                </div>
            </li></ol></section>
    </div>
</article></article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic reference nested0" aria-labelledby="ariaid-title5" id="reference_j4g_nbv_gfb">
  <h1 class="title topictitle1" id="ariaid-title5">Online Help</h1>
  <p class="shortdesc"><span class="ph">If you are not familiar with the meaning of the fields and
                buttons, click <span class="keyword wintitle">Show Help</span>, located at the upper right corner of
                the Web page. When activated, the fields and buttons that offer online help will
                change to green and if you hover over them, the description will bedisplayed.</span></p>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title6" id="concept_v4k_q3h_1r">
 <h1 class="title topictitle1" id="ariaid-title6">DGW Documentation</h1>
 
 <div class="body conbody"><p class="shortdesc">Mediatrix devices are supplied with an exhaustive set of documentation. </p>
  <p class="p">Mediatrix user documentation is available on the <a class="xref" href="http://documentation.media5corp.com" target="_blank">Media5 Documentation
    Portal</a>.</p>
  <div class="p">Several types of documents were created to clearly present the information you are looking for.
   Our documentation includes:<ul class="ul" id="concept_v4k_q3h_1r__ul_bqy_cjh_1r">
    <li class="li"><strong class="ph b">Release notes</strong>: Generated at each GA release, this document includes the known and
     solved issues of the software. It also outlines the changes and the new features the release
     includes.</li>
    <li class="li"><strong class="ph b">Configuration notes</strong>: These documents are created to facilitate the configuration of a
     specific use case. They address a configuration aspect we consider that most users will need to
     perform. However, in some cases, a configuration note is created after receiving a question
     from a customer. They provide standard step-by-step procedures detailing the values of the
     parameters to use. They provide a means of validation and present some conceptual information.
     The configuration notes are specifically created to guide the user through an aspect of the
     configuration. </li>
    <li class="li"><strong class="ph b">Technical bulletins</strong>: These documents are created to facilitate the configuration of a
     specific technical action, such as performing a firmware upgrade.</li>
    <li class="li"><strong class="ph b">Hardware installation guide</strong>: They provide the detailed procedure on how to safely and
     adequately install the unit. It provides information on card installation, cable connections,
     and how to access for the first time the Management interface.</li>
    <li class="li"><strong class="ph b">User guide</strong>: The user guide explains how to customise to your needs the configuration
     of the unit. Although this document is task oriented, it provides conceptual information to
     help the user understand the purpose and impact of each task. The User Guide will provide
     information such as where and how TR-069 can be configured in the Management Interface, how to
     set firewalls, or how to use the CLI to configure parameters that are not available in the
     Management Interface.</li>
    <li class="li"><strong class="ph b">Reference guide</strong>: This exhaustive document has been created for advanced users. It
     includes a description of all the parameters used by all the services of the Mediatrix units.
     You will find, for example, scripts to configure a specific parameter, notification messages
     sent by a service, or an action description used to create Rulesets. This document includes
     reference information such as a dictionary, and it does not include any step-by-step
     procedures. </li>
   </ul></div>
 </div>
</article><hr><span style="float: inline-end;"><a href="#">Top</a></span><article class="topic concept nested0" aria-labelledby="ariaid-title7" id="concept_fqm_rv4_k4">
 <h1 class="title topictitle1" id="ariaid-title7">Copyright Notice</h1>
 

 <div class="body conbody"><p class="shortdesc">Copyright © 2023 Media5 Corporation.</p>
  <p class="p">This document contains information that is proprietary to Media5 Corporation.</p>
  <p class="p">Media5 Corporation reserves all rights to this document as well as to the Intellectual Property
   of the document and the technology and know-how that it includes and represents.</p>
  <p class="p">This publication cannot be reproduced, neither in whole nor in part, in any form whatsoever,
   without written prior approval by Media5 Corporation.</p>
  <p class="p">Media5 Corporation reserves the right to revise this publication and make changes at any time
   and without the obligation to notify any person and/or entity of such revisions and/or
   changes.</p>
 </div>
</article><div class="fn"><a name="fntarg_1" href="#fnsrc_1"><sup>1</sup></a>  At this
                        point installation is completed. Please proceed with disabling swap on Linux
                        to prolong the lifespan of the SSD.</div></article></main></body></html>