Plugin Registry

The official monorepo and registry for WebStray Authenticator plugins.

About

Plugin Registry is the centralized repository for official and community-driven plugins for WebStray Authenticator.

Structure

The following tree outlines the repository structure:

.
├── plugins/              # Plugin source code
├── templates/            # Plugin boilerplates/templates
├── scripts/              # Registry generation scripts
├── package.json          # Build scripts and dependencies
└── registry.json         # Auto-generated plugin registry

Documentation

Detailed documentation for Plugin Registry is available on the official WebStray website.

Setup & Usage

You can add plugins to WebStray Authenticator in the following ways:

CLI (Recommended)

Using WebStray CLI, you can add any plugin with just one command:

webstray authenticator add

This command will start an interactive plugin setup process.

After adding the plugins, don't forget to enable them in WebStray Authenticator under "Settings" -> "Plugins".

Manual Setup

You can add the plugin manually without using the CLI. To do this, follow these steps:

1. Download the folder with the plugin you need from the /plugins directory.
2. Open WebStray Authenticator and go to "Settings" -> "Plugins".
3. In the plugin management dialog, click the link to open the application's plugins directory.
4. Copy the plugin folder into the application's plugins directory.
5. The plugin will be automatically detected and appear in the plugin management dialog.
6. Enable this plugin in the plugin management dialog and close the dialog.

Development

You can create your own plugin in the following ways:

CLI (Recommended)

Using WebStray CLI, you can create a new plugin template with just one command:

webstray authenticator create

This command will start an interactive process of creating a new plugin template and will prompt you to specify the plugin ID, name, and author.

After creating a new plugin template, don't forget to enable it in WebStray Authenticator under "Settings" -> "Plugins".

Manual

Tip

You can use one of the templates from the /templates directory as a starting point for your new plugin.

To create a new plugin, follow these steps:

1. Open WebStray Authenticator and go to "Settings" -> "Plugins".
2. In the plugin management dialog, click the link to open the application's plugins directory.
3. Inside the plugins directory, create a directory named <your-plugin-name>.
4. Inside the <your-plugin-name> directory, create two files:
   • package.json: must include a unique "name" field.
   • index.js: must provide a default export function that accepts the sdk object.
5. Return to the plugin management dialog, find your plugin in the list, and enable it.
6. Verify: If you implemented a menu action or a UI sheet, it will now be available in the application.

Local Setup

If you want to run your own instance of the registry or contribute to its core logic, follow these steps:

Clone the repository

git clone https://github.com/webstraycom/authenticator-plugin-registry.git
cd authenticator-plugin-registry

Install dependencies

npm install

Sync the registry

Use these commands to generate the registry file and format the code:

# To update the registry file after adding new files:
npm run registry:build

# To fix code formatting:
npm run format

Contributing

We welcome community contributions! To add your plugin to the official registry:

1. Fork this repository.
2. Place your plugin in the /plugins folder.
3. Ensure your package.json is correctly filled out.
4. Submit a Pull Request with a brief description of your plugin.
5. By submitting a Pull Request, you agree that your contribution will be licensed under the project's MIT License.

Important

You do not need to update registry.json manually. The maintainers will regenerate the registry file during the review and merge process.

Disclaimer

All plugins in this registry are provided "as is", without warranty of any kind.

By using the contents of this repository, you acknowledge and agree that:

1. User Responsibility: You are solely responsible for the safety of your environment and sensitive data.
2. Plugin Status: Inclusion of any plugin in this registry does not imply endorsement, approval, or a guarantee of safety, including those marked as "Official".
3. Potential Risks: Any plugin, regardless of its origin or status, has the technical capability to access decrypted data and could potentially pose a security threat. Use them at your own risk.
4. No Liability: The developers and maintainers of this registry shall not be held liable for any data loss, hardware damage, or security breaches resulting from the use of this software.
5. Audit Required: Always audit the source code of any plugin before adding it. We do not guarantee the security or stability of any contributions.

Maintain secure backups and never use plugins you do not fully trust.

License

This project is licensed under the MIT License. See the LICENSE file for details.