{"body": "
\n

# Configuration\u00b6

\n

Flower can be configured from the command line:

\n

    $ flower --auto_refresh=False\n

\n
\n

Using `flowerconfig.py` configuration file:

\n

    # RabbitMQ management api\nbroker_api = 'http://guest:guest@localhost:15672/api/'\n\n# Enable debug logging\nlogging = 'DEBUG'\n

\n
\n

Or, using the environment variables. All flower options should be\nprefixed with FLOWER_:

\n

    $ export FLOWER_BASIC_AUTH=foo:bar\n

\n
\n

Options passed through the command line have precedence over the options\ndefined in the configuration file. The configuration file name and path\ncan be changed with conf option.

\n

    $ flower --conf=celeryconfig.py\n

\n
\n
\n

## Options\u00b6

\n

Standard Celery configuration settings can be overridden in the configuration\nfile. See Celery Configuration reference for a complete listing of all\nthe available settings, and their default values.

\n

Celery command line options also can be passed to Flower. For example\nthe –broker sets the default broker URL:

\n

    $ flower -A proj --broker=amqp://guest:guest@localhost:5672//\n

\n
\n

For a full list of options see:

\n

    $ celery --help\n

\n
\n
\n

\n
- address
\n
- auth
\n
- auto_refresh
\n
- basic_auth
\n
- broker_api
\n
- ca_certs
\n
- certfile
\n
- conf
\n
- db
\n
- debug
\n
- enable_events
\n
- format_task
\n
- inspect_timeout
\n
- keyfile
\n
- max_workers
\n
- max_tasks
\n
- natural_time
\n
- persistent
\n
- port
\n
- xheaders
\n
- tasks_columns
\n
- url_prefix
\n
- unix_socket
\n
- cookie_secret
\n
- auth_provider
\n

\n
\n
\n

### address\u00b6

\n

Run the http server on a given address

\n
\n
\n

### auth\u00b6

\n

Enables Google OpenID authentication. auth is a regexp of emails\nto grant access. For more info see google-openid

\n
\n
\n

### auto_refresh\u00b6

\n

Refresh dashboards automatically (by default, auto_refresh=True)

\n
\n
\n

### basic_auth\u00b6

\n

Enables HTTP Basic authentication. basic_auth is a comma separated list\nof username:passworrd. See HTTP Basic Authentication for more info.

\n
\n
\n

### broker_api\u00b6

\n

Flower uses RabbitMQ Managment Plugin to get info about queues.\nbroker_api is a URL of RabbitMQ HTTP API including user credentials.

\n

    $ flower -A proj --broker_api=http://username:password@rabbitmq-server-name:15672/api/\n

\n
\n
\n

Note

\n

By default the managment plugin is not enabled. To enable it run:

\n

    $ rabbitmq-plugins enable rabbitmq_management\n

\n
\n
\n
\n

Note

\n

The port number for RabbitMQ versions prior to 3.0 is 55672.

\n
\n
\n
\n

### ca_certs\u00b6

\n

A path to ca_certs file. The ca_certs file contains a set of concatenated \u201ccertification authority\u201d\ncertificates, which are used to validate certificates passed from the other end of the connection.\nFor more info see :ref:`Python SSL`_

\n
\n
\n

### certfile\u00b6

\n

A path to SSL certificate file

\n
\n
\n

### conf\u00b6

\n

A path to the configuration file (by default, `flowerconfig.py`)

\n
\n
\n

### db\u00b6

\n

A database file to use if persistent mode is enabled\n(by default, db=flower)

\n
\n
\n

### debug\u00b6

\n

Enable the debug mode (by default, debug=False)

\n
\n
\n

### enable_events\u00b6

\n

Periodically enable Celery events by using enable_events command\n(by default, enable_event=True)

\n
\n
\n

### format_task\u00b6

\n

Modifies the default task formatting. format_task function should be\ndefined in the flowerconfig.py configuration file. It accepts a task\nobject and returns the modified version.

\n

format_task is useful for filtering out sensitive information.

\n

The example below shows how to filter arguments and limit display lengths:

\n

    from flower.utils.template import humanize\n\ndef format_task(task):\n    task.args = humanize(task.args, length=10)\n    task.kwargs.pop('credit_card_number')\n    task.result = humanize(task.result, length=20)\n    return task\n

\n
\n
\n
\n

### inspect_timeout\u00b6

\n

Sets worker inspect timeout (by default, inspect_timeout=10000\nin milliseconds)

\n
\n
\n

### keyfile\u00b6

\n

A path to SSL key file

\n
\n
\n

### max_workers\u00b6

\n

Maximum number of workers to keep in memory (by default, max_workers=5000)

\n
\n
\n

### max_tasks\u00b6

\n

Maximum number of tasks to keep in memory (by default, max_tasks=10000)

\n
\n
\n

### natural_time\u00b6

\n

Show time relative to the refresh time (by default, natural_time=True)

\n
\n
\n

### persistent\u00b6

\n

Enable persistent mode. If the persistent mode is enabled Flower saves\nthe current state and reloads on restart (by default, persistent=False)

\n
\n
\n

### port\u00b6

\n

Run the http server on a given port (by default, port=5555)

\n
\n
\n

### xheaders\u00b6

\n

Enable support of X-Real-Ip and X-Scheme headers\n(by default, xheaders=False)

\n
\n
\n

### tasks_columns\u00b6

\n

Specifies list of comma-delimited columns on /tasks/ page.\nColumns on the page can be reordered using drag and drop.\nAvailable columns are:

\n

> \n
> \n
> - name
> \n
> - uuid
> \n
> - state
> \n
> - args
> \n
> - kwargs
> \n
> - result
> \n
> - received
> \n
> - started
> \n
> - runtime
> \n
> - worker
> \n
> - retries
> \n
> - revoked
> \n
> - exception
> \n
> - expires
> \n
> - eta
> \n
> \n

\n
\n
\n

### url_prefix\u00b6

\n

Enables deploying Flower on non-root URL

\n

For example to access Flower on http://example.com/flower run it with:

\n

    $ flower --url_prefix=flower\n

\n
\n

And use the following nginx configuration:

\n

    server {\n    listen 80;\n    server_name example.com;\n\n    location /flower/ {\n        rewrite ^/flower/(.*)$ /$1 break;\n        proxy_pass http://example.com:5555;\n        proxy_set_header Host $host;\n    }\n\n}\n

\n
\n
\n
\n

### unix_socket\u00b6

\n

Path to UNIX socket

\n
\n
\n

### cookie_secret\u00b6

\n

Set a secret key for signing cookies

\n
\n
\n

### auth_provider\u00b6

\n

Sets authentication provider

\n

> \n
> \n
> - Google flower.views.auth.GoogleAuth2LoginHandler
> \n
> - GitHub flower.views.auth.GithubLoginHandler
> \n
> \n

\n

See Authentication for usage examples

\n
\n
\n
\n", "alabaster_version": "0.7.7", "display_toc": true, "title": "Configuration", "sourcename": "config.txt", "customsidebar": null, "metatags": "", "current_page_name": "config", "next": {"link": "../tasks_filter/", "title": "Tasks filtering"}, "rellinks": [["tasks_filter", "Tasks filtering", "N", "next"], ["install", "Installation", "P", "previous"]], "meta": {"tocdepth": 2}, "parents": [], "sidebars": ["sidebarlogo.html", "localtoc.html", "relations.html", "sourcelink.html", "searchbox.html"], "toc": "

\n
- Configuration
  \n
  - Options
  \n
  \n
\n

\n", "prev": {"link": "../install/", "title": "Installation"}, "page_source_suffix": ".rst"}