From d9a56b603ccfdd2f214838acaa1a20a2d137f02a Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:23:56 +0200 Subject: [PATCH 1/6] Delete README.md --- README.md | 69 ------------------------------------------------------- 1 file changed, 69 deletions(-) delete mode 100644 README.md diff --git a/README.md b/README.md deleted file mode 100644 index 798d5c0..0000000 --- a/README.md +++ /dev/null @@ -1,69 +0,0 @@ -# hassio-addons -### Docker addons for HassIO - -All PRs need to be against the `build` branch! - -[HassIO](https://github.com/home-assistant/hassio) | [HassIO-Build](https://github.com/home-assistant/hassio-build) - -## Addon folder - -``` -addon_name: - README.md - Dockerfile - config.json - run.sh -``` - -All add-ons are based off Alpine Linux 3.5. To get the macine specific version, use `FROM %%BASE_IMAGE%%` inside your docker file. Your Docker file also needs to include this line: - -```docker -ENV VERSION %%VERSION%% -``` - -As a user might run many add-ons, it is encouraged to try to stick to Bash scripts if you're doing simple things. - -## Addon config - -```json -{ - "name": "xy", - "version": "1.2", - "slug": "folder", - "description": "long descripton", - "startup": "before|after|once", - "boot": "auto|manual", - "ports": { - "123/tcp": 123 - }, - "map": ["config", "ssl", "addons", "backup"], - "options": {}, - "schema": { - "bla": "str|int|float|bool|email|url", -    "list1": ["str|int|float|bool|email|url"], - "list2": [ - { "ble": "str|int|float|bool|email|url" } - ] -  }, - "image": "for custom addons", -} -``` - -If you want to set a value to requered and need to be set from user before it start the addon, set it to null. - -## SSL - -Default you can use `fullchain.pem` and `privkey.pem` from `/ssl` for you stuff. Your SSL addon should also create default this files. - -## Addon need to known -`/data` is a volume with a persistant store. `/data/options.json` have the user config inside. You can use `jq` inside shell script to parse this data. - -# Custom Addon repository -Add a `repository.json` to root of your git repository with: -```json -{ - "name": "Needed, Name of repository", - "url": "url to website (optional)", - "maintainer": "(optional) Pascal Vizeli " -} -``` From 242483f8cfa74597939b718215263c8842c981fb Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:24:12 +0200 Subject: [PATCH 2/6] Delete README.md --- letsencrypt/README.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 letsencrypt/README.md diff --git a/letsencrypt/README.md b/letsencrypt/README.md deleted file mode 100644 index 4f96df8..0000000 --- a/letsencrypt/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Let's Encrypt -Manage let's encrypt certificate for HomeAssistant and HassIO addons. - -First run generate certificates and next run of addon will renew it. You can automate the renew with HomeAssistant automation and call hassio.addon_start. - -## Options - -- `email`: your email address for register -- `domains`: a list with domains From 49d6ab4d7ca4e1dc3f4cc7ce82ad0dff9c8a95fd Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:24:24 +0200 Subject: [PATCH 3/6] Delete README.md --- mosquitto/README.md | 9 --------- 1 file changed, 9 deletions(-) delete mode 100644 mosquitto/README.md diff --git a/mosquitto/README.md b/mosquitto/README.md deleted file mode 100644 index da40de2..0000000 --- a/mosquitto/README.md +++ /dev/null @@ -1,9 +0,0 @@ -# Mosquitto -MQTT broker for HomeAssistant and HassIO addons. - -## Options - -- `plain`: For connection with 1883 (without SSL/TLS) -- `ssl`: For connection with 8883 (with SSL/TLS) -- `anonymous`: For anonymous authentication -- `logins`: A list of login data `{"username": "", "password": ""}` From 6608ba0f38a7ec0470496ccf2276435f0eebcd18 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:24:39 +0200 Subject: [PATCH 4/6] Delete README.md --- samba/README.md | 12 ------------ 1 file changed, 12 deletions(-) delete mode 100644 samba/README.md diff --git a/samba/README.md b/samba/README.md deleted file mode 100644 index 444610c..0000000 --- a/samba/README.md +++ /dev/null @@ -1,12 +0,0 @@ -# Samba -Expose HassIO folders to samba share. - -## Options - -- `workgroup`: default WORKGROUP. name of workgroup -- `guest`: default true. Allow access without login -- `username`: username without guest access -- `password`: password for login. -- `map_config`: Expose config folder. -- `map_addons`: Expose addons folder. -- `map_ssl`: Expose ssl folder. From b0767683494862de5641d7a9a437351f37993066 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:24:50 +0200 Subject: [PATCH 5/6] Delete README.md --- ssh/README.md | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 ssh/README.md diff --git a/ssh/README.md b/ssh/README.md deleted file mode 100644 index bbcbfe9..0000000 --- a/ssh/README.md +++ /dev/null @@ -1,11 +0,0 @@ -# SSH server -Provide a openssh server. You can access to: -- /config: HomeAssistant config -- /addons: Custom addon folder -- /ssl: Store ssh key files for HassIO - -Installed editor is vim - -## Options - -- `authorized_keys`: A array that ever element is a authorized key From c2d1ae8c4183235c3758744f4ed71d8bcd774d62 Mon Sep 17 00:00:00 2001 From: Pascal Vizeli Date: Thu, 4 May 2017 16:25:31 +0200 Subject: [PATCH 6/6] Create README.md --- README.md | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e0f172 --- /dev/null +++ b/README.md @@ -0,0 +1,3 @@ +# hassio-addons + +https://home-assistant.io/