Home Assistant Community Add-on: IDE

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.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Home Assistant add-on.

Search for the "IDE" add-on in the Supervisor add-on store and install it.
Start the "IDE" add-on
Check the logs of the "IDE" add-on to see if everything went well.
Surf to your Hass.io instance and use port 8321 (e.g. http://hassio.local:8321).
Login using your Home Assistant credentials.

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

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

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 functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, 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 for add-on support and feature requests.
The Home Assistant Discord chat server for general Home Assistant discussions and questions.
The Home Assistant Community Forum.
Join the Reddit subreddit in /r/homeassistant

You could also open an issue here 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.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

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.

License

MIT License

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.

hassio-addons/addon-ide