mirrors/fluentd-ui
1
0
Fork 0
mirror of https://github.com/fluent/fluentd-ui.git synced 2025-08-11 08:47:06 +02:00
Code Issues Projects Releases Wiki Activity
dbcff5cadb
fluentd-ui/README.md
Takuro Ashie ba11fb4983 README.md: Specify bundler's version 
Otherwise I got an error on running it:

Traceback (most recent call last):
	2: from /usr/local/bin/bundle:23:in `<main>'
	1: from /usr/lib/ruby/2.7.0/rubygems.rb:294:in `activate_bin_path'
/usr/lib/ruby/2.7.0/rubygems.rb:275:in `find_spec_for_exe': Could not find 'bundler' (1.17.3) required by your /home/aho/Projects/fluentd-ui/Gemfile.lock. (Gem::GemNotFoundException)
To update to the latest version installed on your system, run `bundle update --bundler`.
To install the missing version, run `gem install bundler:1.17.3`

Signed-off-by: Takuro Ashie <ashie@clear-code.com>
2020-07-27 14:47:55 +09:00

3.1 KiB
Raw Blame History

fluentd-ui

Build Status Gem Version Code Climate

fluentd-ui is a browser-based fluentd and 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 | Changelog

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. The default account is username="admin" and password="changeme".

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

Get the source

$ git clone https://github.com/fluent/fluentd-ui
$ cd fluentd-ui

Install dependent gems

Use bundler:

$ gem install bundler --version 1.17.3
$ bundle install --path vendor/bundle

Install dependent JavaScript packages

Use yarn. See https://yarnpkg.com/en/docs/install to install it to your environment. After install it, run following command:

$ ./bin/yarn install

Run fluentd-ui

$ bin/rails server

Access http://localhost:3000 by web browser.

Run with Docker

$ docker build -t fluent/fluentd-ui:1.0.0 .
$ docker run --net=host fluent/fluentd-ui:1.0.0

Run tests

You need chromedriver or chromiumdriver to run tests.

$ npm install -g chromedriver
Or,
$ brew install chromedriver
Or,
$ sudo apt install chromium-driver

NOTE: chromedriver executable binary should be located under your $PATH.

After that you can run tests by following command:

$ bundle exec rake test

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