@@ -15,7 +15,7 @@ Requirements
1515
1616Patchwork requires:
1717
18- - The `` pw ` ` binary (built from source or downloaded from a release)
18+ - The `pw ` binary (built from source or downloaded from a release)
1919- A supported database: PostgreSQL (recommended), MySQL/MariaDB, or SQLite
2020- A mail transfer agent (e.g. Postfix) for receiving patches
2121- A reverse proxy (e.g. nginx) for TLS termination (optional but recommended)
@@ -68,7 +68,7 @@ Generate a default configuration file:
6868
6969 $ pw config > /etc/patchwork.toml
7070
71- Edit `` /etc/patchwork.toml ` ` to set at least the database URL and the HTTP base
71+ Edit `/etc/patchwork.toml ` to set at least the database URL and the HTTP base
7272URL. See :doc: `configuration ` for a full reference of all available settings.
7373
7474A minimal configuration looks like:
@@ -133,43 +133,43 @@ Running Services
133133
134134Patchwork consists of two long-running services:
135135
136- `` pw http ` `
136+ `pw http `
137137 The HTTP server exposing the web interface and REST API.
138138
139- `` pw ingress ` `
139+ `pw ingress `
140140 The SMTP daemon that receives emails from your mail transfer agent.
141141
142142systemd
143143~~~~~~~
144144
145- The `` make install ` ` target installs systemd unit files. Enable and start the
145+ The `make install ` target installs systemd unit files. Enable and start the
146146services:
147147
148148.. code-block :: console
149149
150150 $ sudo systemctl daemon-reload
151151 $ sudo systemctl enable --now pw-http pw-ingress
152152
153- The unit files are installed to `` /usr/lib/systemd/system/ `` . To override
154- settings, use `` systemctl edit ` `:
153+ The unit files are installed to `/usr/lib/systemd/system ` . To override settings,
154+ use `systemctl edit `:
155155
156156.. code-block :: console
157157
158158 $ sudo systemctl edit pw-http
159159
160160 .. note ::
161161
162- Both services read configuration from `` /etc/patchwork.toml ` ` by default.
163- Use the `` PATCHWORK_TOML ` ` environment variable to specify an alternative
162+ Both services read configuration from `/etc/patchwork.toml ` by default.
163+ Use the env:` PATCHWORK_TOML ` environment variable to specify an alternative
164164 path.
165165
166166
167167Reverse Proxy
168168-------------
169169
170170A reverse proxy like nginx is recommended for TLS termination and static file
171- serving. The `` make install ` ` target installs a default nginx configuration to
172- `` /etc/nginx/conf.d/patchwork.conf ` `.
171+ serving. The `make install ` target installs a default nginx configuration to
172+ `/etc/nginx/conf.d/patchwork.conf `.
173173
174174A minimal nginx configuration:
175175
@@ -192,28 +192,29 @@ A minimal nginx configuration:
192192 }
193193
194194
195- .. _deployment-parsemail :
196-
197195 Incoming Email
198196--------------
199197
200198Patchwork needs to receive emails from your mailing list. The recommended
201199approach is to configure your mail transfer agent to forward messages to the
202- ``pw ingress `` SMTP daemon.
200+ `pw ingress ` SMTP daemon.
201+
202+
203+ .. _ingress-transport :
203204
204205Postfix with Transport Maps
205206~~~~~~~~~~~~~~~~~~~~~~~~~~~
206207
207208This is the recommended setup. Configure Postfix to route mail for your list
208- domain to the `` pw ingress ` ` daemon using transport maps.
209+ domain to the `pw ingress ` daemon using transport maps.
209210
210- Add to `` /etc/postfix/main.cf ` `:
211+ Add to `/etc/postfix/main.cf `:
211212
212213.. code-block :: ini
213214
214215 transport_maps = lmdb:/etc/postfix/transport
215216
216- Create `` /etc/postfix/transport ` `:
217+ Create `/etc/postfix/transport `:
217218
218219.. code-block :: bash
219220
@@ -226,14 +227,13 @@ Build the transport map and reload Postfix:
226227 $ sudo postmap /etc/postfix/transport
227228 $ sudo systemctl reload postfix
228229
229- All mail addressed to ``lists.example.com `` will now be forwarded to
230- ``pw ingress `` over SMTP. No shell scripts, no special user accounts, no
231- database grants.
230+ All mail addressed to `lists.example.com ` will now be forwarded to `pw ingress `
231+ over SMTP. No shell scripts, no special user accounts, no database grants.
232232
233233.. note ::
234234
235- The `` pw ingress ` ` daemon matches incoming emails to projects by their
236- `` List-ID `` header. Make sure the `` -e `` (list email) and `` -i ` ` (list ID)
235+ The `pw ingress ` daemon matches incoming emails to projects by their
236+ `List-ID ` header. Make sure the `-e ` (list email) and `-i ` (list ID)
237237 values of your project match what your mailing list software produces.
238238
239239IMAP/POP3
@@ -254,26 +254,26 @@ __ http://pyropus.ca/software/getmail/
254254Manual Import
255255~~~~~~~~~~~~~
256256
257- For one-off imports, `` pw ingress ` ` can read from stdin:
257+ For one-off imports, `pw ingress ` can read from stdin:
258258
259259.. code-block :: console
260260
261261 $ pw ingress --stdin < email.eml
262262 $ pw ingress --mbox < archive.mbox
263263
264- The `` --list-id `` flag can be used to override the `` List-ID ` ` header.
264+ The `--list-id ` flag can be used to override the `List-ID ` header.
265265
266266
267267.. _deployment-vcs :
268268
269269(Optional) VCS Integration
270270--------------------------
271271
272- Patchwork can update patch states automatically when commits are pushed. A
273- `` post-receive ` ` Git hook can be configured to mark patches as "accepted" when
272+ Patchwork can update patch states automatically when commits are pushed.
273+ A ` post-receive ` Git hook can be configured to mark patches as "accepted" when
274274their corresponding commits land in the repository.
275275
276- Refer to the `` post-receive.hook ` ` script in the Patchwork source tree for an
276+ Refer to the `post-receive.hook ` script in the Patchwork source tree for an
277277example implementation that uses the REST API.
278278
279279
@@ -287,7 +287,8 @@ confirmations, and inactive users:
287287
288288 $ pw admin gc
289289
290- A cron job or systemd timer is recommended (e.g. ``/etc/cron.daily/patchwork-gc ``):
290+ A cron job or systemd timer is recommended (e.g.
291+ `/etc/cron.daily/patchwork-gc `):
291292
292293.. code-block :: bash
293294
0 commit comments