smortex/tls-checker

View on GitHub
README.md

Summary

Maintainability
Test Coverage
# tls-checker

[![Build Status](https://github.com/smortex/tls-checker/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/smortex/tls-checker/actions/workflows/ci.yml)
[![Maintainability](https://api.codeclimate.com/v1/badges/272ab98a6ec1b28e5f7d/maintainability)](https://codeclimate.com/github/smortex/tls-checker/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/272ab98a6ec1b28e5f7d/test_coverage)](https://codeclimate.com/github/smortex/tls-checker/test_coverage)

Connect to remote services and report certificates status.

## Installation

As simple as:

    $ gem install tls-checker

## Usage

As simple as:

    $ tls-checker example.com ldap.example.com:389:ldap

## Development

After checking out the repo, run `bin/setup` to install dependencies. Then, run
`rake spec` to run the tests. You can also run `bin/console` for an interactive
prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To
release a new version, update the version number in `version.rb`, and then run
`bundle exec rake release`, which will create a git tag for the version, push
git commits and tags, and push the `.gem` file to
[rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at
https://github.com/smortex/tls-checker. 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.

1. Fork it (https://github.com/smortex/tls-checker/fork)
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

## 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 tls-checker project’s codebases, issue trackers,
chat rooms and mailing lists is expected to follow the [code of
conduct](https://github.com/smortex/tls-checker/blob/main/CODE_OF_CONDUCT.md).