Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

setup

package

Go to main page

Versions in this module

v0

v0.2.2

Feb 5, 2026

v0.2.1

Dec 16, 2025

v0.2.0

Dec 12, 2025

v0.1.2

Dec 10, 2025

v0.1.1

Dec 9, 2025

v0.1.0

Dec 1, 2025

v0.0.18

Nov 18, 2025

v0.0.17

Oct 31, 2025

v0.0.16

Oct 8, 2025

v0.0.15

Oct 7, 2025

Changes in this version

+ const PiriServeCommand

+ const PiriServiceFile

+ const PiriServiceName

+ const PiriUpdateBootDuration

+ const PiriUpdateCommand

+ const PiriUpdateRandomizedDelayDuration

+ const PiriUpdateServiceFile

+ const PiriUpdateTimerName

+ const PiriUpdateTimerServiceFile

+ const PiriUpdateUnitActiveDuration

+ const ReleaseURL

+ var Config = DefaultPathConfig()

+ var InitCmd = &cobra.Command

+ var InstallCmd = &cobra.Command

+ var InternalUpdateCmd = &cobra.Command

+ var PiriBinaryBaseDir = Config.BinaryBaseDir

+ var PiriBinaryPath = Config.BinaryPath

+ var PiriCLISymlinkPath = Config.CLISymlinkPath

+ var PiriConfigFileName = Config.ConfigFileName

+ var PiriCurrentSymlink = Config.CurrentSymlink

+ var PiriOptDir = Config.OptDir

+ var PiriServerShutdownTimeout = Config.ServerShutdown

+ var PiriServiceFilePath = filepath.Join(Config.SystemdPath, PiriServiceFile)

+ var PiriSudoersFile = Config.SudoersFile

+ var PiriSystemConfigPath = filepath.Join(Config.SystemDir, Config.ConfigFileName)

+ var PiriSystemDir = Config.SystemDir

+ var PiriSystemdBaseDir = Config.SystemdBaseDir

+ var PiriSystemdCurrentSymlink = Config.SystemdCurrentSymlink

+ var PiriSystemdDir = Config.SystemdCurrentSymlink

+ var PiriSystemdShutdownBuffer = Config.SystemdBuffer

+ var PiriUpdateServiceFilePath = filepath.Join(Config.SystemdPath, PiriUpdateServiceFile)

+ var PiriUpdateTimerServiceFilePath = filepath.Join(Config.SystemdPath, PiriUpdateTimerServiceFile)

+ var SupportedLinuxArch = map[string]bool

+ var SystemDPath = Config.SystemdPath

+ var UninstallCmd = &cobra.Command

+ var UpdateCmd = &cobra.Command

+ func FileExists(path string) bool

+ func GetExecutablePath() (string, error)

+ func IsSymlink(path string) bool

+ func NeedsElevatedPrivileges(path string) bool

+ type CommandExecutor interface

+ Output func(name string, args ...string) ([]byte, error)

+ Run func(name string, args ...string) error

+ type FileSystemManager struct

+ CreatedDirs []string

+ CreatedFiles []string

+ func NewFileSystemManager() *FileSystemManager

+ func (fsm *FileSystemManager) CheckExistingFiles(files []string) error

+ func (fsm *FileSystemManager) CopyFile(src, dst string, perm os.FileMode) error

+ func (fsm *FileSystemManager) CreateDirectory(path string, perm os.FileMode) error

+ func (fsm *FileSystemManager) CreatePiriDirectoryStructure(version string) error

+ func (fsm *FileSystemManager) CreateSymlink(oldpath, newpath string) error

+ func (fsm *FileSystemManager) RemoveFiles(files []string) error

+ func (fsm *FileSystemManager) Rollback() error

+ func (fsm *FileSystemManager) SetOwnership(path string, username string) error

+ func (fsm *FileSystemManager) SetOwnershipFromPath(targetPath, referencePath string) error

+ func (fsm *FileSystemManager) UpdateSymlinkAtomic(symlinkPath, newTarget string) (oldTarget string, rollback func() error, err error)

+ func (fsm *FileSystemManager) WriteFile(path string, data []byte, perm os.FileMode) error

+ type GitHubRelease struct

+ Assets []struct{ ... }

+ CreatedAt time.Time

+ Draft bool

+ Name string

+ Prerelease bool

+ TagName string

+ type InstallState struct

+ Config config.FullServerConfig

+ ConfigPath string

+ EnableAutoUpdate bool

+ Force bool

+ IsUpdate bool

+ ServiceUser string

+ Version string

+ type Installer struct

+ FileSystem *FileSystemManager

+ Platform *PlatformChecker

+ ServiceManager *ServiceManager

+ func NewInstaller() (*Installer, error)

+ func (i *Installer) Cleanup(cmd *cobra.Command, enableAutoUpdate bool) error

+ func (i *Installer) CreateSudoersEntry(cmd *cobra.Command, serviceUser string, enableAutoUpdate bool) error

+ func (i *Installer) CreateSymlink(cmd *cobra.Command) error

+ func (i *Installer) EnableAndStartServices(cmd *cobra.Command, enableAutoUpdate bool) error

+ func (i *Installer) GenerateSystemdServices(serviceUser string, version string) []ServiceFile

+ func (i *Installer) InstallBinary(cmd *cobra.Command, version string) error

+ func (i *Installer) InstallConfiguration(cmd *cobra.Command, cfg config.FullServerConfig) error

+ func (i *Installer) InstallSystemdServices(cmd *cobra.Command, state *InstallState) error

+ func (i *Installer) PerformInstallation(cmd *cobra.Command, state *InstallState) error

+ func (i *Installer) Uninstall(cmd *cobra.Command) error

+ type PathConfig struct

+ BinaryBaseDir string

+ BinaryPath string

+ CLISymlinkPath string

+ ConfigFileName string

+ CurrentSymlink string

+ OptDir string

+ ServerShutdown time.Duration

+ SudoersFile string

+ SystemDir string

+ SystemdBaseDir string

+ SystemdBuffer time.Duration

+ SystemdCurrentSymlink string

+ SystemdPath string

+ func DefaultPathConfig() *PathConfig

+ type PlatformChecker struct

+ HasSystemd bool

+ IsDarwin bool

+ IsLinux bool

+ IsRoot bool

+ OS string

+ ServiceUser string

+ func NewPlatformChecker() (*PlatformChecker, error)

+ func (pc *PlatformChecker) IsManagedInstallation(execPath string) bool

+ func (pc *PlatformChecker) IsRunningUnderSystemd() bool

+ func (pc *PlatformChecker) RequireLinux() error

+ func (pc *PlatformChecker) RequireRoot() error

+ func (pc *PlatformChecker) RequireSystemd() error

+ type Prerequisites struct

+ CheckFiles []string

+ CheckServices []string

+ NeedsRoot bool

+ NeedsSystemd bool

+ Platform *PlatformChecker

+ func (pr *Prerequisites) Validate(force bool) error

+ type ServiceFile struct

+ Content string

+ Name string

+ SourcePath string

+ TargetPath string

+ type ServiceManager struct

+ Services []string

+ func NewServiceManager(services ...string) *ServiceManager

+ func NewServiceManagerWithExecutor(executor CommandExecutor, services ...string) *ServiceManager

+ func (sm *ServiceManager) CheckServicesNotRunning() error

+ func (sm *ServiceManager) DisableService(service string) error

+ func (sm *ServiceManager) EnableAndStartService(service string) error

+ func (sm *ServiceManager) EnableService(service string) error

+ func (sm *ServiceManager) GetServiceStatus(service string) (*ServiceStatus, error)

+ func (sm *ServiceManager) InstallServiceFiles(services []ServiceFile) error

+ func (sm *ServiceManager) IsActive(service string) (bool, error)

+ func (sm *ServiceManager) ReloadDaemon() error

+ func (sm *ServiceManager) RemoveServiceFiles(files []string) error

+ func (sm *ServiceManager) RestartService(service string) error

+ func (sm *ServiceManager) RestartServiceWithSudo(service string) error

+ func (sm *ServiceManager) StartService(service string) error

+ func (sm *ServiceManager) StopAllServices() error

+ func (sm *ServiceManager) StopAndDisableService(service string) error

+ func (sm *ServiceManager) StopService(service string) error

+ func (sm *ServiceManager) VerifyServiceRestart(service string, timeoutSec int, useSudo bool) error

+ type ServiceStatus struct

+ Active bool

+ Enabled bool

+ Failed bool

+ Name string

+ Running bool

+ type UpdateInfo struct

+ CurrentVersion string

+ LatestVersion string

+ NeedsUpdate bool

+ Release *GitHubRelease