You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+45-19Lines changed: 45 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -23,27 +23,11 @@ blimp
23
23
24
24
## Configuration
25
25
26
-
The app will look for a configuration file called `blimp.toml`. Here is an example configuration for the example above:
26
+
The app will look for a configuration file called `blimp.toml`. Blimp comes with pretty good defaults but you can adjust everything how you want.
27
27
28
-
```toml
29
-
# The layout is based on a grid, you can add rows and columns or remove some widgets
30
-
# On smaller screens you probably don't want to cramp everything in, so remove the widgets that you don't need
31
-
[[pages]]
32
-
layout = [
33
-
["weather", "weather"],
34
-
["weather", "weather"],
35
-
["feeds", "feeds"],
36
-
["latency", "status"]
37
-
]
38
-
39
-
[[pages]]
40
-
layout = [
41
-
["feeds", "feeds"],
42
-
["feeds", "feeds"],
43
-
["feeds", "feeds"],
44
-
["latency", "status"]
45
-
]
28
+
### Configure the widgets
46
29
30
+
```toml
47
31
[[widgets.status.targets]]
48
32
name = "Xenon Bot"
49
33
type = "https"
@@ -75,4 +59,46 @@ owm_lon = 12.37
75
59
url = "https://hnrss.org/newest"
76
60
```
77
61
62
+
## Configure the layout
63
+
64
+
Blimp supports multiple pages that it switches between on an interval. Each page can have a distinct grid layout with different widgets. If you don't want blimp to switch between pages, only define one page.
65
+
66
+
```toml
67
+
# How fast do you want blimp to switch between pages
68
+
page_interval = 30000# 30 seconds is the default
69
+
70
+
# Your first page
71
+
[[pages]]
72
+
layout = [
73
+
["weather", "weather"],
74
+
["weather", "weather"],
75
+
["feeds", "feeds"],
76
+
["latency", "status"]
77
+
]
78
+
79
+
# Your second page
80
+
[[pages]]
81
+
layout = [
82
+
["feeds", "feeds"],
83
+
["feeds", "feeds"],
84
+
["feeds", "feeds"],
85
+
["latency", "status"]
86
+
]
87
+
88
+
# Your third page
89
+
[[pages]]
90
+
...
91
+
```
92
+
78
93
Look at the [default config](internal/config/default.config.toml) for other values you can override.
94
+
95
+
## Logging
96
+
97
+
Because logging to STDOUT is pointless because STDOUT is already used for the UI output, you can find log messages in a file called `blimp.log`.
98
+
99
+
If you want blimp to write to a different logfile you can set it in the config like this:
0 commit comments