PHPackages norsys/rothenberg - 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. [DevOps & Deployment](/categories/devops) 4. / 5. norsys/rothenberg ActiveProject[DevOps & Deployment](/categories/devops) norsys/rothenberg ================= Tool which allow a developper to create or maintain a Symfony application or a Symfony bundle very easily and without install something on his workstation 1.1.0(7y ago)2410.6k↓50%13[2 PRs](https://github.com/norsys/rothenberg/pulls)3BSD-3-ClausePHP Since Nov 10Pushed 7y ago13 watchersCompare [ Source](https://github.com/norsys/rothenberg)[ Packagist](https://packagist.org/packages/norsys/rothenberg)[ RSS](/packages/norsys-rothenberg/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (10)Used By (3) Rothenberg ========== [](#rothenberg) `Rothenberg` allows a developer to create or maintain a Symfony application or bundle very easily and without installing anything on his workstation (Mac or PC, Windows is not currently supported). It is not a standalone project, so it must be used in the context of an another project. TL;DR ----- [](#tldr) You must have an UNIX operating system, `docker`, `GNU make` and an Internet access to use `Rothenberg`. To develop or maintain a Symfony application, execute the following command in a terminal: ``` wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh ``` Or to use it in the context of a Symfony bundle, do: ``` (export TARGET=bundle; wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh) ``` `Rothenberg` use a docker image during the installation process. To be sure to use the latest version of this image, prefix the above commands with `docker pull norsys/rothenberg`: ``` docker pull norsys/rothenberg && wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh ``` But… maybe you should read the following information before executing one of these commands! Features -------- [](#features) In the following, we assume that the command `make install` was made in the directory `path/to/project`. ### Docker and docker-compose configuration [](#docker-and-docker-compose-configuration) `Rothenberg` creates a `docker-compose.yml` with some services pre-configured and an empty `docker-compose.override.yml` (only if this file does not exist) in the directory `path/to/project`. If you want to override some services configuration, use [`docker-compose.override.yml`](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files). ### Docker images management [](#docker-images-management) `Rothenberg` pulls the latest version of each docker image via `make start` or `make restart` (see below for more information about these commands). These images are: - `nginx` ; - `php-fpm` ; - `php-cli` ; - `composer` ; - `node` . It's possible to disable this feature via the `.rothenberg.config` file. ### Default PHP configuration for `CLI` and `FPM` [](#default-php-configuration-for-cli-and-fpm) `Rothenberg` provides a `php.ini` for CLI and FPM in `path/to/project/env/php/cli` and `path/to/project/env/php/fpm` respectively. ### Helpers to hide `docker` and `docker-compose` [](#helpers-to-hide-docker-and-docker-compose) `Rothenberg` provides several helpers in `path/to/project/bin` to hide `docker` and `docker-compose` complexities. So, all scripts in `path/to/project/bin` can be run in the traditional way even if `docker` is used in the background. For example, to update PHP dependencies, just do `bin/composer update`. ### Atoum configuration [](#atoum-configuration) `Rothenberg` installs files `path/to/project/.atoum.php`, an [atoum](https://github.com/atoum/atoum) runner and a base test class in `path/to/project/tests/units`. ### Automated `nginx` virtual host management [](#automated-nginx-virtual-host-management) `Rothenberg` provides an automated `nginx` virtual host management via the `make` variable `VIRTUAL_HOST`. To define the virtual host for your project, define its value before including `./env/Makefile` (see below for more information about that): ``` VIRTUAL_HOST := foo.bar include env/Makefile ``` ### Networking [](#networking) `Rothenberg` allows you to share an [`nginx-proxy`](https://github.com/jwilder/nginx-proxy) docker's service between several projects, or any other services. For that purpose, it creates a network named according to the value of make's `ROTHENBERG_NETWORK` variable, which has `rothenberg` as default value. If you want to override its value, in the project's `Makefile`, just add `ROTHENBERG_NETWORK := yourNetworkName` before including `env/Makefile` (see below for more information about that). ### Environment management [](#environment-management) `Rothenberg` allows you to install a project in several environments using the `make` variable `ENV` and [`SYMFONY_ENV`](http://symfony.com/doc/current/configuration/environments.html). Default value of `ENV` is `dev`, and the default value of `SYMFONY_ENV` is `ENV`. So, to install a project in a `prod` environmment using the `dev` Symfony environment, just do: ``` # make install ENV=prod SYMFONY_ENV=dev ``` By default, the Symfony debug mode is enabled, but you can disable it using the `make` variable `SYMFONY_DEBUG`: ``` # make install SYMFONY_DEBUG=false ``` ### Private PHP package management [](#private-php-package-management) `Rothenberg` can handle SSH key needed to access some private PHP packages via `composer`. Out of the box, it will use the key `$(HOME)/.ssh/id_rsa`, but you can override this using `make SSH_KEY=/path/to/your/ssh/key`. Your secret key will never be copied by `Rothenberg`. ### Default `Makefile` [](#default-makefile) If your project has no `Makefile` during its installation, `Rothenberg` provides a default `Makefile` for it. Moreover, it provides in `path/to/project/env` a `Makefile` with some interesting targets (see below). This `Makefile` is already included in the default `Makefile` provided by `Rothenberg`. If the project already has a `Makefile` before `Rothenberg` installation, add `include env/Makefile` in it to use `Rothenberg` targets. ### Project Management [](#project-management) `Rothenberg` allows you to use *make* to manage a project, with the following `make` targets: - `install` install localy `docker-compose`, `php-(?:cli|fpm)`, `composer`, `node`, `npm`, `nginx` and configure them ; - `reinstall` restart the project ; - `uninstall` to uninstall the project ; - `start` start all services needed by the website (`nginx`, `php-fpm`…) ; - `stop` stop all services needed by the project ; - `restart` restart all services ; - `status` display status of each services ; - `security` to check security of PHP dependencies ; - `check-style-php` to check PHP coding convention according to `env/php/check-style.xml` ; - `fix-style-php` to fix PHP coding convention according to `env/php/check-style.xml` ; - `unit-tests` to run all unit tests ; - `rothenberg/update` to update `Rothenberg` (see the `Update` section below) ; - `help` display a tiny help about each of available commands. Some of these targets are available only if you use `rothenberg` to develop an application. Use `make help` to know available targets according to your type of project. ### Git configuration [](#git-configuration) `Rothenberg` installs files `.gitignore` and `.gitattribute` with default values in the directory `path/to/project`. Moreover, it installs a [pre-commit hook](https://git-scm.com/book/it/v2/Customizing-Git-Git-Hooks) to check coding convention via `make check-style`. ### Assets watcher [](#assets-watcher) `Rothenberg` provides an assets watcher via `bin/watchodg`, which is automatically started via `make start` or `make restart`. Installation ------------ [](#installation) ### For an application [](#for-an-application) You can install `Rothenberg` in a new project or in an existing one. For example, if your project is an application located in `path/to/project`: 1. `cd path/to/project` ; 2. Do `wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh`. Once the install is done, if you already have a `./Makefile`, just add `include env/Makefile` in it to profit of `Rothenberg`'s targets. You can also define `VIRTUAL_HOST` variable before including `env/Makefile` (see above for more informations). Moreover, you can edit [`./docker-compose.override.yml`](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) to add specific `docker` services or networks. Finaly, do `make start` to download PHP depedencies and start services. ### For a bundle [](#for-a-bundle) 1. `cd path/to/project` ; 2. Do `(export TARGET=bundle; wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh)`. Once the install is done, if you already have a `./Makefile`, just add `include env/Makefile` in it to profit of `Rothenberg`'s targets. Moreover, you can edit [`./docker-compose.override.yml`](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) to add specific `docker` services or networks. ### Common steps for application and bundle [](#common-steps-for-application-and-bundle) After installation was done, you can add and commit all new files in your project (yes, really, commit them in your project): 1. `git add .` ; 2. `git commit -m ""` ; 3. `git push`. Configuration for a project --------------------------- [](#configuration-for-a-project) ### Configuration of `docker` and `docker-compose` [](#configuration-of-docker-and-docker-compose) If your project needs some aditionnal `docker` services, define them in the [`./docker-compose.override.yml`](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files). For example, to add `mysql`, edit `./docker-compose.override.yml` and add this in the `services` section: ``` mysql: image: mysql:5.6.31 volumes: - ./var/mysql:/var/lib/mysql ``` If you want to link the `mysql` service to `php-fpm`, add this in the `services` section: ``` php-fpm: links: - mysql ``` If you want to know all services defined by `Rothenberg`, do `make rothenberg-docker-services`. For more informations about `./docker-compose.override.yml`, please read its [official documentation](https://docs.docker.com/compose/extends/#understanding-multiple-compose-files) and the `docker-compose` file [reference](https://docs.docker.com/compose/compose-file/). ### Configuration of `make` [](#configuration-of-make) You can add [prerequisites](https://www.gnu.org/software/make/manual/html_node/Rule-Syntax.html#Rule-Syntax) for targets defined by `Rothenberg`. For example, if you want to create the directory `var/mysql` via `make`, add in `./Makefile` after the include of `./env/Makefile`: ``` vendor/autoload.php: | var/mysql uninstall/var: uninstall/var/mysql var/mysql: $(MKDIR) $@ ``` Some special targets defined by `Rothenberg` are used in this example: - `vendor/autoload.php` is the trigger for `vendor` installation via [`composer`](https://getcomposer.org) ; - `uninstall/var` is the target used to clean the `path/to/project/var` directory ; Moreover, the target `uninstall/var/mysql` is handled by the [pattern rule](https://www.gnu.org/software/make/manual/html_node/Pattern-Intro.html#Pattern-Intro) `uninstall/%` which delete any file or directory defined by wildcard `%`. If you want to know all targets defined by `Rothenberg` to add some prerequisites to them, just do `make rothenberg-targets`. For more informations about `make`' syntax and features, please read its [official documentation](https://www.gnu.org/software/make/manual/html_node/). ### Configuration of `PHP` [](#configuration-of-php) You can customize PHP's configuration in `CLI` and `FPM` context. To do that for `CLI` context, edit `path/to/project/env/php/cli/php.ini` (or `path/to/project/env/php/fpm/php.ini` for `FPM`) and execute `make restart`. For more information about PHP configuration, please read its [official documentation](http://php.net/manual/en/ini.core.php). ### Check styling [](#check-styling) Out of the box, `Rothenberg` provides PHP style checking configured via `path/to/project/env/check-style.xml` and `make check-style`, but you can add style checking for some other languages. For example, to add style checking for JavaScript using [`eslint`](http://eslint.org), add this in `path/to/project/Makefile`: ``` check-style: check-style-js check-style-js: | bin/node ## Check coding conventions for JavaScript. bin/node eslint -c .eslintrc --ignore-path .eslintignore ./src ``` Update ------ [](#update) To update `Rothenberg` in a project, just do: 1. `make rothenberg/update` ; 2. `git add .` ; 3. `git commit -m ""` ; 4. `git push`. Houston? We've got a problem! ----------------------------- [](#houston-weve-got-a-problem) First, don't panic. If you're using Fedora and have troubles with the `make install` command, use `make install ENV=dev` instead. Then execute `docker system prune -f` to clean the docker environment, and try to reproduce the problem. If the problem disappears, say thanks to Gandalf and enjoy! But if the problem always exists, open an issue to help us to improve `rothenberg`. If you open an issue, describe your problem precisely and give maximum information about your environment: - Operating system ; - `docker` version, do `docker --version` to obtain it ; - `docker-compose` version, do `docker-compose --version` to obtain it ; - `make version`, do `make --version` to obtain it ; - Give output of `docker ps -a` ; - Give output of `docker network ls` ; Moreover, if you encounter a problem during installation, reexecute it with `(export WITH_DEBUG=yes; wget -O - https://github.com/norsys/rothenberg/raw/master/install.sh | sh)`, and add the output to your issue. And if you encounter a problem during a `make` command execution, reexecute it with `make WITH_DEBUG=yes`, and add the output to your issue. Finaly, you can join the channel `##rothenberg` on the IRC network `freenode`: 1. Download an IRC client ; 2. Configure it with your personal information ; 3. Use it to [connect to the `freenode` network](https://freenode.net/kb/answer/chat) ; 4. Do `/j ##rothenberg` ; 5. Say `Hello!`. Contributing ------------ [](#contributing) ### About workflow [](#about-workflow) We're using pull request to introduce new features and bug fixes. Please, try to be explicit in your commit messages: 1. Explain why the change was made ; 2. Explain technical implementation (you can provide links to any relevant tickets, articles or other resources). You can use the following template: ``` # If applied, this commit will... # Explain why this change is being made # Provide links to any relevant tickets, articles or other resources ``` To use it, just put it in a text file in (for example) your home and define it as a template: ``` # git config --global commit.template ~/.git_commit_template.txt ``` ### About testing [](#about-testing) There are some `make` targets to test `Rothenberg`, especially install and update of bundle and application. To run them, just do `make tests`. Please, do not omit to update tests before implemeting new feature or doing a bug fix. To update tests, just update the content of the `references` directory. Languages and tools ------------------- [](#languages-and-tools) - [*docker*](https://docs.docker.com) ; - [*docker-compose*](https://docs.docker.com/compose/) ; - [*atoum*](http://docs.atoum.org) ; - [*make*](https://www.gnu.org/software/make/manual/make.html) ; - [*Symfony*](http://symfony.com/doc/current/index.html). History ------- [](#history) Primary version of `Rothenberg` was born in the PHP business unit of [Norsys](http://norsys.fr), based in [Lyon, France](https://www.google.fr/maps/place/Lyon/@45.75801,4.8001016,13z/data=!3m1!4b1!4m5!3m4!1s0x47f4ea516ae88797:0x408ab2ae4bb21f0!8m2!3d45.764043!4d4.835659). It was made with love to industrialize our PHP development based upon Symfony. This project was a success, because we can now bootstrap a project or integrate a team and start to develop some features of fix bugs in a few minutes. So, we decided to open-source it, because we think that this kind of tools must be shared with the PHP community. Why `Rothenberg`? ----------------- [](#why-rothenberg) [David Rothenberg](http://www.davidrothenberg.net) is a book author and a song composer who has made music with whales 🐳. This project uses `docker`, which has a 🐳 as logo, `composer` and `docker-compose` to set up a Symfony environment. So, `Rothenberg` seems to be a good choice as name ;). ### Health Score 41 — FairBetter than 88% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity36 Limited adoption so far Community30 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 67.5% of commits — single point of failure 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 ~398 days Total 2 Last Release 2704d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7f5d8c29ba579eb1b08a260038385cf0f21752ac8bd13b65fe7c1f4f876a594d?d=identicon)[mageekguy](/maintainers/mageekguy) ![](https://www.gravatar.com/avatar/7b39961dd28bd8827f2aa5961f5eb5dd0f23eb7704917214b0189fd7b5434684?d=identicon)[cedvan](/maintainers/cedvan) ![](https://www.gravatar.com/avatar/44fcdbf81ef34ed36e29fae0d04eb1776a95264a67bca2a57574f156b3745316?d=identicon)[norsys](/maintainers/norsys) --- Top Contributors [![mageekguy](https://avatars.githubusercontent.com/u/457534?v=4)](https://github.com/mageekguy "mageekguy (54 commits)")[![fhardy-norsys](https://avatars.githubusercontent.com/u/114090785?v=4)](https://github.com/fhardy-norsys "fhardy-norsys (15 commits)")[![Siwayll](https://avatars.githubusercontent.com/u/1230190?v=4)](https://github.com/Siwayll "Siwayll (4 commits)")[![whiskeylotus](https://avatars.githubusercontent.com/u/7048855?v=4)](https://github.com/whiskeylotus "whiskeylotus (2 commits)")[![lemacbacon](https://avatars.githubusercontent.com/u/3008228?v=4)](https://github.com/lemacbacon "lemacbacon (1 commits)")[![jubianchi](https://avatars.githubusercontent.com/u/327237?v=4)](https://github.com/jubianchi "jubianchi (1 commits)")[![c-salinas](https://avatars.githubusercontent.com/u/16558397?v=4)](https://github.com/c-salinas "c-salinas (1 commits)")[![jeremybernard1984](https://avatars.githubusercontent.com/u/9753147?v=4)](https://github.com/jeremybernard1984 "jeremybernard1984 (1 commits)")[![borisfournier](https://avatars.githubusercontent.com/u/23703764?v=4)](https://github.com/borisfournier "borisfournier (1 commits)") --- Tags developpersymfonysymfony-applicationworkstationscomposersymfonydockermakedocker-compose ### Embed Badge ![Health badge](/badges/norsys-rothenberg/health.svg) ``` [![Health](https://phpackages.com/badges/norsys-rothenberg/health.svg)](https://phpackages.com/packages/norsys-rothenberg) ``` ### Alternatives [downtoworld/laravel-devops Laravel Cloudflare-Tunnels Ready Production Docker-Compose 161.1k](/packages/downtoworld-laravel-devops)[vcian/pulse-docker-monitor A Laravel Pulse card to show docker containers with CPU & Memory Utilization 348.0k](/packages/vcian-pulse-docker-monitor)[matthew-p/docker-server Universal docker server, Nginx, PHP-FPM, MySql, Redis 112.8k](/packages/matthew-p-docker-server) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)