Registration and Management

Guide on how to register and manage developed plugins in BioStar X Service Manager.

Preparations before registration

1. Run Plugin Server

   The plugin server must be running before registering the plugin. BioStar X checks the accessibility of the plugin server during the registration process.

2. Check Network Access

   Ensure that the BioStar X server can access the plugin server.

   # Test from BioStar X Server
   curl -H "X-BioStar-Ping: test123" http://localhost:8000/bsx

Register plugin

1. Click Start → BioStar X → BioStar X Service Manager on Windows.

2. Click PLUGINS in the left side menu.

3. Click the Add Plugin button in the upper right.

   

4. Enter plugin information on the Add New Plugin screen.

   

5. Enter plugin information and click Apply to complete registration.

Info

If you have activated Session Bridge, you can download the certificate at the bottom of the screen. The certificate is required for secure communication between BioStar X and the plugin. If you lose the certificate, you can download it again. At this time, the existing certificate will be invalidated.

Enter plugin information

• Plugin Name: Enter the name of the plugin. You can enter up to 48 characters. You cannot use the same name as an existing registered plugin.

• Description: Enter a description of the plugin. You can enter up to 500 characters.

• Plugin Address: Enter the address of the plugin. It must be a valid URL starting with http:// or https://, and you cannot use the same address as an existing registered plugin.

• Plugin Icon: Upload the plugin's icon.

  • Supported formats are JPEG, PNG, SVG, GIF.

  • The maximum file size is 1MB, and 0KB empty files cannot be uploaded.

  • Uploaded images will be automatically resized to 104×104 pixels.

• Session Bridge: Activate to use the session bridge. Using this feature automatically inherits permissions for BioStar X users, so no separate login is required when accessing the plugin.

Info

• If you do not upload an icon, an icon will be generated automatically from the first letter of the plugin name. The uploaded icon can be deleted by clicking the button, and it will be replaced with the automatically generated icon upon deletion.

• Once Session Bridge is activated, it cannot be deactivated, and the plugin address cannot be changed for security reasons.

Check on the launcher screen

You can see the added plugins on the Launcher screen of BioStar X.

Plugin management

You can manage the plugins installed through BioStar X Service Manager.

Click Start → BioStar X → BioStar X Service Manager on Windows. Click PLUGINS in the site menu of the BioStar X Service Manager screen.

Check plugin list

You can see all the plugins registered by the user.

Edit plugin

Click the plugin you want to edit from the plugin list. The plugin information edit screen appears. You can edit the plugin name (Plugin Name), description (Description), and icon (Plugin Icon).

Info

Plugin Address cannot be edited when Session Bridge is enabled.

Delete plugin

1. Select the plugin to delete by clicking the checkbox on the far left of the plugin list.

2. Click the Delete button in the upper right corner of the screen.

3. When the confirmation message appears, click OK.

Info

• Plugins added with attendance management licenses cannot be deleted.

• The attendance management plugin can be used through additional options in the Advanced license or higher. For more information on licensing policies, refer to the following.