From f236b97cc998ef53f00083690f0f7b3ba2abf890 Mon Sep 17 00:00:00 2001 From: mycognosist Date: Thu, 14 May 2020 14:57:56 +0100 Subject: [PATCH] Add basic Debian packaging info --- src/SUMMARY.md | 1 + src/software/configuration.md | 4 ++-- src/software/packaging.md | 19 +++++++++++++++++++ 3 files changed, 22 insertions(+), 2 deletions(-) create mode 100644 src/software/packaging.md diff --git a/src/SUMMARY.md b/src/SUMMARY.md index 625dbf9..4f85674 100644 --- a/src/SUMMARY.md +++ b/src/SUMMARY.md @@ -17,6 +17,7 @@ - [peach-stats](./software/microservices/peach-stats.md) - [Web Interface](./software/web_interface.md) - [Pattern Library](./software/pattern_library.md) + - [Packaging](./software/packaging.md) - [Configuration](./software/configuration.md) - [Contributor's Guide](./contributors_guide.md) - [Licensing](./licensing.md) diff --git a/src/software/configuration.md b/src/software/configuration.md index 7b3736d..960e3d2 100644 --- a/src/software/configuration.md +++ b/src/software/configuration.md @@ -9,5 +9,5 @@ The microservices and other components comprising the PeachCloud software are co | peach-oled | `PEACH_OLED_SERVER` | HTTP server address and port for JSON-RPC | `127.0.0.1:5112` | | peach-stats | `PEACH_STATS_SERVER` | HTTP server address and port for JSON-RPC | `127.0.0.1:5113` | | peach-web | `ROCKET_ENV` | Web application deployment mode | `prod` | -| | `ROCKET_TEMPLATE_DIR` | Tera template directory | `static/templates` | -| | `PEACH_WEB_WS` | WebSocket server port | `5115` | +| peach-web | `ROCKET_TEMPLATE_DIR` | Tera template directory | `static/templates` | +| peach-web | `PEACH_WEB_WS` | WebSocket server port | `5115` | diff --git a/src/software/packaging.md b/src/software/packaging.md new file mode 100644 index 0000000..0449bab --- /dev/null +++ b/src/software/packaging.md @@ -0,0 +1,19 @@ +# Debian Packaging + +The microservices comprising the PeachCloud software suite are packaged for easy deployment and maintainance on Debian and derivative operating systems. + +Each microservice repository includes a `debian` directory which includes a `systemd` service file and Debian maintainer scripts, including `postinst`, `postrm` and `prerm` scripts. These scripts define behavior for installing and uninstalling the respective services. `deb` packages are created using the `cargo-deb` tool ([crate](https://crates.io/crates/cargo-deb)). + +Microservices can be installed with `dpkg` as follows: + +`sudo dpkg -i peach-network_0.1.0_arm64.deb` + +The service will be automatically enabled and started. + +Uninstall the service: + +`sudo apt-get remove peach-network` + +Remove configuration files (not removed with `apt-get remove`): + +`sudo apt-get purge peach-network`