mirror of
https://github.com/fluent/fluentd-ui.git
synced 2025-08-17 19:57:07 +02:00
80 lines
2.4 KiB
Markdown
80 lines
2.4 KiB
Markdown
# fluentd-ui
|
|
|
|
[](https://travis-ci.org/fluent/fluentd-ui)
|
|
[](http://badge.fury.io/rb/fluentd-ui)
|
|
[](https://codeclimate.com/github/fluent/fluentd-ui)
|
|
|
|
fluentd-ui is a browser-based [fluentd](http://www.fluentd.org) and [td-agent](https://docs.treasuredata.com/articles/td-agent) manager that supports following operations.
|
|
|
|
* Install, uninstall, and upgrade Fluentd plugins
|
|
* start/stop/restart fluentd process
|
|
* Configure Fluentd settings such as config file content, pid file path, etc
|
|
* View Fluentd log with simple error viewer
|
|
|
|
[Official documentation](http://docs.fluentd.org/articles/fluentd-ui) \| [Changelog](./ChangeLog.md)
|
|
|
|
|
|
## Requirements
|
|
|
|
- ruby 2.2.2 or later (since v1.0.0)
|
|
- fluentd v1.0.0 or later (also supports td-agent 3)
|
|
- Currently, fluentd v1 and td-agent 3 support is in alpha state
|
|
|
|
And some additional packages (Debian / Ubuntu)
|
|
|
|
- build-essential
|
|
- libssl-dev
|
|
- libxml2-dev
|
|
- libxslt1-dev
|
|
- ruby-dev
|
|
|
|
## How to install and run
|
|
|
|
$ gem install fluentd-ui
|
|
$ fluentd-ui setup
|
|
$ fluentd-ui start --daemonize
|
|
|
|
Access http://localhost:9292 by web browser.
|
|
|
|
### Run under sub path
|
|
|
|
Use `RAILS_RELATIVE_URL_ROOT` environment variable.
|
|
|
|
$ RAILS_RELATIVE_URL_ROOT=/prefix fluentd-ui start --daemonize
|
|
|
|
Access http://localhost:9292/prefix by web browser.
|
|
|
|
## Development
|
|
|
|
$ git clone https://github.com/fluent/fluentd-ui
|
|
$ cd fluentd-ui
|
|
$ bundle install
|
|
$ bin/rails s
|
|
|
|
Also you need a [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) or chromiumdriver for test.
|
|
|
|
$ npm install -g chromedriver
|
|
Or,
|
|
$ brew install chromedriver
|
|
Or,
|
|
$ sudo apt install chromium-driver
|
|
|
|
NOTE: `chromedriver` executable binary should be located under your `$PATH`.
|
|
|
|
## Building fluentd-ui.gem
|
|
|
|
# Generate ChangeLog.md and increment version
|
|
$ bin/rails release:prepare
|
|
|
|
# Clear tmp/, public/assets and public/packs
|
|
$ bin/rails tmp:clear assets:clobber && touch tmp/.gitkeep
|
|
|
|
# Generate pre-compiled assets
|
|
$ RAILS_ENV=production bin/rails assets:precompile
|
|
|
|
# fluentd-ui X.X.X built to pkg/fluentd-ui-X.X.X.gem.
|
|
$ RAILS_ENV=production bin/rails build
|
|
|
|
# Push to rubygems.org
|
|
$ bin/rails release
|