diff --git a/README.md b/README.md index ea088300..9b5e618f 100644 --- a/README.md +++ b/README.md @@ -333,10 +333,10 @@ SOFTWARE. [example-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg [example-armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg [example-i386-shield]: https://img.shields.io/badge/i386-yes-green.svg -[addon-ftp]: https://github.com/hassio-addons/addon-ftp/tree/v1.0.0 -[addon-doc-ftp]: https://github.com/hassio-addons/addon-ftp/blob/v1.0.0/README.md +[addon-ftp]: https://github.com/hassio-addons/addon-ftp/tree/v1.1.0 +[addon-doc-ftp]: https://github.com/hassio-addons/addon-ftp/blob/v1.1.0/README.md [ftp-issue]: https://github.com/hassio-addons/addon-ftp/issues -[ftp-version-shield]: https://img.shields.io/badge/version-v1.0.0-blue.svg +[ftp-version-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg [ftp-pulls-shield]: https://img.shields.io/docker/pulls/hassioaddons/ftp-armhf.svg [ftp-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg [ftp-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg diff --git a/ftp/CHANGELOG.md b/ftp/CHANGELOG.md index 579bfd06..b8cd3607 100644 --- a/ftp/CHANGELOG.md +++ b/ftp/CHANGELOG.md @@ -1,8 +1,29 @@ -[Full Changelog][v0.2.0-v1.0.0] +[Full Changelog][changelog] + +### Added + +- Adds .yamllint configuration +- Adds all architectures to add-on config +- Adds Probot configuration +- Adds initial add-on README template +- Adds Gitlab CI + +### Fixed + +- Fixes Markdownlint warning in License +- Fixes hadolint warnings ### Changed -- Updated add-on icon & logo -- Upgrades add-on base image to v1.3.3 +- Replaces Changelog with GitHub releases +- Upgrades add-on base image to v1.4.1 +- Updates README +- Fixes apparmor issues on mounting resources -[v0.2.0-v1.0.0]: https://github.com/hassio-addons/addon-ftp/compare/v0.2.0...v1.0.0 \ No newline at end of file +### Removed + +- Removes CodeClimate +- Removes CircleCI +- Removes supervisor version constraint from add-on config + +[changelog]: https://github.com/hassio-addons/addon-ftp/compare/v1.0.0...v1.1.0 \ No newline at end of file diff --git a/ftp/README.md b/ftp/README.md new file mode 100644 index 00000000..f0a6ed67 --- /dev/null +++ b/ftp/README.md @@ -0,0 +1,53 @@ +# Community Hass.io Add-ons: FTP + +[![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] + +A secure and fast FTP server for Hass.io + +## About + +The FTP protocol might be come in handy sometimes. While old, +it still has its use. For example, most IP Cameras still support the upload +of images or videos via FTP. + +This add-on provides an FTP Server for Hass.io in a reasonably secure manner. +While FTP is not entirely secure by its (unencrypted) nature, this add-on +supports FTP over SSL (FTPS) and jails (chroot) the virtual users in their +home directories. + +Of course, if you'd really want to, you could also use this add-on to again +access to your Home Assistant configuration via FTP. + +[Click here for the full documentation][docs] + +## WARNING! THIS IS A BETA VERSION! + +This Hass.io Add-ons repository contains beta releases of add-ons. + +- 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. + +If you are more interested in stable releases of our add-ons: + + + +[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg +[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg +[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-ftp/36799?u=frenck +[discord-shield]: https://img.shields.io/discord/330944238910963714.svg +[discord]: https://discord.gg/c5DvZ4e +[maintenance-shield]: https://img.shields.io/maintenance/yes/2018.svg +[release-shield]: https://img.shields.io/badge/version-v1.1.0-blue.svg +[release]: https://github.com/hassio-addons/addon-ftp/tree/v1.1.0 +[docs]: https://github.com/hassio-addons/addon-ftp/blob/v1.1.0/README.md +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg +[buymeacoffee]: https://www.buymeacoffee.com/frenck \ No newline at end of file diff --git a/ftp/config.json b/ftp/config.json index c430c29e..054a6b72 100644 --- a/ftp/config.json +++ b/ftp/config.json @@ -1,10 +1,16 @@ { "name": "FTP", - "version": "1.0.0", + "version": "1.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", + "arch": [ + "aarch64", + "amd64", + "armhf", + "i386" + ], "boot": "auto", "hassio_api": true, "homeassistant_api": false, @@ -12,6 +18,7 @@ "privileged": [ "SYS_ADMIN" ], + "apparmor": false, "map": [ "addons:rw", "backup:rw", @@ -80,8 +87,7 @@ ] }, "environment": { - "LOG_FORMAT": "{LEVEL}: {MESSAGE}", - "SUPERVISOR_VERSION": ">=0.82.0" + "LOG_FORMAT": "{LEVEL}: {MESSAGE}" }, "image": "hassioaddons/ftp-{arch}" } \ No newline at end of file