summaryrefslogtreecommitdiffhomepage
path: root/tools (follow)
AgeCommit message (Collapse)AuthorFilesLines
2023-10-16Tools: unitc Docker mode.Liam Crilly2-21/+43
Introduces a new remote host scheme docker:// that specifies a local container ID. By default, the control socket is assumed to be in the default location, as per the Docker Official Images for Unit. If not, the path to the control socket can be appended to the container ID.
2023-10-10Tools: unitc YAML mode.Liam Crilly2-7/+55
Added --format option to manage configuration in other formats. Initially, YAML is the only supported conversion format. JSON/YAML conversion is performed with yq(1). Suggested by: Torstein Krause Johansen <https://github.com/skybert> Closes: #958 <https://github.com/nginx/unit/issues/958>
2023-10-03Tools: unitc quiet mode fix for macOS.Liam Crilly1-1/+1
head -c 0 does not work on macOS (invalid byte count) but tail(1) is happy to accept zero bytes, and does not have a performance penalty.
2023-06-30Tools: setup-unit: ctl: added "edit" subcommand.Alejandro Colomar1-0/+112
Almost equivalent to b42f6b1d ("Tools: unitc edit mode for interactive configuration."), implemented by Liam in tools/unitc. I chose to give preference to vi(1) over vim(1) because Debian has vi(1) as part of update-alternatives(1), so that sysadmins can configure it to be a symlink to their favourite vi(1) implementation or variant. We're ignoring the errors of the commands due to having the SSH tunnel open. I should fix the script to use traps to close the tunnel on any error, so we don't leak tunnels. Then, we'll be able to not ignore curl(1) or editor errors. That will also probably allow moving the tunneling code to the ctl command, thus deduplicating code. Cc: Liam Crilly <liam@nginx.com> Cc: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-06-27Tools: setup-unit: restart: added -l and -s flags.Alejandro Colomar1-2/+46
Add flags for cleaning the log file and state dir. Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-06-27Tools: setup-unit: added restart command.Alejandro Colomar1-0/+51
It restarts all running unitd instances. This is useful when recompiling unitd often, so that the latest build is running, without having to manually kill unitd instances and re-run with the same exact command line every time. Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-06-27Tools: setup-unit: ps: forcing full lines from ps(1).Alejandro Colomar1-1/+1
Some ps(1) implementations trim lines to 80 columns, even if the output is being piped. Let's force ps(1) to output full lines with `ww`, which is not in POSIX, but seems to be portable enough. On 2023-06-08 13:19, Andrew Clayton wrote: > Just for posterity... > > BusyBox ps(1) knows about a grand total of 2 options! > > BusyBox v1.35.0 (2022-11-19 10:13:10 UTC) multi-call binary. > > Usage: ps [-o COL1,COL2=HEADER] [-T] > > Show list of processes > > -o COL1,COL2=HEADER Select columns for display > -T Show threads > > But at least it doesn't make it worse. In fact all of these three do > exactly the same thing > > ps > ps ax > ps axww > > I.e it ignores any non option argument... > > It does however help on OpenIndiana... Link: <https://github.com/nginx/unit/issues/875> Link: <https://github.com/nginx/unit/issues/886> Link: <https://github.com/nginx/unit/pull/885> Cc: <https://github.com/mattxtaz> Cc: Liam Crilly <liam@nginx.com> Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-06-27Tools: setup-unit: using $0 is simpler.Alejandro Colomar1-31/+28
Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-06-07Tools: unitc edit mode for interactive configuration.Liam Crilly2-2/+27
2023-06-01Tools: improved ps(1) portability for unitc.Liam Crilly1-4/+19
Improved cross-platform support by trying multiple ps(1) invocations to obtain the unitd command line parameters. Additional error checking detects when this process fails. The first attempt uses `ps -wwo args=COMMAND -p` which has very broad support and has the additional benefit of simplifying the output for more reliable parsing of the process info. If that fails then we fall back to simply `ps`. The parsing of the process info has also changed. Instead of converting '[]' into spaces we now convert them into explicit delimiters (using '^'). This is more reliable as it marks the beginning and the end of the info we care about. Any trailing process information is now ignored (FreeBSD). Additional error handling improves the robustness when starting unitd with a different filename or from a relative path. In this case the control socket and log file detection will fail when running `unitd --help`. Additional error checking and messages are displayed when the control socket cannot be determined. A single warning is shown when the log file cannot be determined.
2023-05-24Updated copyright notice.Andrei Zeliankou2-2/+2
2023-04-15Tools: setup-unit: unified repeated code.Alejandro Colomar1-9/+7
Instead of doing the same operation in each subcommand, do it once in the parent. Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-04-04Tools: use control socket and log file from running instance.Liam Crilly1-2/+2
If unitd was started with an explicit path then unitc will use that binary instead of the default PATH to obtain the default control socket and log file locations.
2023-03-29Renamed --libstatedir to --statedir.Alejandro Colomar1-3/+3
In BSD systems, it's usually </var/db> or some other dir under </var> that is not </var/lib>, so $statedir is a more generic name. See hier(7). Reported-by: Andrei Zeliankou <zelenkov@nginx.com> Reported-by: Zhidao Hong <z.hong@f5.com> Reviewed-by: Konstantin Pavlov <thresh@nginx.com> Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Cc: Liam Crilly <liam@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-02-27Tools: improved detection of unitd control socket.Liam Crilly1-5/+5
Now unitc obtains the path to the unitd binary from information contained in the unitd: main process. If unitd was started with an explicit path then that path will be used to obtain the default control socket, instead of using the unitd binary in $PATH.
2023-02-20Tools: using nicer characters for showing a tree.Alejandro Colomar1-19/+19
Especially in small trees, ASCII characters are confusing. Use nicer UTF-8 characters, which are more readable to the audience of this script. We don't expect the audience of this script to have limited environments where these characters will not be shown, but if that happens, we could improve the script to select the caracters based on the locale. Suggested-by: Liam Crilly <liam@nginx.com> Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-01-31Added default values for pathnames.Alejandro Colomar1-3/+3
This allows one to simply run `./configure` and expect it to produce sane defaults for an install. Previously, without specifying `--prefix=...`, `make install` would simply fail, recommending to set `--prefix` or `DESTDIR`, but that recommendation was incomplete at best, since it didn't set many of the subdirs needed for a good organization. Setting `DESTDIR` was even worse, since that shouldn't even affect an installation (it is required to be transparent to the installation). /usr/local is the historic Unix standard path to use for installations from source made manually by the admin of the system. Some package managers (Homebrew, I'm looking specifically at you) have abused that path to install their things, but 1) it's not our fault that someone else incorrectly abuses that path (and they seem to be fixing it for newer archs; e.g., they started using /opt/homebrew for Apple Silicon), 2) there's no better path than /usr/local, 3) we still allow changing it for systems where this might not be the desired path (MacOS Intel with hombrew), and 4) it's _the standard_. See a related conversation with Ingo (OpenBSD maintainer): On 7/27/22 16:16, Ingo Schwarze wrote: > Hi Alejandro, [...] > > Alejandro Colomar wrote on Sun, Jul 24, 2022 at 07:07:18PM +0200: >> On 7/24/22 16:57, Ingo Schwarze wrote: >>> Alejandro Colomar wrote on Sun, Jul 24, 2022 at 01:20:46PM +0200: > >>>> /usr/local is for sysadmins to build from source; > >>> Doing that is *very* strongly discouraged on OpenBSD. > >> I guess that's why the directory was reused in the BSDs to install ports >> (probably ports were installed by the sysadmin there, and by extension, >> ports are now always installed there, but that's just a guess). > > Maybe. In any case, the practice of using /usr/local for packages > created from ports is significantly older than the recommendation > to refrain from using upstream "make install" outside the ports > framework. > > * The FreeBSD ports framework was started by Jordan Hubbard in 1993. > * The ports framework was ported from FreeBSD to OpenBSD > by Niklas Hallqvist in 1996. > * NetBSD pkgsrc was forked from FreeBSD ports by Alistair G. Crooks > and Hubert Feyrer in 1997. > > I failed to quickly find Jordan's original version, but rev. 1.1 > of /usr/ports/infrastructure/mk/bsd.port.mk in OpenBSD (dated Jun 3 > 22:47:10 1996 UTC) already said > > LOCALBASE ?= /usr/local > PREFIX ?= ${LOCALBASE} > [...] >> I had a discussion in NGINX Unit about it, and >> the decission for now has been: "support prefix=/usr/local for default >> manual installation through the Makefile, and let BSD users adjust to >> their preferred path". > > That's an *excellent* solution for the task, thanks for doing it > the right way. By setting PREFIX=/usr/local by default in the > upstream Makefile, you are minimizing the work for *BSD porters. > > The BSD ports frameworks will typically run the upstreak "make install" > with the variable DESTDIR set to a custom value, for example > > DESTDIR=/usr/ports/pobj/groff-1.23.0/fake-amd64 > > so if the upstream Makefile sets PREFIX=/usr/local , > that's perfect, everything gets installed to the right place > without an intervention by the person doing the porting. > > Of course, if the upstream Makefile would use some other PREFIX, > that would not be a huge obstacle. All we have to do in that case > is pass the option --prefix=/usr/local to the ./configure script, > or something equivalent if the software isn't using GNU configure. > >> We were concerned that we might get collisions >> with the BSD port also installing in /usr/local, but that's the least >> evil (and considering BSD users don't typically run `make install`, it's >> not so bad). > > It's not bad at all. It's perfect. > > Of course, if a user wants to install *without* the ports framework, > they have to provide their own --prefix. But that's not an issue > because it is easy to do, and installing without a port is discouraged > anyway. === Directory variables should never contain a trailing slash (I've learned that the hard way, where some things would break unexpectedly). Especially, make(1) is likely to have problems when things have double slashes or a trailing slash, since it treats filenames as text strings. I've removed the trailing slash from the prefix, and added it to the derivate variables just after the prefix. pkg-config(1) also expects directory variables to have no trailing slash. === I also removed the code that would set variables as depending on the prefix if they didn't start with a slash, because that is a rather non-obvious behavior, and things should not always depend on prefix, but other dirs such as $(runstatedir), so if we keep a similar behavior it would be very unreliable. Better keep variables intact if set, or use the default if unset. === Print the real defaults for ./configure --help, rather than the actual values. === I used a subdirectory under the standard /var/lib for NXT_STATE, instead of a homemade "state" dir that does the same thing. === Modified the Makefile to create some dirs that weren't being created, and also remove those that weren't being removed in uninstall, probably because someone forgot to add them. === Add new options for setting the new variables, and rename some to be consistent with the standard names. Keep the old ones at configuration time for compatibility, but mark them as deprecated. Don't keep the old ones at exec time. === A summary of the default config is: Unit configuration summary: bin directory: ............. "/usr/local/bin" sbin directory: ............ "/usr/local/sbin" lib directory: ............. "/usr/local/lib" include directory: ......... "/usr/local/include" man pages directory: ....... "/usr/local/share/man" modules directory: ......... "/usr/local/lib/unit/modules" state directory: ........... "/usr/local/var/lib/unit" tmp directory: ............. "/tmp" pid file: .................. "/usr/local/var/run/unit/unit.pid" log file: .................. "/usr/local/var/log/unit/unit.log" control API socket: ........ "unix:/usr/local/var/run/unit/control.unit.sock" Link: <https://www.gnu.org/prep/standards/html_node/Directory-Variables.html> Link: <https://refspecs.linuxfoundation.org/FHS_3.0/fhs/index.html> Reviewed-by: Artem Konev <a.konev@f5.com> Reviewed-by: Andrew Clayton <a.clayton@nginx.com> Tested-by: Andrew Clayton <a.clayton@nginx.com> Reviewed-by: Konstantin Pavlov <thresh@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-01-02Tools: setup-unit: disabled buggy behavior of zsh(1).Alejandro Colomar1-0/+3
Reported-by: Liam Crilly <liam@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-01-02Tools: setup-unit: workarounded macOS tmp file permissions.Alejandro Colomar1-1/+4
mktemp(1) in macOS uses a weird directory where only the running user has permissions. If we use that for the welcome website, unitd(8) won't be able to read the page. Use a directory at $HOME before trying a tmpdir. Reported-by: Liam Crilly <lcrilly@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2023-01-02Tools: setup-unit: removed root checks.Alejandro Colomar1-8/+0
Reported-by: Liam Crilly <lcrilly@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2022-12-19Tools: unitc avoid interactive rm(1) invocations.Liam Crilly1-3/+3
2022-12-16Tools: Fixed bug in help message.Alejandro Colomar1-1/+1
'sudo' was misplaced. Signed-off-by: Alejandro Colomar <alx@nginx.com>
2022-12-16Tools: Using HereDoc instead of echo(1).Alejandro Colomar1-5/+7
This prevents accidents, which are likely to happen especially with quotes. Signed-off-by: Alejandro Colomar <alx@nginx.com>
2022-12-16Tools: fixed quoting for apostrophe in setup-unit.Liam Crilly1-1/+1
2022-12-14Tools: Updated built-in 'setup-unit' help, README.md command lines.Artem Konev1-66/+63
2022-12-14Tools: Added subcommands to setup-unit.Alejandro Colomar1-211/+1400
This script combines the old setup-unit (as the repo-config command), with new functionality, to provide an easy welcome website for first-time users, and also some more commands that are useful for administrating a running unitd(8) instance. Suggested-by: Liam Crilly <liam@nginx.com> Cc: Konstantin Pavlov <thresh@nginx.com> Cc: Artem Konev <a.konev@f5.com> Cc: Timo Start <t.stark@nginx.com> Cc: Andrew Clayton <a.clayton@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>
2022-12-14Tools: Added unitc.Liam Crilly2-0/+310
2022-12-03Added tools/README.md.Liam Crilly1-0/+16
2022-11-22Tools: Added setup-unit.Konstantin Pavlov1-0/+311
Downloaded from <https://unit.nginx.org/_downloads/setup-unit.sh>. Acked-by: Artem Konev <a.konev@f5.com> Acked-by: Konstantin Pavlov <thresh@nginx.com> Signed-off-by: Alejandro Colomar <alx@nginx.com>