dunglas / api-platform-heroku

Helpers to use API Platform and Symfony applications on Heroku.

API Platform and Symfony helpers to deploy on Heroku

This library eases the deployment of API Platform and Symfony applications on the Heroku platform.

Install

Use Composer to install the library in your project:

composer require dunglas/api-platform-heroku

Database helper

The library provides a Composer script to create Symfony parameters for the Doctrine bundle by parsing the DATABASE_URL environment variable populated by the Heroku Postgres addon.

To use it, start by adding the script to your composer.json file:

// ...
    "scripts": {
        "pre-install-cmd": [
          "Dunglas\\Heroku\\Database::createParameters"
        ],
        // ...
    }

Thanks to the ability of the Symfony Dependency Injection Component to read parameters from special environment variables, the parameters are automatically populated.

Change the content of the app/config/services.yml like the following to use them:

doctrine:
    dbal:
        driver:   "pdo_pgsql"
        host:     "%database_host%"
        port:     "%database_port%"
        dbname:   "%database_name%"
        user:     "%database_user%"
        password: "%database_password%"
        charset:  UTF8

In your local development environment, don't forget to set the SYMFONY__DATABASE_URL environment variable. A typical value for that variable is `postgres://user:pass@server:5432/dbname.

A convenient way to manage environment variable is the PHP dotenv library.

Credits

This library is part of the API Platform project. Created by Kévin Dunglas.

api-platform-heroku's Issues

app.json env vars are not available to SF

(edited)

app.json env vars are not available to SF

Class Dunglas\Heroku\Database is not autoloadable, can not call pre-install-cmd script

I get this error on install, can't use it

Error on Procfile?

I got this error now:

2018-01-05T13:49:26.279740+00:00 heroku[web.1]: Starting process with command `bin/heroku-php-apache2 web/`
2018-01-05T13:49:27.711200+00:00 app[web.1]: bash: bin/heroku-php-apache2: No such file or directory
2018-01-05T13:49:27.777956+00:00 heroku[web.1]: State changed from starting to crashed

I will investigate...

The docs ask for SYMFONY__DATABASE_URL, but the code asks for DATABASE_URL

Here: https://github.com/dunglas/api-platform-heroku

You say:

In your local development environment, don't forget to set the SYMFONY__DATABASE_URL environment variable. A typical value for that variable is `postgres://user:pass@server:5432/dbname.

But in the code here:

api-platform-heroku/src/Database.php

Line 26 in 6e6f687

$database = parse_url(getenv('DATABASE_URL'));

You are looking for 'DATABASE_URL'

heroku run "app/console doctrine:schema:create" in docs

this did not work

heroku run "app/console doctrine:schema:create" 

this did

heroku run "bin/console doctrine:schema:create" 

Require apcu so that heroku can install it

package.json

"require": {
       ...
        "ext-apcu": "*"
    },

Please, tag a stable version :)

We are forced to setup "minimum-stability" : "dev" in order to use this package, this is unusable except for testing purposes :)

DATABASE_URL is not available when pushing with app.json

I see that you have a heroku addon on the app.json, but when pushing to heroku, it was saying that DATABASE_URL was not available anyway. So I had to install it with:

heroku addons:create heroku-postgresql:hobby-dev

After that, that error stopped happening.

DATABASE_URL or SYMFONY__DATABASE_URL?

Here: https://github.com/dunglas/api-platform-heroku

You say:

In your local development environment, don't forget to set the SYMFONY__DATABASE_URL environment variable. A typical value for that variable is `postgres://user:pass@server:5432/dbname.

But in the code here:

api-platform-heroku/src/Database.php

Line 26 in 6e6f687

$database = parse_url(getenv('DATABASE_URL'));

You are looking for 'DATABASE_URL'

Get error stable issue when I run 'composer require dunglas/api-platform-heroku'

I'm using mac OSX Sierra 10.12 and try to install api-platform-heroku, but then this error came up:

[InvalidArgumentException]                                                                                     
  Could not find package dunglas/api-platform-heroku at any version for your minimum-stability (stable). Check   
  the package spelling or your minimum-stability  

Can anyone help me on this issue?

Dunglas\Heroku\Database not on autorun

When deploying I was not able to put that class on autorun. I did it locally by running composer update. But was not able to do it on heroku.

So I decided to use this that seemed a better approach than having to rely on that Database::createParameters method:

doctrine:
    dbal:
        driver: pdo_mysql
        url: "%env(DATABASE_URL)%"