View source for Server Manager 2 Howto incorporate a legacy contrib

From SME Server

← Server Manager 2 Howto incorporate a legacy contrib

You do not have permission to edit this page, for the following reason:

The action you have requested is limited to users in the group: Users.

You can view and copy the source of this page.

__TOC__

== Introduction ==

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

# Re-code the contrib into the Mojolicious environment in which SM2 is written.  This is documented [[Server Manager2 create panel for contrib|here]].
# 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.
# 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:<syntaxhighlight lang="shell">
/usr/share/smanager/SrvMngr/Controller
</syntaxhighlight>


Here is an example for the smeserver-userpanel contrib:<syntaxhighlight lang="perl">
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;

</syntaxhighlight>This file will need to be here:<syntaxhighlight lang="shell">
/usr/share/smanager/SrvMngr/Controller/Userpanelaccess.pm
</syntaxhighlight>
[[File:Screenshot from 2024-02-29 12-25-32.png|thumb]]
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 ==
[[File:Screenshot from 2024-02-29 12-25-15.png|thumb]]
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 {{BugzillaFileBug|product=SME%20Server%2010.x|component=server-manager|title= bugzilla}}
and select the {{#var:smecontribname}} component or use {{BugzillaFileBug|product=SME%20Server%2010.x|component=server-manager|title=this link}}

Below is an overview of the current issues for this package:{{#bugzilla:columns=id,product,version,status,summary|sort=id|order=desc|component=server-manager|noresultsmessage=No open bugs found.}}


== Changelog ==
Only released version in smeserver are listed here.

{{#smechangelog: {{#var:smecontribname}} }}


<!-- list of category you want to see this page in -->
[[Category:SME Server]][[Category:Administration]][[Category:Server Manager 2]] [[Category:SM2]] [[Category:Mojolicious]] [[Category:Developer]]

Template used on this page:

Template:BugzillaFileBug (view source)

Return to Server Manager 2 Howto incorporate a legacy contrib.

Retrieved from "https://wiki.koozali.org/Server_Manager_2_Howto_incorporate_a_legacy_contrib"

View source for Server Manager 2 Howto incorporate a legacy contrib

Navigation menu

Page actions

Page actions

Personal tools

Koozali SME Server

Recent activities

Koozali resources

Koozali SME Server wiki

Tools

Search