PHPackages openeuropa/oe\_newsroom - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. openeuropa/oe\_newsroom ActiveDrupal-module openeuropa/oe\_newsroom ======================= OpenEuropa Newsroom integration. 1.0.0(11mo ago)010.3k↓50%[4 PRs](https://github.com/openeuropa/oe_newsroom/pulls)EUPL-1.2PHPPHP >=8.1CI passing Since Jun 16Pushed 2mo ago18 watchersCompare [ Source](https://github.com/openeuropa/oe_newsroom)[ Packagist](https://packagist.org/packages/openeuropa/oe_newsroom)[ RSS](/packages/openeuropa-oe-newsroom/feed)WikiDiscussions 1.x Synced 1mo ago READMEChangelog (4)Dependencies (10)Versions (11)Used By (0) OpenEuropa Newsroom =================== [](#openeuropa-newsroom) The OpenEuropa oe\_newsroom provides integration with the Newsroom service. The main module offers a user interface to configure the required parameters for using the Newsroom API. Usage ----- [](#usage) In order to start using the module, you will need: - universe; - application (name); - hash method; - normalisation; - private key. These are provided by the Newsroom team. All except the private key can be configured by a user with the `administer newsroom configuration` permission at the page `/admin/config/system/newsroom-settings`. The private key must be configured in settings.php due the sensitive nature. It is recommended to add to the website `runner.yml` file the following line: ``` $settings['oe_newsroom']['newsroom_api_key'] = getenv('NEWSROOM_API_PRIVATE_KEY'); ``` Then for local development the environment variable `NEWSROOM_API_PRIVATE_KEY` can be set in the `docker-compose.override.yml` file. **NEVER commit the private key into GIT!** Create a DevOps ticket to set the environment variable `NEWSROOM_API_PRIVATE_KEY` for acceptance and production environments. Sub-modules ----------- [](#sub-modules) ### OpenEuropa Newsroom Newsletter [](#openeuropa-newsroom-newsletter) Provides configurable blocks to subscribe and unsubscribe to distribution lists. Limitations ----------- [](#limitations) - The oe\_newsroom\_newsletter sub-module contains a basic client that implements a subset of Newsroom APIs. This client will be moved to a dedicated PHP library. For this reason, the client and all the classes that depend on it have been marked as `@internal`. The client has not been declared as service to discourage using it as dependency. - The unsubscribe Newsroom API must be invoked once for each distribution list. To avoid locking the website for a long time while executing the requests, the maximum number of distribution lists that can be specified is limited to 5. Development setup ----------------- [](#development-setup) You can build the development site by running the following steps: - Install the Composer dependencies: ``` composer install ``` A post command hook (`drupal:site-setup`) is triggered automatically after `composer install`. This will symlink the module in the proper directory within the test site and perform token substitution in test configuration files. **Please note:** project files and directories are symlinked within the test site by using the [OpenEuropa Task Runner's Drupal project symlink](https://github.com/openeuropa/task-runner-drupal-project-symlink) command. If you add a new file or directory in the root of the project, you need to re-run `drupal:site-setup` in order to make sure they are be correctly symlinked. If you don't want to re-run a full site setup for that, you can simply run: ``` $ ./vendor/bin/run drupal:symlink-project ``` - Install test site by running: ``` $ ./vendor/bin/run drupal:site-install ``` The development site web root should be available in the `build` directory. ### Using Docker Compose [](#using-docker-compose) Alternatively, you can build a development site using [Docker](https://www.docker.com/get-docker) and [Docker Compose](https://docs.docker.com/compose/) with the provided configuration. Docker provides the necessary services and tools such as a web server and a database server to get the site running, regardless of your local host configuration. #### Requirements: [](#requirements) - [Docker](https://www.docker.com/get-docker) - [Docker Compose](https://docs.docker.com/compose/) #### Configuration [](#configuration) By default, Docker Compose reads two files, a `docker-compose.yml` and an optional `docker-compose.override.yml` file. By convention, the `docker-compose.yml` contains your base configuration and it's provided by default. The override file, as its name implies, can contain configuration overrides for existing services or entirely new services. If a service is defined in both files, Docker Compose merges the configurations. Find more information on Docker Compose extension mechanism on [the official Docker Compose documentation](https://docs.docker.com/compose/extends/). #### Usage [](#usage-1) To start, run: ``` docker-compose up ``` It's advised to not daemonize `docker-compose` so you can turn it off (`CTRL+C`) quickly when you're done working. However, if you'd like to daemonize it, you have to add the flag `-d`: ``` docker-compose up -d ``` Then: ``` docker-compose exec web composer install docker-compose exec web ./vendor/bin/run drupal:site-install ``` Using default configuration, the development site files should be available in the `build` directory and the development site should be available at: . #### Running the tests [](#running-the-tests) To run the grumphp checks: ``` docker-compose exec web ./vendor/bin/grumphp run ``` To run the phpunit tests: ``` docker-compose exec web ./vendor/bin/phpunit ``` #### Step debugging [](#step-debugging) To enable step debugging from the command line, pass the `XDEBUG_SESSION` environment variable with any value to the container: ``` docker-compose exec -e XDEBUG_SESSION=1 web ``` Please note that, starting from XDebug 3, a connection error message will be outputted in the console if the variable is set but your client is not listening for debugging connections. The error message will cause false negatives for PHPUnit tests. To initiate step debugging from the browser, set the correct cookie using a browser extension or a bookmarklet like the ones generated at . Contributing ------------ [](#contributing) Please read [the full documentation](https://github.com/openeuropa/openeuropa) for details on our code of conduct, and the process for submitting pull requests to us. Versioning ---------- [](#versioning) We use [SemVer](http://semver.org/) for versioning. For the available versions, see the [tags on this repository](https://github.com/openeuropa/oe_newsroom/tags). ### Health Score 47 — FairBetter than 94% of packages Maintenance72 Regular maintenance activity Popularity24 Limited adoption so far Community18 Small or concentrated contributor base Maturity63 Established project with proven stability Bus Factor2 2 contributors hold 50%+ of commits How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~340 days Total 5 Last Release 68d ago PHP version history (3 changes)1.0.0-alpha1PHP >=7.4 1.0.0-alpha3PHP >=8.0 1.0.0PHP >=8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/d3b1f4079f9a82f6dd88fe6577d1256b4ecbbccbcd4a4ec9bea7c2fd6f72b99a?d=identicon)[DIGIT-CORE](/maintainers/DIGIT-CORE) --- Top Contributors [![brummbar](https://avatars.githubusercontent.com/u/8488617?v=4)](https://github.com/brummbar "brummbar (90 commits)")[![piotrsmykaj](https://avatars.githubusercontent.com/u/10449853?v=4)](https://github.com/piotrsmykaj "piotrsmykaj (46 commits)")[![golddragon007](https://avatars.githubusercontent.com/u/8385152?v=4)](https://github.com/golddragon007 "golddragon007 (37 commits)")[![donquixote](https://avatars.githubusercontent.com/u/150032?v=4)](https://github.com/donquixote "donquixote (10 commits)")[![AaronGilMartinez](https://avatars.githubusercontent.com/u/7264392?v=4)](https://github.com/AaronGilMartinez "AaronGilMartinez (6 commits)")[![msnassar](https://avatars.githubusercontent.com/u/15343499?v=4)](https://github.com/msnassar "msnassar (4 commits)")[![peterserfozo](https://avatars.githubusercontent.com/u/22172388?v=4)](https://github.com/peterserfozo "peterserfozo (1 commits)")[![kp77](https://avatars.githubusercontent.com/u/648045?v=4)](https://github.com/kp77 "kp77 (1 commits)") ### Embed Badge ![Health badge](/badges/openeuropa-oe-newsroom/health.svg) ``` [![Health](https://phpackages.com/badges/openeuropa-oe-newsroom/health.svg)](https://phpackages.com/packages/openeuropa-oe-newsroom) ``` ### Alternatives [drupal/core-recommended Locked core dependencies; require this project INSTEAD OF drupal/core. 6939.5M343](/packages/drupal-core-recommended) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)