Skip to content

Commit 750fd89

Browse files
committed
update readme and add more config details
1 parent ba3c5c9 commit 750fd89

2 files changed

Lines changed: 53 additions & 21 deletions

File tree

README.md

Lines changed: 45 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -23,27 +23,11 @@ blimp
2323

2424
## Configuration
2525

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.
2727

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
4629

30+
```toml
4731
[[widgets.status.targets]]
4832
name = "Xenon Bot"
4933
type = "https"
@@ -75,4 +59,46 @@ owm_lon = 12.37
7559
url = "https://hnrss.org/newest"
7660
```
7761

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+
7893
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:
100+
101+
```toml
102+
[logging]
103+
filename = "blimp.log"
104+
```

internal/config/default.config.toml

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
update_interval = 250 # 250 ms
2-
page_interval = 15000 # 15 seconds
2+
page_interval = 30000 # 30 seconds
33

44
[[pages]]
55
layout = [
@@ -33,4 +33,10 @@ owm_unit = "metric"
3333
update_interval = 60000 # 1 minutes
3434
max_items = 0 # 0 means auto
3535
show_feed_title = true
36-
show_published_time = true
36+
show_published_time = true
37+
38+
[logging]
39+
filename = "blimp.log"
40+
max_size = 1 # in MB
41+
max_age = 7 # in days
42+
max_backups = 5 # // note: old ones will still be deleted after max_age

0 commit comments

Comments
 (0)