Server Manager 2 Howto incorporate a legacy contrib

From SME Server
Revision as of 13:29, 29 February 2024 by Brianr (talk | contribs) (→‎Introduction)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

Introduction

There are 3 possibilities for incorporating an existing (legacy) contrib into Server manager 2:

  1. Re-code the contrib into the Mojolicious environment in which SM2 is written. This is documented here.
  2. Code up a "dummy" perl panel using mojolicious (see example below) which is inserted uatomatically into the menu and calls the "embedded.html.ep" template file.
  3. Just import the current contrib and access it through the "Legacy" category on the menu.

This page explains (2) and (3) in a bit more detail.

Code up a dummy page which calls the legacy panel

If you want to be able to control the position and category in the menu for the legacy contrib then you'll need to create a perl program in: the directory:

/usr/share/smanager/SrvMngr/Controller


Here is an example for the smeserver-userpanel contrib:

package SrvMngr::Controller::Userpanelaccess;

#----------------------------------------------------------------------
# heading     : User management
# description : User Panel Access
# navigation  : 2000 150
# menu        : 
#----------------------------------------------------------------------
# name   : userpanelaccess,    method : get,   url : /userpanelaccess,     ctlact : Userpanelaccess#main
#
# routes : end
#----------------------------------------------------------------------

use strict;
use warnings;

use Mojo::Base 'Mojolicious::Controller';

use Locale::gettext;
use SrvMngr::I18N;
use SrvMngr qw(theme_list init_session);

#use SrvMngr::Model::Main;


sub main {

    my $c = shift;
    $c->app->log->info($c->log_req);

    my $title = $c->l('User panel access');
    $c->stash( title => $title, modul => 'https://mailserver.bjsystems.co.uk/server-manager/cgi-bin/userpanelaccess', height => 600 );
    $c->render(template => 'embedded');

}
1;

This file will need to be here:

/usr/share/smanager/SrvMngr/Controller/Userpanelaccess.pm
Screenshot from 2024-02-29 12-25-32.png

Note the menu entries at the top, and the route specification (the capitalisation and case matching is important here)

Also note the full URL for the SM1 (legacy) contrib, and also the window length (it defaults to 600px if you do not specify).

This all that is necessary to customise the menu entry for a legacy contrib.


Just install the contribs rpm and call it from the "Legacy" category

Screenshot from 2024-02-29 12-25-15.png

Server manager 2 will scan for installed contribs, and any that are not fully compatible with Mojolicious will just load the menu entry, using the package name as a link, under the "Legacy" category, normally at the bottom of the menu stack.



The need to login into Server Manager 1

If the legacy contrib does not show after clicking on the menu entry (either for mode (2) or (3) above), then it is probably that you are not logged into SM1. This can be achieved using the button in the top border of SM2 titled "Legacy SM". You can almost certainly use the same credentials that you used to go into SM2. Unfortunately the two programs use different login mechanisms.

Bugs

Please raise bugs under the SME-Server section in bugzilla

and select the component or use this link


Below is an overview of the current issues for this package:

IDProductVersionStatusSummary (122 tasks) ⇒
12788SME Server 11.XunspecifiedIN_PROGRESSAH01215: CGI::param called in list context can lead to vulnerabilities (Persistent)
12762SME Server 11.XunspecifiedCONFIRMEDNo valid prefix found in any entries
12758SME Server 11.XunspecifiedCONFIRMEDAfter install a "signal-event smanager-refresh" is needed before SM2 comes up.
12757SME Server 11.XunspecifiedCONFIRMEDArrange that all language translations are installed with smeserver-manager
12756SME Server 11.XunspecifiedCONFIRMEDLoaded Server manager 2 shows "Sme server 2 - initial" on browser tab
12755SME Server 11.XunspecifiedCONFIRMEDSetting deltarpm parameter in SM2 dnf/yum config results on warning on dnf call
12753SME Server 11.XunspecifiedVERIFIEDInclude release number in Version of SM2 in footer.
12751SME Server 11.XunspecifiedCONFIRMEDAdd email link to action column in user accounts panel
12750SME Server 11.XunspecifiedRESOLVEDAdd EmailSettings options for uqpsmtpd, sqpsmtpd and qpsmtpd
12748SME Server 11.XunspecifiedRESOLVEDSM2 - After hitting the "save" button on a panel, then need some feedback to show it is working on the change.
12747SME Server 11.XunspecifiedCONFIRMEDSM2 - After adding a remote network network, then changing FTP settings, save gives error on empty network fields
12746SME Server 11.XunspecifiedCONFIRMEDSM2 does not seem to take the passwordStrength db property into allowance when checking passwords for users
12745SME Server 11.XunspecifiedCONFIRMEDReconfigure message stays despite post-upgrade.
12744SME Server 11.XunspecifiedIN_PROGRESSSetting webmail permissions in email panel is not correctly reflected in email front panel
12742SME Server 11.XunspecifiedRESOLVEDWebmail parameter "Save" on email panel gives "not updated"
12727SME Server 11.XunspecifiedRESOLVEDSoftware Install panel: Submit button for subservient panels centered.
12726SME Server 11.XunspecifiedCONFIRMEDSoftware Installer panel not waiting for dnf to finish and displaying log to that point.
12725SME Server 11.XunspecifiedCONFIRMEDTop message when reconfigure required not set to be translateable.
12724SME Server 11.XunspecifiedRESOLVEDBackground update using dnf does not update software in SM2 software installer panel
12718SME Server 11.XunspecifiedRESOLVEDError clicking on software manager
12714SME Server 11.XunspecifiedRESOLVEDTurkish menu missing from SM2 menu - does exist in SM1
12713SME Server 11.XunspecifiedCONFIRMEDUpdate smeserver-manager.locale with po files (for weblate import) and also fix up a few lex files
12707SME Server 11.XunspecifiedCONFIRMEDJapanese, Norwegian and Hebrew navigation files have incorrect language codes
12706SME Server 11.XunspecifiedRESOLVEDAdd flag indication of locale in header for SM2
12705SME Server 11.XunspecifiedCONFIRMEDJapanese and Romanian translations only partial - headings, but not a lot more.
12704SME Server 11.XunspecifiedCONFIRMEDHebrew translation only has "Date and Time" panel translated.
12703SME Server 11.XunspecifiedCONFIRMEDGreek user panel has tag showing.
12702SME Server 11.XunspecifiedCONFIRMEDsome translations missing Menu item translation
12701SME Server 11.XunspecifiedCONFIRMEDSome translated panels are scrambled good example is Hostnames panel
12700SME Server 11.XunspecifiedCONFIRMEDNo way of programming in the translation for a contrib menu item title to be translated
12699SME Server 11.XunspecifiedCONFIRMEDSM2 Re-configure and Reboot not translated
12696SME Server 11.XunspecifiedCONFIRMEDUncaught File 'Roboto-Regular.ttf' not found in virtual file system
12695SME Server 11.XunspecifiedCONFIRMEDcache issue
12680SME Server 11.XunspecifiedCONFIRMEDAlign "submit" button on the left consistently on initial panel for each function
12679SME Server 11.XunspecifiedVERIFIEDAdd mojolicious logo to footer
12674SME Server 11.XunspecifiedRESOLVEDAdd some margin around the table controls
12672SME Server 11.XunspecifiedCONFIRMEDSubmit (Save/Perform/etc) button on the bottom each panel is often not in the same place
12671SME Server 11.XunspecifiedRESOLVEDRemote Access form shows a empty network present - errors on save "field validation error"
12669SME Server 11.XunspecifiedCONFIRMEDAfter using dnf to update and reboot, unable to login to SM1
12667SME Server 11.XunspecifiedCONFIRMEDWorkstation restore from a removeable device fails
12666SME Server 11.XunspecifiedCONFIRMEDLegacy panels under Server Manager 2 still require login to SM1
12664SME Server 11.XunspecifiedRESOLVEDsmanager excessive logging to messages
12656SME Server 11.XunspecifiedRESOLVEDTables do not show the Datatable stuff and extra buttons
12655SME Server 11.XunspecifiedCONFIRMEDUnable to reset passwqord through "password Reset" link on login
12652SME Server 11.XunspecifiedRESOLVEDUnable to add an ibay
12645SME Server 11.XunspecifiedCONFIRMEDsmanager - Wokstation Backup - attempt verify backup fails, does not list backups
12644SME Server 11.XunspecifiedVERIFIEDsmanager - selecting workstation backup using a removeable device no devices displayed in form
12643SME Server 11.XunspecifiedRESOLVEDError message in logs on Startup 'Argument "" isn't numeric'
12641SME Server 11.XunspecifiedCONFIRMEDBackup or Restore - when selected no drop down displayed to select method
12640SME Server 11.XunspecifiedRESOLVEDAdmin User forward not displayed in user table
12608SME Server 11.XunspecifiedIN_PROGRESSAH01215: CGI::param called in list context can lead to vulnerabilities (FormMagick)
12498SME Server 11.XunspecifiedRESOLVEDRegression - menu restore does not work
12491SME Server 11.XunspecifiedCONFIRMEDMail Log analysis - qmail-q based options need to run as root or qmail
12488SME Server 11.XunspecifiedRESOLVEDLegacy contribs (ones not converted to SM2 / mojo code) are left in the menu at the end and appear in a new browser window / tab
12485SME Server 11.XunspecifiedCONFIRMEDRun the server manager perl files through the prettifier.
12484SME Server 11.XunspecifiedCONFIRMEDMake sure that the categories/sections in the menu are in the same order.
12483SME Server 11.XunspecifiedRESOLVEDhos_ERROR_CREATING_HOST on adding new hostname
12482SME Server 11.XunspecifiedCONFIRMEDMake login by ordinary user show correct menu
12480SME Server 11.XunspecifiedRESOLVEDNFR: Suppress the version number in the footer unless user logged in.
12479SME Server 11.XunspecifiedRESOLVEDClick on "add domain" and it goes to corporate DNS Settings.
12478SME Server 11.XunspecifiedRESOLVEDAfter creating I-bay it was not visible in the ibay list.
12476SME Server 11.XunspecifiedRESOLVEDRe-organise menu as per discussions on Rocket
12472SME Server 11.XunspecifiedUNCONFIRMEDSM2 XTGeoipRev=enabled != displays as ==
12471SME Server 11.XunspecifiedUNCONFIRMEDSM2 email-filtering spam settings display or change incorrectly
12467SME Server 11.XunspecifiedRESOLVEDIcon not shown when second page selected on dataTable table
12466SME Server 11.XunspecifiedRESOLVEDAdd export buttons to tables in SM2 default theme.
12465SME Server 11.XunspecifiedRESOLVEDUpdate smeserver-manager-jsquery to fix left alignment of tables
12464SME Server 11.XunspecifiedRESOLVEDServer Manager 2 needs to save and restore menu organisation
12459SME Server 11.XunspecifiedRESOLVEDCreate rpm - smeserver-manager-jquery
12458SME Server 11.XunspecifiedRESOLVEDUpdate SM2 to use jquery plugin dataTable for tables
12457SME Server 11.XunspecifiedRESOLVEDExperiment with making tables sortable and filterable and paged - using jquery.
12446SME Server 11.XunspecifiedCONFIRMEDInitial screen - immediately after install - fails to show translated message
12444SME Server 11.XunspecifiedCONFIRMEDProxy Error following software update
12442SME Server 11.XunspecifiedRESOLVEDDefault theme for SM2 submit button does not reflect hover or click
12428SME Server 11.XunspecifiedRESOLVEDSM2 Login button does not highlight when you press it. - default Theme
12392SME Server 10.X10.1VERIFIEDDomains panel does not show borders around table of domains
12387SME Server 11.XunspecifiedRESOLVEDServer Manager 2 should open unconverted contribs/panels in the current page, possibly within an iframe
12245SME Server 11.XunspecifiedCONFIRMEDMenu formatting with Server Manager 2 and AdminLTE
12209SME Server 10.X10.0VERIFIEDOnly show Reconfigure button and message after an update if UnsavedChanges='yes'
12111SME Server 11.XunspecifiedRESOLVEDuntainting server-manager2
11989SME Server 11.XunspecifiedRESOLVEDRollup changes including AdminLTE 3.1
11906SME Server 11.XunspecifiedRESOLVEDSort out spacing in menu when small fonts selected
11881SME Server 11.XunspecifiedRESOLVEDBrowser Error in js for AdminLTE version extraction
11880SME Server 11.XunspecifiedRESOLVEDBrowser error on non login pages (smeserver-manager-AdminLTE)
11863SME Server 11.XunspecifiedRESOLVEDUpdate css and checkbox for dark mode
11846SME Server 11.XunspecifiedRESOLVEDWarning from Browser when jquery loaded - unable to find .map file
11833SME Server 11.XunspecifiedRESOLVEDMore formatting
11830SME Server 11.XunspecifiedRESOLVEDUpdate Datetime and reboot ep files to help AdminLTE
11827SME Server 10.X10.0VERIFIEDFix format of datetime panel
11826SME Server 11.XunspecifiedRESOLVEDMore format changes to make it compatible
11825SME Server 11.XunspecifiedRESOLVEDReview configuration panel - In Server-Gateway, External IP and DHCP range not properly displayed
11824SME Server 11.XunspecifiedRESOLVEDUser and Hostnames list does not act responsivly as window is made smaller
11823SME Server 11.XunspecifiedRESOLVEDIn Review Configuration - IP address not show correctly for Server Gateway
11822SME Server 11.XunspecifiedRESOLVEDIn Review Configuration virtual domains not aligned.
11821SME Server 11.XunspecifiedRESOLVEDMail log file analysis shows blank
11817SME Server 11.XunspecifiedCONFIRMEDGet Breadcrumb trail working
11815SME Server 11.XunspecifiedRESOLVEDBring Group add and update panels into line with others
11810SME Server 11.XunspecifiedCONFIRMEDLicense panel is left truncated, does not flow.
11809SME Server 11.XunspecifiedCONFIRMEDLack of a space after full stop and comma in English version of Server Manager2 panel descriptions in some places.
11793SME Server 11.XunspecifiedRESOLVEDFor smeserver-manager - add module class to div id="module"
Warnings were generated during the execution of function
  1. Report truncated - count greater than max allowed 101 > 100


Changelog

Only released version in smeserver are listed here.

Retrieved from "https://wiki.koozali.org/index.php?title=Server_Manager_2_Howto_incorporate_a_legacy_contrib&oldid=42561"