.\"
.\" Copyright (c) 2021-2022 David Demelier <markand@malikania.fr>
.\"
.\" Permission to use, copy, modify, and/or distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd June 30, 2021-2022
.Dt SCIWORKERD 8
.Os
.\" NAME
.Sh NAME
.Nm sciworkerd
.Nd sci worker daemon
.\" SYNOPSIS
.Sh SYNOPSIS
.Nm
.Op Fl j Ar maxbuilds
.Op Fl k Ar key
.Op Fl t Ar timeout
.Op Fl u Ar url
.Op Fl w Ar workername
.\" DESCRIPTION
.Sh DESCRIPTION
The
.Nm
daemon waits indefinitely for jobs to execute and send back their result. It
requires an access to
.Xr scid 8
running.
.Pp
It is
.Em strongly
advised to run
.Nm
in a clean chroot environment, otherwise you can fetch untrusted scripts if the
remote
.Nm scid
gets compromised.
.Pp
It is part of the
.Xr sci 7
continuous integration framework.
.Pp
The following options are available:
.Bl -tag
.It Fl j
Set the maximum number of parallel builds allowed to
.Ar maxbuilds .
Defaults: 4.
.It Fl k Ar key
Set the API authentication to
.Ar key .
.It Fl t Ar timeout
Defines in seconds the
.Ar timeout
before a job will be killed. Default: 600 seconds.
.It Fl u
Set the
.Ar url
for connecting to
.Xr scid 8 .
You can specify a scheme using
.Dq http://
or
.Dq https:// .
Default:
.Dq localhost .
.It Fl w
Specify which worker this daemon should refer to using
.Ar worker
as worker name. Default:
.Dq default
.El
.\" ENVIRONMENT
.Sh ENVIRONMENT
The following environment variables affects
.Nm :
.Bl -tag
.It Ev SCI_API_URL
Points to a HTTP URL where
.Nm scid
is running. Must start with a HTTP scheme such as
.Dq http
or
.Dq https .
.It Ev SCI_API_KEY
Secret API key to perform requests.
.It Ev SCI_WORKER
Defines the worker name to connect as.
.El
.\" EXAMPLES
.Sh EXAMPLES
Register as openbsd worker
.Bd -literal -offset indent
$ sciworkerd -w openbsd
.Ed
.Pp
Run with maximum of four tasks in parallel with a timeout of five minutes
.Bd -literal -offset indent
$ sciworkerd -j 4 -t 300
.Ed
.\" SEE ALSO
.Sh SEE ALSO
.Xr sci 7 ,
.Xr scictl 8 ,
.Xr scid 8