Web UI is currently experimental and is not recommended for new users!
We need your help! If you are a React developer or can help with the layout/design/css then please join in the effort.
The web UI is enabled by placing the
web_server key in your configuration file. SSL is optional, but it is highly recommended if the UI is exposed to the internet.
web_server is one of a handful of top-level keys in the configuration file. Do not indent
This is the simple configuration that uses default values. It will enable the API and web UI at
5050) by default.
You can also set a different port using an alternate simple configuration mode. (NOTE: This simple mode will currently default to WebUI v1.)
bind: IP address to bind to
port: Port at which the web UI and API will be accessed
ssl_certificate: Path to certificate file
ssl_private_key: Path to private key file
yes|noSet to no to disable the web UI; only the API will run
base_url: Set a different base_url; default is
run_v1: Enable old v1 UI. Note: This is subject to change.
Fully configured example:
web_server: bind: 0.0.0.0 port: 3539 ssl_certificate: '/etc/ssl/private/myCert.pem' ssl_private_key: '/etc/ssl/private/myKey.key' web_ui: yes base_url: /flexget
Set a password and start FlexGet in daemon mode to start the web server.
$ flexget web passwd <05051985> $ flexget daemon start --daemonize
Using the full configuration example above, the Flexget Web UI would now be available at
http://flexget_ip:3539/flexget. Full API documentation would be available at
Visit the API page for more information about it.
If you are running flexget from git, you can run the following to get the latest release of webui.
python dev_tools.py bundle-webui
The login username is
flexget and the password is what you set using the
web passwd command above.
You can also use an authorization header to access the API with the following format:
Authorization: Token <TOKEN>
You can view or reset the API token using the following CLI commands:
# View token flexget web showtoken # Generate new token flexget web gentoken
The UI has a solid base but we need help building the plugins. If you would like to get your hands dirty in React, CSS or UX Design then please join our chat on Gitter and checkout the CONTRIBUTING.md for getting setup and feel free to ask any questions in chat.