Mercurial > sci
annotate man/sciworkerd.8 @ 52:95bc6b4ec753
sciworkerd: add API key support
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Wed, 17 Aug 2022 09:38:19 +0200 |
| parents | 084dee2bef50 |
| children | 562372396019 |
| rev | line source |
|---|---|
| 13 | 1 .\" |
|
32
081e1c258e64
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
2 .\" Copyright (c) 2021-2022 David Demelier <markand@malikania.fr> |
| 13 | 3 .\" |
| 4 .\" Permission to use, copy, modify, and/or distribute this software for any | |
| 5 .\" purpose with or without fee is hereby granted, provided that the above | |
| 6 .\" copyright notice and this permission notice appear in all copies. | |
| 7 .\" | |
| 8 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES | |
| 9 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF | |
| 10 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR | |
| 11 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES | |
| 12 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN | |
| 13 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF | |
| 14 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. | |
| 15 .\" | |
|
32
081e1c258e64
misc: update copyright years
David Demelier <markand@malikania.fr>
parents:
13
diff
changeset
|
16 .Dd June 30, 2021-2022 |
| 13 | 17 .Dt SCIWORKERD 8 |
| 18 .Os | |
| 19 .\" NAME | |
| 20 .Sh NAME | |
| 21 .Nm sciworkerd | |
| 22 .Nd sci worker daemon | |
| 23 .\" SYNOPSIS | |
| 24 .Sh SYNOPSIS | |
| 25 .Nm | |
| 26 .Op Fl m Ar maxbuilds | |
| 27 .Op Fl u Ar url | |
| 28 .Op Fl w Ar workername | |
| 29 .\" DESCRIPTION | |
| 30 .Sh DESCRIPTION | |
| 31 The | |
| 32 .Nm | |
| 33 daemon waits indefinitely for jobs to execute and send back their result. It | |
| 34 requires an access to | |
| 35 .Xr scid 8 | |
| 35 | 36 running. |
| 37 .Pp | |
| 38 It is | |
| 39 .Em strongly | |
| 40 advised to run | |
| 41 .Nm | |
| 42 in a clean chroot environment, otherwise you can fetch untrusted scripts if the | |
| 43 remote | |
| 44 .Nm scid | |
| 45 gets compromised. | |
| 13 | 46 .Pp |
| 47 It is part of the | |
| 48 .Xr sci 7 | |
| 49 continuous integration framework. | |
| 50 .Pp | |
| 51 The following options are available: | |
| 52 .Bl -tag | |
| 53 .It Fl m | |
| 54 Set the maximum number of parallel builds allowed to | |
| 55 .Ar maxbuilds . | |
| 56 Defaults: 4. | |
| 57 .It Fl u | |
| 58 Set the | |
| 59 .Ar url | |
| 60 for connecting to | |
| 35 | 61 .Xr scid 8 . |
| 13 | 62 You can specify a scheme using |
| 63 .Dq http:// | |
| 64 or | |
| 65 .Dq https:// . | |
| 66 Default: | |
| 67 .Dq localhost . | |
| 68 .It Fl w | |
| 69 Specify which worker this daemon should refer to using | |
| 70 .Ar worker | |
| 71 as worker name. Default: | |
| 72 .Dq default | |
| 73 .El | |
|
52
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
74 .\" ENVIRONMENT |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
75 .Sh ENVIRONMENT |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
76 The following environment variables affects |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
77 .Nm : |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
78 .Bl -tag |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
79 .It Ev SCI_API_URL |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
80 Points to a HTTP URL where |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
81 .Nm scid |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
82 is running. Must start with a HTTP scheme such as |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
83 .Dq http |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
84 or |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
85 .Dq https . |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
86 .It Ev SCI_API_KEY |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
87 Secret API key to perform requests. |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
88 .El |
| 13 | 89 .\" SEE ALSO |
| 90 .Sh SEE ALSO | |
| 91 .Xr sci 7 , | |
| 92 .Xr scictl 8 , | |
| 35 | 93 .Xr scid 8 |