SlapOS Home SlapOS

    How To Configure SlapOS Master (COMP-Root)

    How To Configure SlapOS Master (COMP-Root)
    • Last Update:2022-04-25
    • Version:001
    • Language:en

    Agenda

    • Access ERP5 Interface
    • Configure Mailhost
    • Configure Slapos Master
    • Manager Certificate Authority Tools
    • Verification

    The installed SlapOS Master is actually an ERP5 instance with specific business templates providing the functionality to manage users, software releases, hosting subscriptions, usage consumption etc. It is referred to as the ERP5 Cloud Engine. For more details please refer to the slapos architecture design document and general introduction to SlapOS.

    The following steps include accessing the ERP5 cloud engine interface "underlying" SlapOS to launch the ERP5 configurator plus activating email settings and portal alarms so that the SlapOS Dashboard can work as expected.

    Prerequisites

    Access SlapOS Master ERP5 Interface

    ERP5 Interface - Login Screen

    Start by going to the URL (https://[IPv4]) provided in the past tutorial and append "/erp5/" to the URL which will take you to directly to the ERP5 interface. Login with the username and password you have received when the installation of the Master finished.

    Configure Mailhost

    Zope Interface - Configure Mailhost

    In order for regular users to use the SlapOS Dashboard, registration is necessary and requires providing an email address (for verification and account activation). This in turn mandates configuration of mailhost and site information in the ERP5 cloud engine so that emails are correctly forwarded.

    Open https://[IPv4]/erp5/MailHost/manage_main to access the mail host configuration in the Zope interface (ERP5 is built on top of Zope). Add a SMTP mailhost and login/password for the alias under which an email should be forwarded/sent. Make sure the Port is also correctly set to your email provider's correct SMTP port. Click Save changes when done to continue.

    Update Email Sender

    Zope Interface - Configure Mail Sender

    Open https://[IPv4]/erp5/manage_propertiesForm and add the fields email_from_name and email_from_address to send emails from a valid sender and reduce the chance of emails being labelled as spam. Click Save changes to continue.

    Note: the sender address must match the SMTP provider you used in the previous slide

    Launch Configurator

    ERP5 Interface - Configure Site

    Back in the erp5 interface (https://[IPv4]/erp5/) you can see that the initial ERP5 instance is almost "empty" - it only contains basic features and modules. ERP5 uses so-called business templates (bt5s) to add specific features (such as CRM, project management, etc.). Templates can be added one-by-one or in bundles for which there are various configurators. A configurator for adding the SlapOS Master business templates and upgrade this ERP5 to an ERP5 Cloud Engine has already been provided during installation. To run it, click on My Favorites and select Configure your site which will take you to the available configurators.

    Launch Configurator

    ERP5 Interface - Configurator Menu

    Only one configurator should be available. Select it by clicking Configure and confirm the installation on the subsequent screen (not pictured) by clicking "install" again.

    Configuration Progress

    ERP5 Interface - Configuration Progress

    There is a progress indicator (which does not show actual progress!) visible for the duration of the configuration. Configuring SlapOS Master may take between 15-60 minutes depending on the server being used.

    Configuration Progress

    ERP5 Interface - Configuration Finish

    The page will update once the configuration has finished. Click on Start Using your new ERP5 System. If the link takes you to the login form, there is no need to login again. Just go the homescreen of the ERP5 instance at [IPv4]/erp5/.

    Manager Certificate Authority Tools

    Zope Interface - Set SSL Directory

    As a last step the SSL Certificate Authority tools have to be linked. Head back to the Zope interface to:

    https://[IPV4]/erp5/portal_certificate_authority/manage_editCertificateAuthorityToolForm

    and set /etc/slapos-ssl/ as absolute path. (Note: When setting up SlapOS Master on webrunner, you should set the path to /srv/slapgrid/[your partition]/srv/ssl/), run $ [ -d ~/srv/ssl ] && readlink -f ~/srv/ssl to get the path

    Click save, then don't forget to head back to your terminal and restart the SlapOS Master node using:

    slapos node restart all

    It is required to flush internal caches. Wait a few seconds so ERP5 can restart before heading back to the ERP5 interface.

    Validate: SlapOS Master ERP5 Homescreen

    ERP5 Interface - Slapos Master ERP5 Homescreen

    Back on the homescreen you can see the updated number of modules available after configuration. It is beyond the scope of the SlapOS documentation to introduce the ERP5 interface. However you will be able to find many elements in the list of modules which will be used through the SlapOS Dashboard (such as Computers or Hosting Subscriptions for example). The SlapOS Dashboard is also part of ERP5 and can be found in the Web Sites module (called hostingjs).

    Note, that the zope username/password you are currently using is only meant for developing ERP5 itself. It is not an actual user account which would have an entry in the person_module. To continue, you have to create a first actual user of your SlapOS network by registering through the SlapOS Dashboard.

    Next: Create First User

    How To Create User in Slapos Master