docs
0
# System Configuration
1
2
Administrative configuration interface (creme_config) for system settings, entity configuration, UI customization, and application management through web-based configuration tools.
3
4
## Capabilities
5
6
### Configuration Registry
7
8
Central registry system for managing configurable components and settings.
9
10
```python { .api }
11
class ConfigRegistry:
12
"""
13
Central registry for configuration items and settings.
14
15
Manages configuration of:
16
- Entity configurations
17
- UI components (bricks, blocks)
18
- User interface settings
19
- Application-specific settings
20
"""
21
22
def get_config_registry():
23
"""Returns the global configuration registry instance."""
24
```
25
26
### Entity Configuration
27
28
Tools for configuring entity behavior, field visibility, and custom properties.
29
30
```python { .api }
31
class FieldsConfig:
32
"""Configuration for entity field visibility and behavior."""
33
34
class CustomField:
35
"""Custom field definitions for extending entity models."""
36
37
class CustomForm:
38
"""Custom form configurations for entity creation/editing."""
39
```
40
41
### UI Configuration
42
43
Interface configuration for dashboards, detail views, and list displays.
44
45
```python { .api }
46
class BrickConfig:
47
"""Configuration for dashboard bricks and blocks."""
48
49
class HeaderFilter:
50
"""Configuration for list view columns and filtering."""
51
52
class MenuConfig:
53
"""Navigation menu configuration."""
54
```
55
56
### User Management Configuration
57
58
Tools for configuring user roles, permissions, and access control.
59
60
```python { .api }
61
class UserRole:
62
"""User role definitions and permissions."""
63
64
class EntityCredentials:
65
"""Entity-level access control configuration."""
66
67
class CredentialsConfig:
68
"""Credential system configuration."""
69
```
70
71
## Imports
72
73
```python
74
from creme.creme_config.registry import config_registry
75
from creme.creme_config.core import ConfigRegistry
76
```
77
78
## Web Interface
79
80
The creme_config app provides web-based administration interfaces accessible at:
81
82
- `/creme_config/`: Main configuration dashboard
83
- `/creme_config/entity/`: Entity configuration tools
84
- `/creme_config/fields/`: Field configuration management
85
- `/creme_config/bricks/`: UI brick configuration
86
- `/creme_config/user/`: User and role management