README.md in oxidized-0.30.1 vs README.md in oxidized-0.31.0

- old
+ new

@@ -99,40 +99,24 @@ gem install oxidized-script oxidized-web # If you don't install oxidized-web, ensure "rest" is removed from your Oxidized config. ``` ### CentOS, Oracle Linux, Red Hat Linux -On CentOS 6 and 7 / RHEL 6 and 7, begin by installing Ruby 2.3 or greater. This can be accomplished in one of several ways: +On CentOS 6 and 7 / RHEL 6 and 7, begin by installing Ruby 3.1 via RVM by following the instructions: -Install Ruby 2.3 from [SCL](https://www.softwarecollections.org/en/scls/rhscl/rh-ruby23/): - -```shell -yum install centos-release-scl -yum install rh-ruby30 rh-ruby30-ruby-devel -scl enable rh-ruby30 bash -``` - -The following additional packages will be required to build the dependencies: - -```shell -yum install make cmake which sqlite-devel openssl-devel libssh2-devel ruby gcc ruby-devel libicu-devel gcc-c++ -``` - -Alternatively, install Ruby 2.6 via RVM by following the instructions: - Make sure you dont have any leftover ruby: ```yum erase ruby``` Then, install gpg key and rvm ```shell sudo gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB curl -sSL https://get.rvm.io | bash -s stable source /etc/profile.d/rvm.sh rvm requirements run -rvm install 3.0 -rvm use 3.0 +rvm install 3.1 +rvm use 3.1 ``` Install oxidized requirements: ```yum install make cmake which sqlite-devel openssl-devel libssh2-devel gcc libicu-devel gcc-c++``` @@ -198,11 +182,11 @@ Run the container for the first time to initialize the config: _Note: this step in only required for creating the Oxidized configuration file and can be skipped if you already have one._ ```shell -docker run --rm -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp -t oxidized/oxidized:latest oxidized +docker run --rm -v /etc/oxidized:/home/oxidized/.config/oxidized -p 8888:8888/tcp --user oxidized -t oxidized/oxidized:latest oxidized ``` If the RESTful API and Web Interface are enabled, on the docker host running the container edit `/etc/oxidized/config` and modify `rest: 127.0.0.1:8888` to `rest: 0.0.0.0:8888`. This will bind port 8888 to all interfaces, and expose the port so that it could be accessed externally. [(Issue #445)](https://github.com/ytti/oxidized/issues/445) @@ -293,10 +277,10 @@ ```shell useradd -s /bin/bash -m oxidized ``` -> It is recommended __not__ to run Oxidized as root. +> It is recommended __not__ to run Oxidized as root. After creating a dedicated user, switch to the oxidized user using su oxidized to ensure that Oxidized is run under the correct user context. To initialize a default configuration in your home directory `~/.config/oxidized/config`, simply run `oxidized` once. If you don't further configure anything from the output and source sections, it'll extend the examples on a subsequent `oxidized` execution. This is useful to see what options for a specific source or output backend are available. You can set the env variable `OXIDIZED_HOME` to change its home directory.