Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Symfony Flex recipe to Installation Instructions #321

Merged
merged 2 commits into from Feb 21, 2020
Merged

Add Symfony Flex recipe to Installation Instructions #321

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad42537
Add Symfony Flex recipe to Installation Instructions
Briones Feb 20, 2020
0c31565
Changes in the README and update the custom HTTP factory/transport se…
Briones Feb 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 19 additions & 6 deletions README.md
View file
Open in desktop
Expand Up @@ -21,8 +21,23 @@ Use sentry-symfony for:
- app path
- excluded paths (cache and vendor)

## Installation
## Installation for Symfony 4 or newest:
### Step 1: Install the sentry-symfony flex recipe:
You can install this recipe using Composer:
Briones marked this conversation as resolved.
Show resolved Hide resolved

```bash
composer require sentry/sentry-symfony
```
This could show a message similar to this:
```
The recipe for this package comes from the "contrib" repository, which is open to community contributions.
Review the recipe at https://github.com/symfony/recipes-contrib/tree/master/sentry/sentry-symfony/3.0

Do you want to execute this recipe?
```
Press `y` and return to allow the installation.

## Installation for Symfony 3.4:
Briones marked this conversation as resolved.
Show resolved Hide resolved
### Step 1: Download the Bundle
You can install this bundle using Composer:

Expand Down Expand Up @@ -50,8 +65,6 @@ composer require sentry/sentry-symfony:^3.0 sentry/sentry:^2.0 php-http/guzzle6-
The `sentry/sentry` package is required directly to override `sentry/sdk`, and the other two packages are up to your choice;
in the current example, we're using both Guzzle's components (client and message factory).

> TODO: Flex recipe

### Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles
Expand Down Expand Up @@ -80,10 +93,10 @@ class AppKernel extends Kernel
Note that, unlike before in version 3, the bundle will be enabled in all environments; event reporting, instead, is enabled
only when providing a DSN (see the next step).

### Step 3: Configure the SDK
### Configuration of the SDK
Briones marked this conversation as resolved.
Show resolved Hide resolved

Add your [Sentry DSN](https://docs.sentry.io/quickstart/#configure-the-dsn) value of your project to ``app/config/config_prod.yml``.
Leaving this value empty (or undeclared) in other environments will effectively disable Sentry reporting.
Add your [Sentry DSN](https://docs.sentry.io/quickstart/#configure-the-dsn) value of your project, if you have Symfony 3.4 add it to ``app/config/config_prod.yml`` for Symfony 4 or newest add the value to `config/packages/sentry.yaml`.
Keep in mind that leaving the `dsn` value empty (or undeclared) in other environments will effectively disable Sentry reporting.

```yaml
sentry:
Expand Down