systemdinstaller

Documentation

Overview

Util for programmatically writing systemd unit file so your service can be autostarted

Index

• func EnableAndStartCommandHints(sf ServiceDefinition) string
• func Install(sf ServiceDefinition) error
• func RequireNetworkOnline(sf *ServiceDefinition)
• type Option
  • func After(after string) Option
  • func Args(args ...string) Option
  • func BindsTo(to string) Option
  • func Docs(docs ...string) Option
  • func Env(key string, value string) Option
  • func WaitNetworkInterface(interfaceName string) Option
  • func Wants(wants string) Option
• type ServiceDefinition
  • func Service(serviceName string, description string, opts ...Option) ServiceDefinition
  • func UserService(serviceName string, description string, opts ...Option) ServiceDefinition

Functions

func EnableAndStartCommandHints

func EnableAndStartCommandHints(sf ServiceDefinition) string

gives, among others, command hints for how to start the installed service

func Install

func Install(sf ServiceDefinition) error

installs the service

func RequireNetworkOnline

func RequireNetworkOnline(sf *ServiceDefinition)

https://unix.stackexchange.com/a/126146

Types

type Option

type Option func(*ServiceDefinition)

func After

func After(after string) Option

https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Before=

func Args

func Args(args ...string) Option

FIXME(security): args are not shell escaped - DO NOT TAKE THIS FROM USER INPUT

func BindsTo

func BindsTo(to string) Option

https://www.freedesktop.org/software/systemd/man/systemd.unit.html#BindsTo=

func Docs

func Docs(docs ...string) Option

func Env

func Env(key string, value string) Option

func WaitNetworkInterface

func WaitNetworkInterface(interfaceName string) Option

systemd automatically dynamically generates units for network devices, so we can wait + bind to them. you can find interesting units by invoking $ systemctl list-unit

func Wants

func Wants(wants string) Option

https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Wants=

type ServiceDefinition

type ServiceDefinition struct {
	// contains filtered or unexported fields
}

func Service

func Service(serviceName string, description string, opts ...Option) ServiceDefinition

func UserService

func UserService(serviceName string, description string, opts ...Option) ServiceDefinition

user-level service