service-install 0.5.6

Easily provide users an install method on Linux systems
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

> ** Easily provide users an install method**

[![Crates.io](https://img.shields.io/crates/v/service-install?style=flat-square)](https://crates.io/crates/service-install)
[![Crates.io](https://img.shields.io/crates/d/service-install?style=flat-square)](https://crates.io/crates/service-install)
[![API](https://docs.rs/service-install/badge.svg)](https://docs.rs/service-install)
[![License](https://img.shields.io/badge/license-MIT-blue?style=flat-square)](LICENSE-MIT)

**Note this is an early release, there might be bugs**

This crate provides the building blocks to build an installer for self contained
binaries without runtime dependencies. Such an installer provides less technical
users with an easy way to set up your program. It is not a full alternative for
integrating with a package manager. For example there is no way to provide
updates. Building your own installer is however significantly less work then
trying to get your application in all the Linux package managers. It is also
ideal for tools that are not public. 

### Features
 - Set up a service to run the application on boot or a schedule
 - Perform the install step by step or in one go
 - Print each step or all at once (or make a tui/prompt!)
 - Roll back on failure
 - Configure the install location or find a suitable one automatically
 - Specify which user the service should run as
 - Undo the installation tearing down the service and removing the files

### Example
Installing the current program as a user service named `cli` that should run at
10:42 every day. This does not need superuser/admin permissions.

```rust,ignore
use service_install::{install_user, schedule::Schedule};
use time::Time;

fn main() {
    let schedule = Schedule::Daily(Time::from_hms(10, 42, 00).unwrap());
    let done = install_user!()
        .current_exe()
        .unwrap()
        .service_name("cli")
        .on_schedule(schedule)
        .prepare_install()
        .unwrap()
        .install()
        .unwrap();
}
```
For more detailed examples (such as a working Tui/Prompt) see the examples on [GitHub](https://github.com/dvdsk/service-install/tree/main/examples). For a detailed description of all these options look at the install [`Spec`].

### Future work
 - Make the pre build TUI/Prompt more customizable.
 - Windows support (could use some help here, not a big windows user myself)

### Contribution
Please let me know if there is anything you would like to see! PR's and issues
are very welcome!