Merge pull request #32 from home-assistant/master

Cleanups

README.md

@@ -1,69 +1,3 @@
 # hassio-addons
-### Docker addons for HassIO
 
-All PRs need to be against the `build` branch!
+https://home-assistant.io/
-
-[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 <pvizeli@syshack.ch>"
-}
-```

letsencrypt/README.md

@@ -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

mosquitto/README.md

@@ -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": ""}`

samba/README.md

@@ -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.

ssh/README.md

@@ -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