# Executus

**TODO: Add description**

## Installation

If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `executus` to your list of dependencies in `mix.exs`:

```elixir
def deps do
  [
    {:executus, "~> 0.1.0"}
  ]
end
```

Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at [https://hexdocs.pm/executus](https://hexdocs.pm/executus).

## Running as root

Executus can be configure to run root commands using sudo by adding a configuration
for Erlexec to the config.exs file.

```elixir
use Mix.Config

config :erlexec, limit_users: ['some_list_of_users_who_can_run_commands']
config :erlexec, root: true
config :erlexec, user: 'user_who_will_run_sudo_commands'
```