From f63a624743ef73f417b569ecadded8d4046c338e Mon Sep 17 00:00:00 2001 From: Paul van Tilburg Date: Fri, 23 Apr 2021 19:11:42 +0200 Subject: [PATCH] Add text about using cargo-deb to the README --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 32fa6572..b128e811 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,26 @@ Check out the [Conduit 1.0 Release Milestone](https://gitlab.com/famedly/conduit Download or compile a Conduit binary, set up the config and call it from somewhere like a systemd script. [Read more](DEPLOY.md) +##### Deloy using a Debian package + +You need to have the `deb` helper command installed that creates Debian packages from Cargo projects (see [cargo-deb](https://github.com/mmstick/cargo-deb/) for more info): + +```shell +$ cargo install cargo-deb +``` + +Then, you can create and install a Debian package at a whim: + +```shell +$ cargo deb +$ dpkg -i target/debian/matrix-conduit_0.1.0_amd64.deb +``` + +This will build, package, install, configure and start Conduit. [Read more](debian/README.Debian). + +Note that `cargo deb` supports [cross-compilation](https://github.com/mmstick/cargo-deb/#cross-compilation) too! +Official Debian packages will follow once Conduit starts to have stable releases. + ##### Deploy using Docker Pull and run the docker image with