~gjabell/mfn

ref: eadd6a87a7c825c733dcd197dd0297b10f0d5bd2 mfn/mfn-config.5 -rw-r--r-- 3.7 KiB
eadd6a87Galen Abell Remove Contributing from README 11 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
.\" Generated by scdoc 1.10.1
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "mfn-config" "5" "2020-04-12"
.P
.SH NAME
.P
mfn-config - configuration file format for \fBmfn\fR(1)
.P
.SH CONFIGURATION
.P
There is no default mfn location, and the config path must be specified by
running mfn with the \fB-c\fR flag.
.P
mfn uses the \fItoml\fR format, with the top-level being general configuration and
specific notifiers being configured under their respectively-named sections. All
configuration options are required unless otherwise noted. Note that mfn only
requires that a single notifier be configured to send notifications; any
unconfigured notifier sections should be omitted.
.P
mfn uses Golang template strings to produce the content of the notifications.
The entire Entry struct will be passed as the context to the template, so the
template may make use of any of the struct's fields.
.P
.SH OPTIONS
.P
.SS GENERAL OPTIONS
.P
These options are specified as top-level key-value pairs.
.P
\fBserver\fR
.RS 4
The URL of the Miniflux server.
.P
Example: "https://rss.example.com"
.P
.RE
\fBusername\fR
.RS 4
The username of the Miniflux account.
.P
Example: "myuser"
.P
.RE
\fBpassword\fR
.RS 4
The password of the Miniflux account. Note that as a toml string, any quotes
in the password must be escaped using .
.P
Example: "mypass"
.P
.RE
\fBdb_path\fR
.RS 4
The path where the last entry ID is stored.
.P
Example: "/var/lib/mfn/last_entry.txt"
.P
.RE
.SS EMAIL OPTIONS
.P
These options are configured in the \fB[email]\fR section.
.P
\fBsubject_template\fR
.RS 4
The Golang template string which will be sent as the subject of the email.
.P
Example: "New Entry: {{ .Title }}"
.P
.RE
\fBbody_template\fR
.RS 4
The Golang template string which will be sent as the body of the email.
.P
Example: "{{ .Content }}"
.P
.RE
\fBto\fR
.RS 4
The notification recipient.
.P
Example: "My User <myuser@example.com>"
.P
.RE
\fBfrom\fR
.RS 4
The notification sender.
.P
Example: "My Server <myserver@example.com>"
.P
.RE
\fBusername\fR
.RS 4
The username of the account on the email server used to send notifications.
.P
Example: "myuser"
.P
.RE
\fBpassword\fR
.RS 4
The password of the account on the email server used to send notifications.
.P
Example: "mypass"
.P
.RE
\fBserver\fR
.RS 4
The URL with port of the email server used to send notifications.
.P
Example: "smtp.example.com:587"
.P
.RE
\fBstarttls\fR
.RS 4
(optional) Whether to use STARTTLS when connecting to the email server.
.P
Default: false
.P
.RE
.SS GOTIFY OPTIONS
.P
These options are configured in the \fB[gotify]\fR section.
.P
\fBtitle_template\fR
.RS 4
The Golang template string which will be sent as the title of the message.
.P
Example: "New Entry: {{ .Title }}"
.P
.RE
\fBmessage_template\fR
.RS 4
The Golang template string which will be sent as the body of the message.
.P
Example: "{{ .Content }}"
.P
.RE
\fBserver\fR
.RS 4
The URL of the Gotify server used to send notifications.
.P
Example: "https://gotify.example.com"
.P
.RE
\fBtoken\fR
.RS 4
The app authentication token generated by Gotify.
.P
Example: "mytoken"
.P
.RE
\fBpriority\fR
.RS 4
(optional) The priority of the message.
.P
Example: 10
.P
.RE
.SS WEBHOOK OPTIONS
.P
These options are configured in the \fB[webhook]\fR section.
.P
\fBtemplate\fR
.RS 4
The Golang template string which will be sent as the body of the webhook.
.P
Example: "<h1>{{ .Title }}</h1><p>{{ .Content }}</p>"
.P
.RE
\fBendpoint\fR
.RS 4
The URL of the webhook endpoint.
.P
Example: "https://webhooks.example.com"
.P
.RE
.SH SEE ALSO
.P
\fBmfn\fR(1) \fBminiflux\fR(1)
.P
.SH AUTHORS
.P
Maintained by Galen Abell <galen@galenabell.com>.
.P
.SH COPYRIGHT
.P
mfn is released under the MIT license.