Marown/swad-core
Marown
/
swad-core
mirror of https://github.com/acanas/swad-core.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

New article created

Antonio Cañas Vargas 2023-04-20 17:30:03 +02:00
parent 1234cfb43f
commit 30dd3b5b24
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
SYSTEM.Plugins.en.md Normal file

@ -0,0 +1,25 @@
[**English**](SYSTEM.Plugins.en) | [Spanish](SYSTEM.Plugins.es)
# Plugins
The **SYSTEM > Plugins** option lists the add-ons or plugins. A plugin is a program external to the platform, which interacts with the platform to offer some functionality that the main kernel does not provide. Plugins interact with the SWAD core through a web service with various operations or functions. A web service is a software system that allows interaction between two computers connected to the Internet. In our case, SWAD is the server or host that offers the web service, and the plugin is the client that requests one or more functions of the web service.
There are two possible ways to access a SWAD plugin:
* **Directly from the external application**. The user logs in directly through a form in the external application. The external application calls SWAD.
* **From SWAD**. The user logs into SWAD. SWAD provides a list of available plugins under the **SYSTEM > Plugins** option. When the user clicks a link to a plugin, the web address resulting from concatenating that plugin's URL with the current session identifier is used. For example, if the URL specified in the plugin is https://my.url.com/index.php?mode=session&id= and the session id is cY_kAutNT5HzF3MbflcuXgXFlv00Wmqq9QKeD1aaaRc, clicking the plugin will call the following address: https://my.url.com/index.php?mode=session&id=cY_kAutNT5HzF3MbflcuXgXFlv00Wmqq9QKeD1aaaRc. The external application will then call SWAD.
## Edit
System administrators can edit plugins by clicking the _Edit_ (pencil) icon in the upper left corner of the box.
When you click on _Edit_ a **Plugins** box appears that contains:
* A first box that allows you to **create a new plugin** by filling in the following columns and clicking on the _Create plugin_ button:
* **Name**. The name of the plugin.
* **Description**. A description of the plugin.
* **Logo**. A representative image of the plugin.
* **Application Key**. Each external application needs to provide an app key of that application when connecting to SWAD.
* **URL**. URL that is called by SWAD in the case of accessing the plugin from the platform.
* **IP**. IP address from which plugins called from SWAD can be executed.
* A list that allows **editing existing plugins**. It is possible to change any of the six columns above.
To **remove** a plugin, click the _Remove_ (red trash can) icon. Confirmation is not requested.