README.md in fluentd-server-0.3.1 vs README.md in fluentd-server-0.3.2

- old
+ new

@@ -106,30 +106,33 @@ See [API.md](API.md). ### Use Fluentd Server from Command Line -For the case you want to edit Fluentd configuration files from your favorite editors rather than from the Web UI, `LOCAL STORAGE` feature is available. +For the case you want to edit Fluentd configuration files from your favorite editors rather than from the Web UI, `FILE STORAGE` feature is available. With this feature, you should also be able to manage your configuration files with git (or any VCS). -To use this feature, enable `LOCAL_STORAGE` in `.env` file as: +To use this feature, enable `FILE_STORAGE` in `.env` file as: ``` -LOCAL_STORAGE=true +FILE_STORAGE=true DATA_DIR=data SYNC_INTERVAL=60 ``` where the `DATA_DIR` is the location to place your configuration files locally, and the `SYNC_INTERVAL` is the interval where a synchronization worker works. -Putting any files whose name ends with `.erb` in `DATA_DIR` is automatically synchronized with DB by the synchronization worker. Removing `.erb` files is also synchronized with DB. -For the case you want to synchronize immediately, `sync` command is also available. +Place your `erb` files in the `DATA_DIR` directory, and please execute `sync` command to synchronize the file existence information with DB +when you newly add or remove the configuration files. ``` $ fluentd-server sync ``` +Or, you may just wait `SYNC_INTERVAL` senconds until a synchronization worker automatically synchronizes the information. +Please note that modifying the file content does not require to synchronize because the content is read from the local file directly. + NOTE: Enabling this feature disables to edit the Fluentd configuration from the Web UI. ### CLI (Command Line Interface) Here is a full list of fluentd-server commands. @@ -156,9 +159,12 @@ ``` ## ToDo * Automatic deployment (restart) support like the one of chef-server + + * Need a notification function for when configtest or restart failed + * Pipe the resulted json to a command (I may prepare email.rb as an example). ## ChangeLog See [CHANGELOG.md](CHANGELOG.md) for details.