Skip to content

Commit 61372bd

Browse files
committed
readme: add quickstart guide
Give newcomers a self-contained sequence of commands to build, configure, and start patchwork from scratch. Signed-off-by: Robin Jarry <robin@jarry.cc>
1 parent 5571121 commit 61372bd

1 file changed

Lines changed: 33 additions & 5 deletions

File tree

‎README.md‎

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,36 @@ of community projects.
1919

2020
> [!NOTE]
2121
>
22-
> This project is the "next" version of patchwork rewritten in Go for:
23-
>
24-
> - Speed (Python and especially Django are super slow)
25-
> - Ease of development (Virtual Envs get annoying fast)
26-
> - Ease of deployment (single native binary VS hundreds of text files)
22+
> This is the 4.0 rewrite of Patchwork in Go, replacing the Django/Python
23+
> codebase with a single statically compiled binary.
24+
25+
## Quickstart
26+
27+
Build and install:
28+
29+
make
30+
sudo make install
31+
32+
Generate a configuration file and edit it:
33+
34+
pw config > /etc/patchwork.toml
35+
vim /etc/patchwork.toml
36+
37+
Initialize the database, create an admin user and a project:
38+
39+
pw db sync
40+
pw admin user create --admin -u admin -e admin@example.com
41+
pw admin project create \
42+
-n "My Project" -l my-project \
43+
-i my-project.example.com -e patches@example.com
44+
45+
Start the services:
46+
47+
pw http &
48+
pw ingress &
49+
50+
The web interface is now available at http://127.0.0.1:8080 and the SMTP
51+
ingress daemon listens on 127.0.0.1:2525.
52+
53+
For production deployment with systemd, nginx and Postfix, see the
54+
[deployment guide](docs/deployment/installation.rst).

0 commit comments

Comments
 (0)