Skip to content

Commit e8f8900

Browse files
committed
update readme
1 parent 7d1c10f commit e8f8900

File tree

1 file changed

+53
-0
lines changed

1 file changed

+53
-0
lines changed

README.md

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,57 @@ Stop the Docker container.
2626

2727
```bash
2828
docker-compose down
29+
```
30+
31+
### Additional Piccolo Admin configuration
32+
33+
Piccolo Admin has a flexible UI with lots of configuration options to display only the columns you want your users to see. More information on Piccolo Admin [docs](https://piccolo-admin.readthedocs.io/en/latest/index.html).
34+
35+
After Piccolo Admin is started with all the tables from the existing database, we can do additional configuration through the `config.yaml` file.
36+
37+
Example of `config.yaml`:
38+
39+
```yaml
40+
tables:
41+
# An example of additional Piccolo Admin configuration
42+
Actor:
43+
visible_columns:
44+
- actor_id
45+
- first_name
46+
visible_filters:
47+
- actor_id
48+
- first_name
49+
menu_group: Movies
50+
Address:
51+
visible_columns:
52+
- address_id
53+
- address
54+
- city_id
55+
visible_filters:
56+
- address_id
57+
- address
58+
- city_id
59+
menu_group: Location
60+
City:
61+
visible_columns:
62+
- city_id
63+
- city
64+
visible_filters:
65+
- city_id
66+
- city
67+
menu_group: Location
68+
Country:
69+
visible_columns:
70+
- country_id
71+
- country
72+
visible_filters:
73+
- country_id
74+
- country
75+
menu_group: Location
76+
```
77+
78+
For these changes to take effect, you must stop the container and rebuild it with.
79+
80+
```bash
81+
docker-compose up -d --build
2982
```

0 commit comments

Comments
 (0)