349

Product support

Get help in the plugin support forum.

Categories

Note: This plugin is experimental and currently in beta status. "Beta" simply means that it is still in a development phase, it is only public for reasons of testing.

With this plugin you can manage all your October websites from a single dashboard! No more logging in to client websites to see what is going on or to perform updates and install new plugins.

This plugin provides an API-client to remotely perform certain management operations on websites that have my FREE Briddle.Manager plugin installed.

Alternatively, you can install 1Pilot 's FREE Remote Manager and use their SaaS solution on 1Pilot.io, to manage all your October websites in one place. Their solution offers a lot more functionality but requires a commercial subscription ($2/site/month).

Features

As of this writing the following operations are supported:

STATUS FEATURE
YES VIEW OCTOBER VERSION
YES UPDATE OCTOBER AND ANY ACTIVE PLUGINS
YES LIST ACTIVE PLUGINS
YES INSTALL, DISABLE OR ENABLE ANY PLUGIN
YES LIST LAST 10 EVENTS IN LOG
YES EMPTY LOG
YES CHANGE THE CSS AND THE HTML LAYOUT OF THE DASHBOARD
YES PERMISSIONS

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

Like this plugin?

Did you know that only about 30% of my plugins are paid (70% of my plugins are free) and that 30% of your purchase goes to help fund the October Project? If you purchase this plugin, you can help me to develop it further, provide support for it or make new plugins.

My other plugins include:

Hello, I am Wiego Bergsma. Please start by reading the whole documentation! If you have any questions, find a bug or experience difficulties getting the plugin to work please use the Support Forum. Only leave a Review if you are happy with the plugin or are still unhappy with the plugin after reaching out to me in the Support Forum. Thank you! Wiego

This plugin functions as an API-client for websites using my Briddle.Manager plugin. It allows you to remotely perform certain management operations on your websites (all operations are limited to update and cleanup tasks). This API does not have access to content and cannot add, modify or delete content.

Installation

You need an account on octobercms.com to install this plugin.

  1. Sign in and click on the Add to Project button on the product page for the plugin in the marketplace.
  2. Select the project you wish to add the plugin to (or create one).
  3. Make sure you have attached this project to your website in the backend of your website in order to pull in the new plugin (Settings > Updates & Plugins). Don't worry, attaching or detaching your website to a project will never delete anything!

Getting started

  1. Install Briddle.Manager on all websites you want to manage from this Control Panel
  2. Go to Settings > Remote Manager > Remote Manager and enter the API-token required to allow remote systems to access the API on the websites you wish to manage
  3. Install this plugin (Briddle.Controlpanel) on the website you want to manage other sites from
  4. Go to Settings > Control Panel > Control Panel and customize the CSS or HTML for your dashboard
  5. Add the sites you want to monitor.

Javascript API-client

HTTPS is required when connecting to this API

This API-client is almost entirely coded in plain vanilla javascript. This makes it easy to port the API-client to some other system or to customize it. Data will be loaded asynchronously per site.

API security

  • This API is secured by an API-token that is set in the X-Auth-Token header (make it long).
  • Every site that uses this plugin uses it's own API-token.
  • The API-token itself is protected by requiring a HTTPS connection. Do NOT make API-requests over HTTP. Your request will return a 403 status but you will have compromised the API-token for that website!.
  • This API can not delete anything but it can disable your plugins.

Customize the HTML in the settings

You can completely change the dashboard and table layout on the plugin settings page

Main HTML:

<table class="manager">
    <thead>
        <tr>
            <th>WEBSITE</th>
            <th>CORE</th>
            <th>PLUGINS</th>
            <th>ACTION</th>
        </tr>
    </thead>
    <tbody id="data-list"></tbody>
</table>

and HTML for every row:

<tr>
    <td><a href="{link}">{name}</a></td>
    <td id="core_{id}">loading...</td>
    <td id="plugins_{id}">loading...</td>
    <td>
        <button 
            data-api-server="{url}" 
            data-api-endpoint="/api/v1/update" 
            data-api-method="POST" 
            data-update-element="core_{id}" 
            data-api-token="{token}" 
            data-confirmation="0" 
            onclick="handle(this)">UPDATE</button>
    </td>
</tr>
<tr>
    <td></td>
    <td></td>
    <td>
        <span>
            <input id="author_{id}" placeholder="Author" /> /
            <input id="plugin_{id}" placeholder="Plugin" />
            <button 
                data-api-server="{url}" 
                data-api-endpoint="/api/v1/install" 
                data-api-method="POST" 
                data-update-element="{id}" 
                data-api-token="{token}" 
                data-confirmation="0" 
                onclick="handle(this)">INSTALL</button>
        </span>
    </td>
    <td></td>
</tr>

and HTML for every list item (plugin):

<li>
    {name}
    <button 
        data-api-server="{url}" 
        data-api-endpoint="/api/v1/disable/{plugin}" 
        data-api-method="POST" 
        data-update-element="{id}" 
        data-api-token="{token}" 
        data-confirmation="1" 
        onclick="handle(this)">DISABLE</button>
</li>

Curl API-client

Because you store the sites that you manage and their tokens in the database, this plugin could also be used to handle automated requests using curl (e.g. monitor site uptime etc.) although you would need to extend this plugin yourself.

Support

Please use the Support Forum (on the left side of the page for any theme or plugin) or send me a message. I also offer design and development services. You can visit my website for more information. Do not use reviews to ask for support.

1.0.4

Better feedback for API-requests.

Sep 05, 2019

1.0.3

Some cleanup and added settings for custom CSS styling, template and layout snippets.

Sep 03, 2019

1.0.2

Created table briddle_controlpanel_sites

Sep 01, 2019

1.0.1

Initialize plugin.

Sep 01, 2019