.TH mfsgui "8" "June 2025" "MooseFS 4.57.7-1" "This is part of MooseFS"
.SH NAME
mfsgui \- start, restart or stop MooseFS GUI server
.SH SYNOPSIS
.B mfsgui
[\fB\-c\fP \fICFGFILE\fP]
[\fB\-f\fP]
[\fB\-d\fP]
[\fB\-u\fP]
[\fB\-n\fP]
[\fB\-t\fP \fILOCKTIMEOUT\fP]
[\fIACTION\fP]
.PP
.B mfsgui \-v
.PP
.B mfsgui \-h
.SH DESCRIPTION
.PP
\fBmfsgui\fP is the MooseFS GUI server. It consist of a HTTP server and scripts that make up the GUI interface to MooseFS. The user can access the GUI via any web browser, using the IP (or appropriate domain name) and port defined in \fBmfsgui.cfg\fP.
.SH OPTIONS
.TP
\fB\-v\fP
print version information and exit
.TP
\fB\-h\fP
print usage information and exit
.TP
\fB\-c\fP \fICFGFILE\fP
specify alternative path of configuration file (default is
\fBmfsgui.cfg\fP in system configuration directory)
.TP
\fB\-f\fP
run in foreground, don't daemonize
.TP
\fB\-d\fP
run with dangerous options (names: DANGEROUS_*)
.TP
\fB\-u\fP
log undefined configuration values (when default is assumed)
.TP
\fB\-n\fP
do not attempt to increase limit of core dump size
.TP
\fB\-t\fP \fILOCKTIMEOUT\fP
how long to wait for lockfile (in seconds; default is 60 seconds)
.TP
\fIACTION\fP
tells MooseFS GUI server to perform one of the following actions:
.RS 
.IP start 9
Start MooseFS GUI server process if the process is not already running, otherwise display error message.
.IP stop 
Stop MooseFS GUI server process if the process is running, otherwise display error message.
.IP restart 
(default action) If the MooseFS GUI server process is running, restart it, if it's not running, start it. 
.IP reload
Send a signal to MooseFS GUI server process to reload config files.
.IP info
Send a singal to MooseFS GUI server process to dump debug information file in working directory.
.IP test
Displays "mfsgui pid: PID" if the MooseFS GUI server is running (and return 0) or  "mfsgui is not running" otherwise (and return 1).
.IP kill
Send termination signal to MooseFS GUI server process.
.IP restore
Not implemented.
.RE
.SH FILES
.TP
.BR mfsgui.cfg
configuration file for MooseFS GUI server process; refer to
\fBmfsgui.cfg\fP\|(5) manual for details
.TP
.BR .mfsgui.lock
lock file of running MooseFS GUI server process
(created in data directory)
.TP
\fIscripts\fP
various python, javascript, and other (static) files used to serve the GUI interface via HTTP; these files are installed in whatever directory is the default at installation time for \fBROOT_DIR\fP in \fBmfsgui.cfg\fP
.SH "REPORTING BUGS"
Report bugs to <bugs@moosefs.com>.
.SH COPYRIGHT
Copyright (C) 2025 Jakub Kruszona-Zawadzki, Saglabs SA

This file is part of MooseFS.

MooseFS is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, version 2 (only).

MooseFS is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with MooseFS; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02111-1301, USA
or visit http://www.gnu.org/licenses/gpl-2.0.html
.SH "SEE ALSO"
.BR mfsmaster (8),
.BR mfsgui.cfg (5)