diff --git a/README.md b/README.md index 9fb9d442d..28be9efa8 100644 --- a/README.md +++ b/README.md @@ -223,6 +223,19 @@ Flow-based programming for the Internet of Things [:books: Node-RED add-on documentation][addon-doc-node-red] +### ✓ [Octobox][addon-octobox] + +![Latest Version][octobox-version-shield] +![Supports armhf Architecture][octobox-armhf-shield] +![Supports aarch64 Architecture][octobox-aarch64-shield] +![Supports amd64 Architecture][octobox-amd64-shield] +![Supports i386 Architecture][octobox-i386-shield] +![Docker Pulls][octobox-pulls-shield] + +Take back control of your GitHub notifications + +[:books: Octobox add-on documentation][addon-doc-octobox] + ### ✓ [Pi-hole][addon-pi-hole] ![Latest Version][pi-hole-version-shield] @@ -361,6 +374,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the add-on: Jupyter][jupyter-issue] - [Open an issue for the add-on: Log Viewer][log-viewer-issue] - [Open an issue for the add-on: Node-RED][node-red-issue] +- [Open an issue for the add-on: Octobox][octobox-issue] - [Open an issue for the add-on: Pi-hole][pi-hole-issue] - [Open an issue for the add-on: Plex Media Server][plex-issue] - [Open an issue for the add-on: SSH - Secure Shell][ssh-issue] @@ -544,6 +558,15 @@ SOFTWARE. [node-red-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [node-red-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [node-red-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[addon-octobox]: https://github.com/hassio-addons/addon-octobox/tree/d669ed4 +[addon-doc-octobox]: https://github.com/hassio-addons/addon-octobox/blob/d669ed4/README.md +[octobox-issue]: https://github.com/hassio-addons/addon-octobox/issues +[octobox-version-shield]: https://img.shields.io/badge/version-d669ed4-blue.svg +[octobox-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/octobox.svg +[octobox-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[octobox-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[octobox-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[octobox-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [addon-pi-hole]: https://github.com/hassio-addons/addon-pi-hole/tree/e6111ee [addon-doc-pi-hole]: https://github.com/hassio-addons/addon-pi-hole/blob/e6111ee/README.md [pi-hole-issue]: https://github.com/hassio-addons/addon-pi-hole/issues diff --git a/octobox/CHANGELOG.md b/octobox/CHANGELOG.md new file mode 100644 index 000000000..d26347924 --- /dev/null +++ b/octobox/CHANGELOG.md @@ -0,0 +1,3 @@ +2018/06/23 17:35 UTC - [d669ed4](https://github.com/hassio-addons/addon-octobox/commit/d669ed46c1965eef7898b6313a1207532c43e625) by [@frenck](https://github.com/frenck) +> :shirt: Fixes shellcheck warnings + diff --git a/octobox/README.md b/octobox/README.md new file mode 100644 index 000000000..4b4631ce0 --- /dev/null +++ b/octobox/README.md @@ -0,0 +1,65 @@ +# Community Hass.io Add-ons: Tor + +[![Release][release-shield]][release] ![Project Stage][project-stage-shield] ![Project Maintenance][maintenance-shield] + +[![Discord][discord-shield]][discord] [![Community Forum][forum-shield]][forum] + +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] + +Protect your privacy and access Home Assistant via Tor. + +## About + +This Tor add-on allows you to access you Home Assistant instance as an Onion site, +trough [Tor's Hidden Service][tor-hidden-service] feature. With this feature +enabled, you do not need to open your firewall ports or setup HTTPS to enable +secure remote access. + +This is useful if you want to have: + +- Access your Home Assistant instance remotely without opening a firewall port + or setting up a VPN. +- Don’t want to or know how to get an SSL/TLS certificate and HTTPS + configuration setup. +- Want to block attackers from even being able to access/scan your port and + server at all. +- Want to block anyone from knowing your home IP address and seeing your + traffic to your Home Assistant. + +The add-on also offers the possibility to open a Sock proxy into the +Tor network. Allowing you to access Tor from any of your (SOCKS supporting) +applications through your Hass.io installation. + +[Click here for the full documentation][docs] + +## WARNING! THIS IS AN EDGE VERSION! + +This Hass.io Add-ons repository contains edge builds of add-ons. Edge builds +add-ons are based upon the latest development version. + +- They may not work at all. +- They might stop working at any time. +- They could have a negative impact on your system. + +This repository was created for: + +- Anybody willing to test. +- Anybody interested in trying out upcoming add-ons or add-on features. +- Developers. + +If you are more interested in stable releases of our add-ons: + + + +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/frenck +[discord-shield]: https://img.shields.io/discord/330944238910963714.svg +[discord]: https://discord.gg/c5DvZ4e +[docs]: https://github.com/hassio-addons/addon-octobox/blob/d669ed4/README.md +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-tor/33822?u=frenck +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[release-shield]: https://img.shields.io/badge/version-d669ed4-blue.svg +[release]: https://github.com/hassio-addons/addon-octobox/tree/d669ed4 +[tor-hidden-service]: https://www.torproject.org/docs/hidden-services.html.en \ No newline at end of file diff --git a/octobox/config.json b/octobox/config.json new file mode 100644 index 000000000..735af53db --- /dev/null +++ b/octobox/config.json @@ -0,0 +1,65 @@ +{ + "name": "Octobox", + "version": "d669ed4", + "slug": "octobox", + "description": "Take back control of your GitHub notifications", + "url": "https://community.home-assistant.io/?u=frenck", + "webui": "[PROTO:ssl]://[HOST]:[PORT:8443]", + "startup": "services", + "arch": [ + "aarch64", + "amd64", + "armhf", + "i386" + ], + "boot": "auto", + "hassio_api": true, + "homeassistant_api": false, + "host_network": false, + "ports": { + "3333/tcp": 3333 + }, + "map": [ + "ssl" + ], + "options": { + "log_level": "info", + "ssl": false, + "certfile": "fullchain.pem", + "keyfile": "privkey.pem", + "github_client_id": "", + "github_client_secret": "", + "sync_timeout": 600, + "fetch_subject": true, + "minimum_refresh_interval": 1, + "allow_personal_access_token": false, + "username": "", + "password": "", + "github_restrict_access": false, + "github_organization_id": 0, + "github_team_id": 0, + "ipv6": false + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "ssl": "bool", + "certfile": "str", + "keyfile": "str", + "github_client_id": "str", + "github_client_secret": "str", + "sync_timeout": "int", + "fetch_subject": "bool", + "minimum_refresh_interval": "int", + "allow_personal_access_token": "bool", + "username": "str", + "password": "str", + "github_restrict_access": "bool", + "github_organization_id": "int", + "github_team_id": "int", + "ipv6": "bool" + }, + "environment": { + "LOG_FORMAT": "{LEVEL}: {MESSAGE}" + }, + "image": "hassioaddons/octobox" +} \ No newline at end of file diff --git a/octobox/icon.png b/octobox/icon.png new file mode 100644 index 000000000..b18936eeb Binary files /dev/null and b/octobox/icon.png differ diff --git a/octobox/logo.png b/octobox/logo.png new file mode 100644 index 000000000..67bdc58b0 Binary files /dev/null and b/octobox/logo.png differ