Skip to content

Commit 41094d8

Browse files
committed
document installation
Signed-off-by: Paolo Bonzini <[email protected]>
1 parent cd36168 commit 41094d8

File tree

1 file changed

+41
-0
lines changed

1 file changed

+41
-0
lines changed

README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,47 @@ We accept PR on github for one-off/small contributions but it is encouraged to
3232
submit your patches with git-send-email to the Patchew development and
3333
discussion mailing list, [email protected].
3434

35+
## Installing
36+
37+
Patchew can be installed in a podman container; it is possible to connect
38+
the container to a webserver running on the host via either port 80 or a
39+
FastCGI socket.
40+
41+
Either SQLite or PostgreSQLcan be used as the database backend; the latter
42+
requires a separate container.
43+
44+
The `scripts/deploy` scripts is a wrapper script that uses Ansible to
45+
install the various components of Patchew. For example:
46+
47+
```
48+
# ./scripts/deploy --db localhost
49+
# systemctl enable patchew-server-db
50+
# ./scripts/deploy --server localhost
51+
# systemctl enable patchew-server
52+
```
53+
54+
A sample nginx configuration is as follows:
55+
56+
```
57+
upstream patchew-server {
58+
server unix:/data/patchew-server/data/nginx.sock fail_timeout=0;
59+
}
60+
61+
server {
62+
server_name patchew.org;
63+
proxy_set_header X-Forwarded-Host $host;
64+
proxy_set_header Host $host;
65+
location / {
66+
proxy_pass http://patchew-server;
67+
}
68+
proxy_connect_timeout 600;
69+
proxy_send_timeout 600;
70+
proxy_read_timeout 600;
71+
send_timeout 600;
72+
client_max_body_size 100M;
73+
}
74+
```
75+
3576
## Known issues
3677

3778
- Binary patches are not recognized correctly.

0 commit comments

Comments
 (0)