Skip to content

Commit 14ab48f

Browse files
committed
docs: add contract_card_position setting to README
1 parent 7639a25 commit 14ab48f

1 file changed

Lines changed: 24 additions & 1 deletion

File tree

README.md

Lines changed: 24 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,30 @@ Example:
3333

3434
## Configuration
3535

36-
None
36+
The plugin can be configured via `PLUGINS_CONFIG` in your NetBox configuration file:
37+
38+
```python
39+
PLUGINS_CONFIG = {
40+
'netbox_lifecycle': {
41+
'contract_card_position': 'right_page',
42+
},
43+
}
44+
```
45+
46+
### Available Settings
47+
48+
| Setting | Default | Description |
49+
|---------|---------|-------------|
50+
| `contract_card_position` | `right_page` | Position of the Support Contracts card on device detail pages. Options: `left_page`, `right_page`, `full_width_page`. |
51+
52+
### Contract Card Position
53+
54+
When enabled, a Support Contracts card will be displayed on device detail pages showing all contract assignments grouped by status:
55+
56+
- **Active**: Contracts currently in effect
57+
- **Future**: Contracts with a start date in the future
58+
- **Unspecified**: Contracts without an end date
59+
- **Expired**: Contracts that have ended (lazy-loaded for performance)
3760

3861
## Usage
3962

0 commit comments

Comments
 (0)