Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/hassio-addons/addon-ide

IDE - Home Assistant Community Add-ons
https://github.com/hassio-addons/addon-ide

addon addons cloud9-ide home-assistant homeassistant ide

Last synced: 2 months ago
JSON representation

IDE - Home Assistant Community Add-ons

Lists

README 

        
# Home Assistant Community Add-on: IDE



[![GitHub Release][releases-shield]][releases]

![Project Stage][project-stage-shield]

[![License][license-shield]](LICENSE.md)



![Supports aarch64 Architecture][aarch64-shield]

![Supports amd64 Architecture][amd64-shield]

![Supports armhf Architecture][armhf-shield]

![Supports armv7 Architecture][armv7-shield]

![Supports i386 Architecture][i386-shield]



[![GitLab CI][gitlabci-shield]][gitlabci]

![Project Maintenance][maintenance-shield]

[![GitHub Activity][commits-shield]][commits]



[![Discord][discord-shield]][discord]

[![Community Forum][forum-shield]][forum]



[![Sponsor Frenck via GitHub Sponsors][github-sponsors-shield]][github-sponsors]



[![Support Frenck on Patreon][patreon-shield]][patreon]



Advanced IDE for Home Assistant, based on Cloud9 IDE



## Deprecation warning



**This add-on is in a deprecated state!**



This add-on is powered by the Cloud9 IDE project, which has been acquired by

Amazon in 2016. As of 17 October 2018, the open source development of the

Cloud9 Core has been halted.



It became harder to maintain and keep this add-on running. As the world

advances, but the C9 does not, so things become incompatible over time.



The point of no longer being able to upgrade parts of the add-on, has come.



Therefore this add-on will no longer receive any updates and is deprecated.



If you are running Hass.io on an amd64 based system, we would recommend changing

to the vscode add-on. For other architectures (e.g., Raspberry Pi), we expect

to release an alternative add-on.



## About



Cloud9 IDE is an online integrated development environment. It supports

hundreds of programming languages, including C, C++, PHP, Ruby, Perl, Python,

JavaScript with Node.js, and Go.



This add-on is a packaged version of the Cloud9 IDE, tuned for use with Home

Assistant. It is designed to allow you to configure and edit your Home Assistant

setup straight from the web interface using a useful, pretty and fullblown

editor.



![IDE in the Home Assistant Frontend](images/screenshot.png)



## Installation



The installation of this add-on is pretty straightforward and not different in

comparison to installing any other Home Assistant add-on.



1. Search for the "IDE" add-on in the Supervisor add-on store and install it.

1. Start the "IDE" add-on

1. Check the logs of the "IDE" add-on to see if everything went well.

1. Surf to your Hass.io instance and use port `8321`

    (e.g. `http://hassio.local:8321`).

1. Login using your Home Assistant credentials.



## Configuration



**Note**: _Remember to restart the add-on when the configuration is changed._



Example add-on configuration:



```yaml

log_level: info

ssl: true

certfile: fullchain.pem

keyfile: privkey.pem

packages:

  - php7-cli

init_commands: []

```



**Note**: _This is just an example, don't copy and paste it! Create your own!_



### Option: `log_level`



The `log_level` option controls the level of log output by the addon and can

be changed to be more or less verbose, which might be useful when you are

dealing with an unknown issue. Possible values are:



- `trace`: Show every detail, like all called internal functions.

- `debug`: Shows detailed debug information.

- `info`: Normal (usually) interesting events.

- `warning`: Exceptional occurrences that are not errors.

- `error`:  Runtime errors that do not require immediate action.

- `fatal`: Something went terribly wrong. Add-on becomes unusable.



Please note that each level automatically includes log messages from a

more severe level, e.g., `debug` also shows `info` messages. By default,

the `log_level` is set to `info`, which is the recommended setting unless

you are troubleshooting.



Using `trace` or `debug` log levels puts the cloud9 server into debug mode

as well.



### Option: `ssl`



Enables/Disables SSL (HTTPS) on the IDE. Set it `true` to enable it,

`false` otherwise.



### Option: `certfile`



The certificate file to use for SSL.



**Note**: _The file MUST be stored in `/ssl/`, which is the default_



### Option: `keyfile`



The private key file to use for SSL.



**Note**: _The file MUST be stored in `/ssl/`, which is the default_



### Option: `packages`



Allows you to specify additional [Alpine packages][alpine-packages] to be

installed in your shell environment (e.g., Python, PHP, Go).



**Note**: _Adding many packages will result in a longer start-up

time for the add-on._



### Option: `init_commands`



Customize your IDE environment even more with the `init_commands` option.

Add one or more shell commands to the list, and they will be executed every

single time this add-on starts.



### Option: `leave_front_door_open`



Adding this option to the add-on configuration allows you to disable

authentication on the IDE by setting it to `true`.



**Note**: _We STRONGLY suggest, not to use this, even if this add-on is

only exposed to your internal network. USE AT YOUR OWN RISK!_



## Embedding into Home Assistant



It is possible to embed the IDE directly into Home Assistant, allowing

you to access your IDE through the Home Assistant frontend.



Home Assistant provides the `panel_iframe` integration, for these purposes.



Example configuration:



```yaml

panel_iframe:

  ide:

    title: IDE

    icon: mdi:code-braces

    url: https://addres.to.your.hass.io:8321

```



## Known issues and limitations



This add-on is currently in an experimental state, and some features are not

implemented yet. Some of the presently known limitations:



- User and project settings are not persistent between add-on restarts.

- Auto-completion is based on file contents and does not yet query Home

  Assistant.

- `ZSH` is available, but not enabled by default, due to Cloud9 limitations.



## Changelog & Releases



This repository keeps a change log using [GitHub's releases][releases]

functionality. The format of the log is based on

[Keep a Changelog][keepchangelog].



Releases are based on [Semantic Versioning][semver], and use the format

of ``MAJOR.MINOR.PATCH``. In a nutshell, the version will be incremented

based on the following:



- ``MAJOR``: Incompatible or major changes.

- ``MINOR``: Backwards-compatible new features and enhancements.

- ``PATCH``: Backwards-compatible bugfixes and package updates.



## Support



Got questions?



You have several options to get them answered:



- The [Home Assistant Community Add-ons Discord chat server][discord] for add-on

  support and feature requests.

- The [Home Assistant Discord chat server][discord-ha] for general Home

  Assistant discussions and questions.

- The Home Assistant [Community Forum][forum].

- Join the [Reddit subreddit][reddit] in [/r/homeassistant][reddit]



You could also [open an issue here][issue] GitHub.



## Contributing



This is an active open-source project. We are always open to people who want to

use the code or contribute to it.



We have set up a separate document containing our

[contribution guidelines](CONTRIBUTING.md).



Thank you for being involved! :heart_eyes:



## Authors & contributors



The original setup of this repository is by [Franck Nijhof][frenck].



For a full list of all authors and contributors,

check [the contributor's page][contributors].



## We have got some Home Assistant add-ons for you



Want some more functionality to your Home Assistant instance?



We have created multiple add-ons for Home Assistant. For a full list, check out

our [GitHub Repository][repository].



## License



MIT License



Copyright (c) 2017-2020 Franck Nijhof



Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to deal

in the Software without restriction, including without limitation the rights

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:



The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.



THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

SOFTWARE.



[aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg

[alpine-packages]: https://pkgs.alpinelinux.org/packages

[amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg

[armhf-shield]: https://img.shields.io/badge/armhf-yes-green.svg

[armv7-shield]: https://img.shields.io/badge/armv7-yes-green.svg

[commits-shield]: https://img.shields.io/github/commit-activity/y/hassio-addons/addon-ide.svg

[commits]: https://github.com/hassio-addons/addon-ide/commits/master

[contributors]: https://github.com/hassio-addons/addon-ide/graphs/contributors

[discord-ha]: https://discord.gg/c5DvZ4e

[discord-shield]: https://img.shields.io/discord/478094546522079232.svg

[discord]: https://discord.me/hassioaddons

[forum-shield]: https://img.shields.io/badge/community-forum-brightgreen.svg

[forum]: https://community.home-assistant.io/t/community-hass-io-add-on-ide-based-on-cloud9/33810?u=frenck

[frenck]: https://github.com/frenck

[github-sponsors-shield]: https://frenck.dev/wp-content/uploads/2019/12/github_sponsor.png

[github-sponsors]: https://github.com/sponsors/frenck

[gitlabci-shield]: https://gitlab.com/hassio-addons/addon-ide/badges/master/pipeline.svg

[gitlabci]: https://gitlab.com/hassio-addons/addon-ide/pipelines

[home-assistant]: https://home-assistant.io

[i385-shield]: https://img.shields.io/badge/i386-yes-green.svg

[i386-shield]: https://img.shields.io/badge/i386-yes-green.svg

[issue]: https://github.com/hassio-addons/addon-ide/issues

[keepchangelog]: http://keepachangelog.com/en/1.0.0/

[license-shield]: https://img.shields.io/github/license/hassio-addons/addon-ide.svg

[maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg

[ohmyzsh]: http://ohmyz.sh/

[patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png

[patreon]: https://www.patreon.com/frenck

[project-stage-shield]: https://img.shields.io/badge/project%20stage-%20!%20DEPRECATED%20%20%20!-ff0000.svg

[reddit]: https://reddit.com/r/homeassistant

[releases-shield]: https://img.shields.io/github/release/hassio-addons/addon-ide.svg

[releases]: https://github.com/hassio-addons/addon-ide/releases

[repository]: https://github.com/hassio-addons/repository

[semver]: http://semver.org/spec/v2.0.0.htm

[zsh]: https://en.wikipedia.org/wiki/Z_shell