Skip to content

Commit

Permalink
Update configuration.md
Browse files Browse the repository at this point in the history
  • Loading branch information
engram-design authored Nov 2, 2018
1 parent c332713 commit 6cb4bf2
Showing 1 changed file with 2 additions and 26 deletions.
28 changes: 2 additions & 26 deletions docs/get-started/configuration.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,6 @@
# Configuration

Feed Me allows you to provide additional options through a configuration file. Create a file named `feedme.php` in your `craft/config` directory. As with any configuration option, this supports multi-environment options.

```php
return array(
'*' => array(
'curlOptions' => array(
CURLOPT_PROXY => 'username:password',
),
'checkExistingFieldData' => false,
'skipUpdateFieldHandle' => 'skipFeedMeUpdate',
'backupLimit' => 100,
),
);
```

### Configuration options

- `curlOptions` - an array of options for cURL when fetching your feed data.
- `checkExistingFieldData` - a boolean whether to compare against an existing element (if any) and each field's content. If your feed content and the existing field's content match exactly, Feed Me won't overwrite the existing content. This can be useful to enable for performance.
- `skipUpdateFieldHandle` - a custom field (preferably Lightswitch) to allow you to opt-out of updating elements. If switched on for an element, Feed Me will skip over updating it, but update other elements in the feed.
- `backupLimit` - when backup is switched on for a feed, you can set a limit for the number to keep. This will ensure your backups don't get out of control on your server. By default, this is set to 100.

### Feed Me 3.x.x

Configuration options are slightly different for Feed Me 3.x.x. Create a file named `feed-me.php` in your `config` directory.
Create a file named `feed-me.php` in your `config` directory.

```php
return [
Expand All @@ -49,4 +25,4 @@ return [
'dataDelimeter' => '|',
],
];
```
```

0 comments on commit 6cb4bf2

Please sign in to comment.