.\" Man page generated from reStructuredText.
.
.TH "FLOWER" "1" "May 22, 2017" "0.8" "Flower"
.SH NAME
flower \- flower Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.sp
\fBflower\fP [\fIOPTIONS\fP]
.SH DESCRIPTION
.sp
Flower is a web based tool for monitoring and administrating Celery clusters.
It has these features:
.INDENT 0.0
.IP \(bu 2
Real\-time monitoring using Celery Events
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
Task progress and history
.IP \(bu 2
Ability to show task details (arguments, start time, runtime, and more)
.IP \(bu 2
Graphs and statistics
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Remote Control
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
View worker status and statistics
.IP \(bu 2
Shutdown and restart worker instances
.IP \(bu 2
Control worker pool size and autoscale settings
.IP \(bu 2
View and modify the queues a worker instance consumes from
.IP \(bu 2
View currently running tasks
.IP \(bu 2
View scheduled tasks (ETA/countdown)
.IP \(bu 2
View reserved and revoked tasks
.IP \(bu 2
Apply time and rate limits
.IP \(bu 2
Configuration viewer
.IP \(bu 2
Revoke or terminate tasks
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
Broker monitoring
.INDENT 2.0
.INDENT 3.5
.INDENT 0.0
.IP \(bu 2
View statistics for all Celery queues
.IP \(bu 2
Queue length graphs
.UNINDENT
.UNINDENT
.UNINDENT
.IP \(bu 2
HTTP API
.IP \(bu 2
Basic Auth and Google OpenID authentication
.UNINDENT
.SH OPTIONS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-\-address
run on the given address
.TP
.B \-\-auth
regexp  of emails to grant access
.TP
.B \-\-basic_auth
colon separated user\-password to enable
basic auth
.TP
.B \-\-broker_api
inspect broker e.g.
\fI\%http://guest:guest@localhost:15672/api/\fP
.TP
.B \-\-certfile
path to SSL certificate file
.TP
.B \-\-db
flower database file (default \fIflower.db\fP)
.TP
.B \-\-debug
run in debug mode (default \fIFalse\fP)
.TP
.B \-\-help
show this help information
.TP
.B \-\-inspect
inspect workers (default \fITrue\fP)
.TP
.B \-\-inspect_timeout
inspect timeout (in milliseconds) (default
\fI1000\fP)
.TP
.B \-\-keyfile
path to SSL key file
.TP
.B \-\-max_tasks
maximum number of tasks to keep in memory
(default \fI10000\fP)
.TP
.B \-\-persistent
enable persistent mode (default \fIFalse\fP)
.TP
.B \-\-port
run on the given port (default \fI5555\fP)
.TP
.B \-\-url_prefix
base url prefix
.TP
.B \-\-xheaders
enable support for the \(aqX\-Real\-Ip\(aq and
\(aqX\-Scheme\(aq headers. (default \fIFalse\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.SH TORNADO OPTIONS
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.B \-\-log_file_max_size
max size of log files before rollover
(default \fI100000000\fP)
.TP
.B \-\-log_file_num_backups
number of log files to keep (default \fI10\fP)
.TP
.BI \-\-log_file_prefix\fB= PATH
Path prefix for log files. Note that if you
are running multiple tornado processes,
log_file_prefix must be different for each
of them (e.g. include the port number)
.TP
.B \-\-log_to_stderr
Send log output to stderr (colorized if
possible). By default use stderr if
\fB\-\-log_file_prefix\fP is not set and no other
logging is configured.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-logging=debug|info|warning|error|none
Set the Python log level. If \fInone\fP, tornado
won\(aqt touch the logging configuration.
(default \fIinfo\fP)
.UNINDENT
.UNINDENT
.UNINDENT
.SH USAGE
.sp
Launch the server and open \fI\%http://localhost:5555\fP:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ flower \-A proj \-\-port=5555
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Or, launch from Celery:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ celery flower \-A proj \-\-address=127.0.0.1 \-\-port=5555
.ft P
.fi
.UNINDENT
.UNINDENT
.sp
Broker URL and other configuration options can be passed through the standard Celery options:
.INDENT 0.0
.INDENT 3.5
.sp
.nf
.ft C
$ celery flower \-A proj \-\-broker=amqp://guest:guest@localhost:5672//
.ft P
.fi
.UNINDENT
.UNINDENT
.SH AUTHOR
Mher Movsisyan
.SH COPYRIGHT
2017, Mher Movsisyan
.\" Generated by docutils manpage writer.
.