diff --git a/README.md b/README.md index 1bab8b7d..b3dd1988 100644 --- a/README.md +++ b/README.md @@ -90,6 +90,19 @@ development. It shows a random quote in the log every couple of seconds. [:books: Example add-on documentation][addon-example] +### ✓ [FTP][addon-ftp] + +![Latest Version][ftp-version-shield] +![Supports armhf Architecture][ftp-armhf-shield] +![Supports aarch64 Architecture][ftp-aarch64-shield] +![Supports amd64 Architecture][ftp-amd64-shield] +![Supports i386 Architecture][ftp-i386-shield] +![Docker Pulls][ftp-pulls-shield] + +A secure and fast FTP server for Hass.io. + +[:books: FTP add-on documentation][addon-ftp] + ### ✓ [Homebridge][addon-homebridge] ![Latest Version][homebridge-version-shield] @@ -205,6 +218,7 @@ on the correct GitHub repository matching the add-on. - [Open an issue for the addon: AirSonos][airsonos-issue] - [Open an issue for the addon: AppDaemon][appdaemon-issue] - [Open an issue for the addon: Example][example-issue] +- [Open an issue for the addon: FTP][ftp-issue] - [Open an issue for the addon: Homebridge][homebridge-issue] - [Open an issue for the addon: IDE][ide-issue] - [Open an issue for the addon: Pi-hole][pi-hole-issue] @@ -259,6 +273,7 @@ SOFTWARE. [addon-airsonos]: https://github.com/hassio-addons/addon-airsonos [addon-appdaemon]: https://github.com/hassio-addons/addon-appdaemon [addon-example]: https://github.com/hassio-addons/addon-example +[addon-ftp]: https://github.com/hassio-addons/addon-ftp [addon-homebridge]: https://github.com/hassio-addons/addon-homebridge [addon-ide]: https://github.com/hassio-addons/addon-ide [addon-pi-hole]: https://github.com/hassio-addons/addon-pi-hole @@ -306,6 +321,13 @@ SOFTWARE. [forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg [forum]: https://community.home-assistant.io/t/repository-community-hass-io-add-ons/24705?u=frenck [frenck]: https://github.com/frenck +[ftp-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg +[ftp-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg +[ftp-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg +[ftp-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg +[ftp-issue]: https://github.com/hassio-addons/addon-ftp/issues +[ftp-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/ftp-armhf.svg +[ftp-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/ftp-armhf.svg [gratipay-shield]: https://img.shields.io/badge/donate-gratipay-blue.svg [gratipay]: https://gratipay.com/hassio-addons/ [homebridge-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg @@ -361,4 +383,4 @@ SOFTWARE. [tor-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg [tor-issue]: https://github.com/hassio-addons/addon-tor/issues [tor-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/tor-armhf.svg -[tor-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/tor-armhf.svg +[tor-version-shield]: https://images.microbadger.com/badges/version/hassioaddons/tor-armhf.svg \ No newline at end of file diff --git a/ftp/README.md b/ftp/README.md new file mode 100644 index 00000000..49fcdd0a --- /dev/null +++ b/ftp/README.md @@ -0,0 +1,7 @@ +# Community Hass.io Add-ons: FTP + +This is just a configuration stub to make the Hass.io repository work. + +The add-on itself can be found at the following URL: + + diff --git a/ftp/config.json b/ftp/config.json new file mode 100644 index 00000000..f32ae30e --- /dev/null +++ b/ftp/config.json @@ -0,0 +1,87 @@ +{ + "name": "FTP", + "version": "0.1.0", + "slug": "ftp", + "description": "A secure and fast FTP server for Hass.io", + "url": "https://community.home-assistant.io/t/community-hass-io-add-on-ftp/36799?u=frenck", + "startup": "services", + "boot": "auto", + "hassio_api": true, + "homeassistant_api": false, + "host_network": true, + "privileged": [ + "SYS_ADMIN" + ], + "map": [ + "addons:rw", + "backup:rw", + "config:rw", + "share:rw", + "ssl:rw" + ], + "options": { + "log_level": "info", + "port": 21, + "data_port": 20, + "banner": "Welcome to the Hass.io FTP service.", + "pasv": true, + "pasv_min_port": 30000, + "pasv_max_port": 30010, + "pasv_address": "", + "ssl": false, + "certfile": "fullchain.pem", + "keyfile": "privkey.pem", + "implicit_ssl": false, + "max_clients": 5, + "users": [ + { + "username": "hassio", + "password": "changeme", + "allow_chmod": false, + "allow_download": false, + "allow_upload": false, + "allow_dirlist": true, + "addons": false, + "backup": false, + "config": false, + "share": true, + "ssl": false + } + ] + }, + "schema": { + "log_level": "match(^(trace|debug|info|notice|warning|error|fatal)$)", + "port": "port", + "data_port": "port", + "banner": "str", + "pasv": "bool", + "pasv_min_port": "port", + "pasv_max_port": "port", + "pasv_address": "str", + "ssl": "bool", + "certfile": "str", + "keyfile": "str", + "implicit_ssl": "bool", + "max_clients": "int", + "users": [ + { + "username": "match(^[a-zA-Z0-9\\d](?:[a-zA-Z0-9\\d]|-(?=[a-zA-Z0-9\\d])){0,32}$)", + "password": "str", + "allow_chmod": "bool", + "allow_download": "bool", + "allow_upload": "bool", + "allow_dirlist": "bool", + "addons": "bool", + "backup": "bool", + "config": "bool", + "share": "bool", + "ssl": "bool" + } + ] + }, + "environment": { + "LOG_FORMAT": "{LEVEL}: {MESSAGE}", + "SUPERVISOR_VERSION": ">=0.76.0" + }, + "image": "hassioaddons/ftp-{arch}" +} diff --git a/ftp/logo.png b/ftp/logo.png new file mode 100644 index 00000000..544257d2 Binary files /dev/null and b/ftp/logo.png differ