Mercurial > sci
annotate man/sciworkerd.8 @ 66:5076be758687 0.1.0
misc: update before 0.1.0 release
| author | David Demelier <markand@malikania.fr> |
|---|---|
| date | Sat, 20 Aug 2022 10:36:55 +0200 |
| parents | 562372396019 |
| children | 71cd8447e3a4 |
| 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 | |
|
64
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
26 .Op Fl j Ar maxbuilds |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
27 .Op Fl k Ar key |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
28 .Op Fl t Ar timeout |
| 13 | 29 .Op Fl u Ar url |
| 30 .Op Fl w Ar workername | |
| 31 .\" DESCRIPTION | |
| 32 .Sh DESCRIPTION | |
| 33 The | |
| 34 .Nm | |
| 35 daemon waits indefinitely for jobs to execute and send back their result. It | |
| 36 requires an access to | |
| 37 .Xr scid 8 | |
| 35 | 38 running. |
| 39 .Pp | |
| 40 It is | |
| 41 .Em strongly | |
| 42 advised to run | |
| 43 .Nm | |
| 44 in a clean chroot environment, otherwise you can fetch untrusted scripts if the | |
| 45 remote | |
| 46 .Nm scid | |
| 47 gets compromised. | |
| 13 | 48 .Pp |
| 49 It is part of the | |
| 50 .Xr sci 7 | |
| 51 continuous integration framework. | |
| 52 .Pp | |
| 53 The following options are available: | |
| 54 .Bl -tag | |
|
64
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
55 .It Fl j |
| 13 | 56 Set the maximum number of parallel builds allowed to |
| 57 .Ar maxbuilds . | |
| 58 Defaults: 4. | |
|
64
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
59 .It Fl k Ar key |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
60 Set the API authentication to |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
61 .Ar key . |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
62 .It Fl t Ar timeout |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
63 Defines in seconds the |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
64 .Ar timeout |
|
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
65 before a job will be killed. Default: 600 seconds. |
| 13 | 66 .It Fl u |
| 67 Set the | |
| 68 .Ar url | |
| 69 for connecting to | |
| 35 | 70 .Xr scid 8 . |
| 13 | 71 You can specify a scheme using |
| 72 .Dq http:// | |
| 73 or | |
| 74 .Dq https:// . | |
| 75 Default: | |
| 76 .Dq localhost . | |
| 77 .It Fl w | |
| 78 Specify which worker this daemon should refer to using | |
| 79 .Ar worker | |
| 80 as worker name. Default: | |
| 81 .Dq default | |
| 82 .El | |
|
52
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
83 .\" ENVIRONMENT |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
84 .Sh ENVIRONMENT |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
85 The following environment variables affects |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
86 .Nm : |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
87 .Bl -tag |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
88 .It Ev SCI_API_URL |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
89 Points to a HTTP URL where |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
90 .Nm scid |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
91 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
|
92 .Dq http |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
93 or |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
94 .Dq https . |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
95 .It Ev SCI_API_KEY |
|
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
96 Secret API key to perform requests. |
|
64
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
97 .It Ev SCI_WORKER |
|
562372396019
misc: improve manual pages and documentation
David Demelier <markand@malikania.fr>
parents:
52
diff
changeset
|
98 Defines the worker name to connect as. |
|
52
95bc6b4ec753
sciworkerd: add API key support
David Demelier <markand@malikania.fr>
parents:
35
diff
changeset
|
99 .El |
|
66
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
100 .\" EXAMPLES |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
101 .Sh EXAMPLES |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
102 Register as openbsd worker |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
103 .Bd -literal -offset indent |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
104 $ sciworkerd -w openbsd |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
105 .Ed |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
106 .Pp |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
107 Run with maximum of four tasks in parallel with a timeout of five minutes |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
108 .Bd -literal -offset indent |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
109 $ sciworkerd -j 4 -t 300 |
|
5076be758687
misc: update before 0.1.0 release
David Demelier <markand@malikania.fr>
parents:
64
diff
changeset
|
110 .Ed |
| 13 | 111 .\" SEE ALSO |
| 112 .Sh SEE ALSO | |
| 113 .Xr sci 7 , | |
| 114 .Xr scictl 8 , | |
| 35 | 115 .Xr scid 8 |