Table of Contents

The Portal plugin is installed by default, but may need to be installed for addon companies.

Installing Portal

  1. Visit [Settings] > [Company] > [Plugins] > Available.
  2.  Click the "Install" button within the Portal plugin listing.

Changing the Portal

 To change the portal content, visit [Settings] > [Company] > Plugins and click the "Manage" button for the Portal plugin. As of 5.5, portal content can be defined in multiple languages.

Index Template

The plugin comes default with one page, the index page. This is the page displayed when visiting the location of your Blesta installation within your browser. 

Tags

The index page supports the following tags:

TagsDescriptionNotes
{base_url}This is the company hostnamee.g. https://yourdomain.com/
{blesta_url}This is the URL to your Blesta installatione.g. https://yourdomain.com/billing/
{admin_url}This is the URL to the admin interface of your Blesta installatione.g. https://yourdomain.com/billing/admin/
{client_url}This is the URL to the client interface of your Blesta installatione.g. https://yourdomain.com/billing/client/
{plugins}This is an array of installed plugins with several other propertiesThis tag should not be used directly. Only use properties of this tag, e.g. "{plugins.billing_overview.name}"



The {plugins} tag contains a list of installed plugins where each key in the array is the plugin directory of a unique plugin installed for this company, such as "billing_overview", "feed_reader", "download_manager", etc.

The following is a dump detailing the structure of the fields the {plugins} tag may contain:

{plugins} contents
Array
(
    [billing_overview] => stdClass Object
        (
            [id] => 13
            [dir] => billing_overview
            [company_id] => 1
            [name] => Billing at a Glance
            [version] => 1.0.0
            [installed_version] => 1.0.0
            [authors] => Array
                (
                    [0] => Array
                        (
                            [name] => Phillips Data, Inc.
                            [url] => http://www.blesta.com
                        )
                )
            [logo] => /plugins/billing_overview/views/default/images/logo.png
            [installed] => 1
            [manageable] => 
        )
	[feed_reader] => stdClass Object
        (
            [id] => 56
            [dir] => feed_reader
            [company_id] => 1
            [name] => Feed Reader
            [version] => 1.0.1
            [installed_version] => 1.0.0
            [authors] => Array
                (
                    [0] => Array
                        (
                            [name] => Phillips Data, Inc.
                            [url] => http://www.blesta.com
                        )
                )
            [logo] => /plugins/feed_reader/views/default/images/logo.png
            [installed] => 1
            [manageable] => 1
        )
)

Default Portal Markup

If you need to restore the default HTML that is included for the portal, you can copy/paste it from below to Settings > Company > Plugins > Portal: Manage

Portal Code
    <div class="col-md-12">
        <div class="thanks">
            <blockquote>
                <h4>Thank you for installing Blesta!</h4>
                <p>This is your client portal page, and you may wish to link here from your website. This message can be removed through the staff area under Settings > Plugins > Portal: Manage.</p>
                <p>
                    <ul>
                        <li>You may log into the staff area at <a href="{admin_url}">{admin_url}login/</a>.</li>
                        <li>Clients may login to the client area at <a href="{client_url}">{client_url}login/</a>.</li>
                    </ul>
                </p>
                <p>We hope you enjoy using Blesta! For help, please see the <a href="http://docs.blesta.com">documentation</a> or visit us on our <a href="http://www.blesta.com/forums/">forums</a>.</p>
            </blockquote>
        </div>
    </div>
    <div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}login/">
            <div class="card">
                <div class="card-body">
                    <i class="fas fa-cogs fa-4x"></i>
                    <h4>My Account</h4>
                    <p>Have an account with us? Log in here to manage your account.</p>
                </div>
            </div>
        </a>
    </div>
    {% if plugins.support_manager.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/support_manager/client_tickets/add/">
            <div class="card">
                <div class="card-body">
                    <i class="fas fa-ticket-alt fa-4x"></i>
                    <h4>Support</h4>
                    <p>Looking for help? You can open a trouble ticket here.</p>
                </div>
            </div>
        </a>
    </div>
	<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/support_manager/knowledgebase/">
            <div class="card">
                <div class="card-body">
                    <i class="fas fa-info-circle fa-4x"></i>
                    <h4>Knowledge Base</h4>
                    <p>Have a question? Search the knowledge base for an answer.</p>
                </div>
            </div>
        </a>
    </div>{% endif %}
    {% if plugins.order.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{blesta_url}order/">
            <div class="card">
                <div class="card-body">
                    <i class="fas fa-shopping-cart fa-4x"></i>
                    <h4>Order</h4>
                    <p>Visit the order form to sign up and purchase new products and services.</p>
                </div>
            </div>
        </a>
    </div>{% endif %}
    {% if plugins.download_manager.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/download_manager/">
            <div class="card">
                <div class="card-body">
                    <i class="fas fa-download fa-4x"></i>
                    <h4>Download</h4>
                    <p>You may need to be logged in to access certain downloads here.</p>
                </div>
            </div>
        </a>
    </div>{% endif %}
Portal Code
    <div class="col-md-12">
        <div class="thanks">
            <blockquote>
                <h4>Thank you for installing Blesta!</h4>
                <p>This is your client portal page, and you may wish to link here from your website. This message can be removed through the staff area under Settings > Plugins > Portal: Manage.</p>
                <p>
                    <ul>
                        <li>You may log into the staff area at <a href="{admin_url}">{admin_url}login/</a>.</li>
                        <li>Clients may login to the client area at <a href="{client_url}">{client_url}login/</a>.</li>
                    </ul>
                </p>
                <p>We hope you enjoy using Blesta! For help, please see the <a href="http://docs.blesta.com">documentation</a> or visit us on our <a href="http://www.blesta.com/forums/">forums</a>.</p>
            </blockquote>
        </div>
    </div>
    <div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}login/">
            <div class="well">
                <i class="fa fa-cogs fa-4x"></i>
                <h4>My Account</h4>
                <p>Have an account with us? Log in here to manage your account.</p>
            </div>
        </a>
    </div>
    {% if plugins.support_manager.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/support_manager/client_tickets/add/">
            <div class="well">
                <i class="fa fa-ticket fa-4x"></i>
                <h4>Support</h4>
                <p>Looking for help? You can open a trouble ticket here.</p>
            </div>
        </a>
    </div>
	<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/support_manager/knowledgebase/">
            <div class="well">
                <i class="fa fa-info fa-4x"></i>
                <h4>Knowledge Base</h4>
                <p>Have a question? Search the knowledge base for an answer.</p>
            </div>
        </a>
    </div>{% endif %}
    {% if plugins.order.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{blesta_url}order/">
            <div class="well">
                <i class="fa fa-shopping-cart fa-4x"></i>
                <h4>Order</h4>
                <p>Visit the order form to sign up and purchase new products and services.</p>
            </div>
        </a>
    </div>{% endif %}
    {% if plugins.download_manager.enabled %}<div class="col-md-4 col-sm-6 portal-box">
        <a href="{client_url}plugin/download_manager/">
            <div class="well">
                <i class="fa fa-download fa-4x"></i>
                <h4>Download</h4>
                <p>You may need to be logged in to access certain downloads here.</p>
            </div>
        </a>
    </div>{% endif %}


  • No labels

2 Comments

  1. Anonymous

    Which CMS does it plug in to?

  2. Anonymous

    This is a CMS itself, it's going to be expanding.