https://github.com/collective/collective.regenv

This product allows to override the values stored in the portal registry and property manager object (i.e. a PAS plugin)
https://github.com/collective/collective.regenv

Last synced: 3 months ago
JSON representation

This product allows to override the values stored in the portal registry and property manager object (i.e. a PAS plugin)

• Host: GitHub
• URL: https://github.com/collective/collective.regenv
• Owner: collective
• License: gpl-2.0
• Created: 2022-11-04T22:34:17.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-12-15T22:27:35.000Z (7 months ago)
• Last Synced: 2024-04-09T22:09:20.527Z (3 months ago)
• Language: Python
• Homepage:
• Size: 80.1 KB
• Stars: 4
• Watchers: 12
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.rst
  • License: LICENSE.GPL

Lists

• awesome-plone - collective.regenv - Override registry settings using environment variables. (Sysadmin)

README

        
.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.

   If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html

   This text does not appear on pypi or github. It is a comment.

.. image:: https://img.shields.io/pypi/v/collective.regenv.svg

    :target: https://pypi.org/project/collective.regenv/

    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/collective.regenv.svg?style=plastic

    :target: https://pypi.org/project/collective.regenv/

    :alt: Supported - Python Versions

.. image:: https://img.shields.io/pypi/dm/collective.regenv.svg

    :target: https://pypi.org/project/collective.regenv/

    :alt: Number of PyPI downloads

.. image:: https://img.shields.io/pypi/l/collective.regenv.svg

    :target: https://pypi.org/project/collective.regenv/

    :alt: License

.. image:: https://github.com/collective/collective.regenv/actions/workflows/tests.yml/badge.svg

    :target: https://github.com/collective/collective.regenv/actions

    :alt: Tests

.. image:: https://coveralls.io/repos/github/collective/collective.regenv/badge.svg?branch=main

    :target: https://coveralls.io/github/collective/collective.regenv?branch=main

    :alt: Coverage

=================

collective.regenv

=================

This product allows to override the values stored in the portal registry

and property manager object (i.e. a PAS plugin) with values defined on a local file

defined in an environment variable called ``PLONE_REGISTRY_YAML``.

When it comes to PropertyManager, this product actually only works if you use the accessor

``getProperty`` to read properties.

Features

--------

Using this product you can:

1. have different values for development and production environments

   (think about the ``MailHost`` settings,

   connection parameters to external services,

   etc.)

2. have different values for different instances in the same buildout,

   allowing for example to toggle features on and off for A/B testing.

Documentation

-------------

Registry overrides should be in a YAML file::

    % cat sample.yaml

    defaults: &defaults

        plone.cachepurging.interfaces.ICachePurgingSettings.cachingProxies:

            - http://localhost:8000

            - http://localhost:8001

        plone.app.theming.interfaces.IThemeSettings.hostnameBlacklist:

            - 127.0.0.1

            - localhost

    /Plone/portal_registry:

        <<: *defaults

    /Plone2/portal_registry:

        <<: *defaults

        plone.cachepurging.interfaces.ICachePurgingSettings.cachingProxies:

            - http://localhost:9000

    /Plone/acl_users/oidc:

        issuer:

            http://localhost:1234/realms/plone/

        client_id:

            plone

Run zope instance with environment pointing to the YAML file, for example::

    PLONE_REGISTRY_YAML=$(pwd)/sample.yaml bin/instance fg

Or using the docker image, for example::

    docker run -p 8080:8080 \

        -e ADDONS=collective.regenv \

        -e PLONE_REGISTRY_YAML=/app/registry.yaml \

        -v$(pwd)/sample.yaml:/app/registry.yaml \

        plone/plone-backend:latest

Alternatively you can add the contents of the YAML file in an environment

variable called `PLONE_REGISTRY_YAML_CONTENT` and pass the values directly.

This way you do not need to mount a volume with the configuration file.

For example::

    export PLONE_REGISTRY_YAML_CONTENT=$(cat sample.yaml)

    docker run -p 8080:8080 \

        -e ADDONS=collective.regenv \

        -e PLONE_REGISTRY_YAML_CONTENT

        plone/plone-backend:latest

Installation

------------

Install collective.regenv by adding it to your buildout::

    [buildout]

    ...

    eggs =

        collective.regenv

and then running ``bin/buildout``

Contribute

----------

- Issue Tracker: https://github.com/collective/collective.regenv/issues

- Source Code: https://github.com/collective/collective.regenv

- Documentation: https://pypi.org/project/collective.regenv/

License

-------

The project is licensed under the GPLv2.