Skip to content

Commit

Permalink
Merge pull request #3243 from kaustubh16092002/improve-oxdized-doc
Browse files Browse the repository at this point in the history
Clarify user permissions recommendation for running Oxidized
  • Loading branch information
robertcheramy authored Aug 30, 2024
2 parents 41f098e + 93788aa commit 7fa9937
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ It is recommended practice to run Oxidized using its own username. This usernam
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.

Expand Down

0 comments on commit 7fa9937

Please sign in to comment.