pantheon-se/pantheon-secrets-explorer

A simple demo plugin for showcasing Pantheon Secrets API.

v0.0.3 2023-09-27 04:31 UTC

This package is auto-updated.

Last update: 2024-11-13 08:32:08 UTC


README

A WordPress plugin that integrates with the Pantheon Secrets API, allowing administrators to view secrets and map them to environment variables within WordPress.

https://www.loom.com/share/50a38c32fffc4d4687e2d0b5687b6576

Features

  • Secrets Explorer: View all secrets in a tabulated format. The secret values are obscured for security, but can be revealed with a click of a button.

  • Environment Variables Mapper: Map any secret to a WordPress environment variable. The mappings are stored in the wp_options table and the environment variables are dynamically created on WordPress bootstrap.

Installation

  1. Install the plugin using Composer:

    composer require pantheon-se/pantheon-secrets-explorer
  2. Activate the plugin in the WordPress admin dashboard.

Usage

  1. Secrets Explorer: In the WordPress admin dashboard, navigate to the "Pantheon Secrets" submenu under "Tools". This will display all secrets from the Pantheon Secrets API.

  2. Environment Variables Mapper: In the WordPress admin dashboard, navigate to the "Env Variables" submenu under "Pantheon Secrets". Here, you can define new environment variables and map them to a secret. Existing mappings can be viewed and deleted.

Developer Notes

  • This plugin relies on the Pantheon Secrets PHP SDK for API interactions. Ensure the SDK is updated regularly for compatibility and security.

Contributions & Support

For contributions, please raise an issue or submit a pull request on our GitHub repository.

For support, reach out to kyle.taylor@pantheon.io.

License

This project is licensed under the MIT License.