Skip to content
Snippets Groups Projects
Commit 321783cd authored by Adam Harrison-Fuller's avatar Adam Harrison-Fuller
Browse files

Adding parameter tables to the README

parent ebf265fd
No related branches found
No related tags found
No related merge requests found
...@@ -21,18 +21,34 @@ The config file **MUST** be named config.yaml, an example one is provided [here] ...@@ -21,18 +21,34 @@ The config file **MUST** be named config.yaml, an example one is provided [here]
description of its contents. description of its contents.
```yaml ```yaml
interval: 300 // Interval in seconds to check the RSS feeds. interval: 300
feeds: feeds:
- id: test //Specify a feed ID that is used internally for duplicate detection. - id: test
feed_url: http://example.com/rss.xml // The Feed URL. feed_url: http://example.com/rss.xml
name: Test Feed // A User friendly display name. name: Test Feed
gitlab_project_id: 12345 // The Gitlab project ID to create issues under. gitlab_project_id: 12345
added_since: "2019-03-27T15:00:00Z" // (Optional) For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this added_since: "2019-03-27T15:00:00Z"
labels: // (Optional) A list of labels to add to created Issues. labels:
- TestLabel - TestLabel
- id: feed2 - id: feed2
... ...
``` ```
### Global
| Attribute | Type | Required | Description |
|-----------|------|----------|---------------------------------------------|
| interval | int | yes | The interval in seconds between feed checks |
### Feeds
| Attribute | Type | Required | Description |
|-------------------|--------|----------|-------------------------------------------------------------------------------------------------------|
| id | string | yes | A feed ID that is used internally for duplicate detection. |
| feed_url | string | yes | The URL of the feed |
| name | string | yes | A User friendly display name. |
| gitlab_project_id | int | yes | The Gitlab project ID to create issues under. |
| added_since | string | no | For longer RSS feeds specify a ISO 8601 DateTime to exclude items published/updated earlier than this |
| Labels | Array | no | A list of labels to add to created Issues |
## Docker ## Docker
A Docker image is made available on [DockerHub](https://hub.docker.com/r/adamhf/gitlabrsssync) A Docker image is made available on [DockerHub](https://hub.docker.com/r/adamhf/gitlabrsssync)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment