Crate service_install

Source
Expand description

** Easily provide users an install method**

Crates.io Crates.io API License

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.

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. 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!

Re-exports§

pub use install::Spec;
pub use schedule::Schedule;

Modules§

install
Installation (or removal) configuration, steps, and errors.
schedule
Scheduling options
tui
A pre made basic TUI that functions as an install and removal wizard

Macros§

install_system
Create a new Spec for a system wide installation
install_user
Create a new Spec for an installation for the current user only

Enums§

Tense
Changes the tense of the string returned by the describe functions for InstallStep, RemoveStep and Rollback. Final punctuation is missing and must be added.