# Executo

Unix command execution from Rails. Jobs can be executed on remote servers, as long as they run executo.

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'executo'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install executo

## Usage

```ruby
Executo.publish('localhost', 'ls', ['-al'])
```

## Development

Run worker using `sidekiq -r ./boot.rb -C sidekiq.yml`
Run active-job worker using `sidekiq -r ./boot_activejob.rb`

Publish jobs using:

```ruby
Executo.publish('localhost', 'ls', ['-al'])
```

You can publish jobs encrypted as well, which means that the command and parameters, but also passed options are encrypted before sent to the server (sidekiq/redis).
They are only decrypted in memory for the command te be executed. Job options are never encrypted.
This is ideal if you don't want email addresses or passwords to be littered over log files or in the redis database.

Publish encrypted jobs using:

```ruby
Executo.publish('localhost', 'ls', ['-al'], encrypt: true)
```

Schedule for a host:

```ruby
Executo.schedule('localhost', [
  ['30 * * * *', { class_name: '', arguments: {} }]
])
```

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/executo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Executo project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/entdec/executo/blob/main/CODE_OF_CONDUCT.md).