Skip to content

miguelangel-nubla/hassio-step-ca-client

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Home Assistant Add-on: step-ca-client

GitHub Release Project Stage License

Supports armhf Architecture Supports armv7 Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Github Actions Project Maintenance GitHub Activity

About

This is a step-ca client add-on for Home Assistant.

It manages the automatic creation and renewal of x509 certificates from a remote step-ca PKI server, in order to enable TLS/SSL connections in Home Assistant and the installed addons.

Here is a quick-start guide on how to setup step-ca.

With a Yubikey you can even set up setup a hardware based, local PKI.

📚 Read the full add-on documentation

Installation

The installation of this add-on is pretty straightforward and not different compared to installing any other Home Assistant add-on.

  1. First you will need to add the repository to your add-on store with the following button:

    Add the add-on repository to your Home Assistant instance.

  2. Click on add to complete adding the repository.

  3. Click the Home Assistant My button below to open the add-on on your Home Assistant instance.

    Open this add-on in your Home Assistant instance.

  4. Click the "Install" button to install the add-on.

  5. Configure the add-on in the configuration tab.

  6. Start the "step-ca-client" add-on.

  7. Check the logs of the "step-ca-client" add-on to see it in action.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

Addon created by Miguel Angel Nubla based on the addon-example repository by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

License

MIT License

Copyright (c) 2023 Miguel Angel Nubla [email protected]

Copyright (c) 2017-2023 Franck Nijhof [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

No description, website, or topics provided.

Resources

License

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages