diff --git a/README.md b/README.md index 4b86751..ee9abeb 100644 --- a/README.md +++ b/README.md @@ -85,25 +85,6 @@ 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. -### Option: `ssl` - -Enables/Disables SSL (HTTPS). Set it `true` to enable it, `false` otherwise. - -**Note**: _The SSL settings only apply to direct access and has no effect -on the Ingress service._ - -### 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 [Ubuntu packages][ubuntu-packages] to be @@ -120,15 +101,7 @@ single time this add-on starts. ### Option: `disable_telemetry` -Disables annonymous usage telemetry data from being sent to code-server. - -### Option: `leave_front_door_open` - -Adding this option to the add-on configuration allows you to disable -authentication on the VSCode 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!_ +Disables anonymous usage telemetry data from being sent to code-server. ## Resetting your VSCode settings to the add-on defaults diff --git a/vscode/config.json b/vscode/config.json index a8ab7c9..b10d926 100755 --- a/vscode/config.json +++ b/vscode/config.json @@ -4,42 +4,26 @@ "slug": "vscode", "description": "Fully featured VSCode experience, to edit your HA config in the browser, including auto-completion!", "url": "https://github.com/hassio-addons/addon-vscode", - "webui": "[PROTO:ssl]://[HOST]:[PORT:80]", "ingress": true, "ingress_port": 1337, "panel_icon": "mdi:visual-studio-code", "startup": "services", - "homeassistant": "0.92.0b2", "arch": ["amd64"], "boot": "auto", "hassio_api": true, - "auth_api": true, "hassio_role": "manager", "homeassistant_api": true, "auto_uart": true, - "ports": { - "80/tcp": null - }, - "ports_description": { - "80/tcp": "VSCode (Not required for Ingress)" - }, "map": ["config:rw", "ssl:rw", "addons:rw", "share:rw", "backup:rw"], "options": { - "ssl": true, - "certfile": "fullchain.pem", - "keyfile": "privkey.pem", "packages": [], "init_commands": [], "disable_telemetry": false }, "schema": { "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", - "ssl": "bool", - "certfile": "str", - "keyfile": "str", "packages": ["str"], "init_commands": ["str"], - "disable_telemetry": "bool?", - "leave_front_door_open": "bool?" + "disable_telemetry": "bool?" } } diff --git a/vscode/rootfs/etc/cont-init.d/nginx.sh b/vscode/rootfs/etc/cont-init.d/nginx.sh deleted file mode 100644 index bf82a58..0000000 --- a/vscode/rootfs/etc/cont-init.d/nginx.sh +++ /dev/null @@ -1,36 +0,0 @@ -#!/usr/bin/with-contenv bashio -# ============================================================================== -# Home Assistant Community Add-on: Visual Studio Code -# Configures NGINX for use with code-server -# ============================================================================== -declare port -declare certfile -declare dns_host -declare ingress_interface -declare ingress_port -declare keyfile - -port=$(bashio::addon.port 80) -if bashio::var.has_value "${port}"; then - bashio::config.require.ssl - - if bashio::config.true 'ssl'; then - certfile=$(bashio::config 'certfile') - keyfile=$(bashio::config 'keyfile') - - mv /etc/nginx/servers/direct-ssl.disabled /etc/nginx/servers/direct.conf - sed -i "s#%%certfile%%#${certfile}#g" /etc/nginx/servers/direct.conf - sed -i "s#%%keyfile%%#${keyfile}#g" /etc/nginx/servers/direct.conf - - else - mv /etc/nginx/servers/direct.disabled /etc/nginx/servers/direct.conf - fi -fi - -ingress_port=$(bashio::addon.ingress_port) -ingress_interface=$(bashio::addon.ip_address) -sed -i "s/%%port%%/${ingress_port}/g" /etc/nginx/servers/ingress.conf -sed -i "s/%%interface%%/${ingress_interface}/g" /etc/nginx/servers/ingress.conf - -dns_host=$(bashio::dns.host) -sed -i "s/%%dns_host%%/${dns_host}/g" /etc/nginx/includes/resolver.conf diff --git a/vscode/rootfs/etc/nginx/includes/mime.types b/vscode/rootfs/etc/nginx/includes/mime.types deleted file mode 100644 index 7c7cdef..0000000 --- a/vscode/rootfs/etc/nginx/includes/mime.types +++ /dev/null @@ -1,96 +0,0 @@ -types { - text/html html htm shtml; - text/css css; - text/xml xml; - image/gif gif; - image/jpeg jpeg jpg; - application/javascript js; - application/atom+xml atom; - application/rss+xml rss; - - text/mathml mml; - text/plain txt; - text/vnd.sun.j2me.app-descriptor jad; - text/vnd.wap.wml wml; - text/x-component htc; - - image/png png; - image/svg+xml svg svgz; - image/tiff tif tiff; - image/vnd.wap.wbmp wbmp; - image/webp webp; - image/x-icon ico; - image/x-jng jng; - image/x-ms-bmp bmp; - - font/woff woff; - font/woff2 woff2; - - application/java-archive jar war ear; - application/json json; - application/mac-binhex40 hqx; - application/msword doc; - application/pdf pdf; - application/postscript ps eps ai; - application/rtf rtf; - application/vnd.apple.mpegurl m3u8; - application/vnd.google-earth.kml+xml kml; - application/vnd.google-earth.kmz kmz; - application/vnd.ms-excel xls; - application/vnd.ms-fontobject eot; - application/vnd.ms-powerpoint ppt; - application/vnd.oasis.opendocument.graphics odg; - application/vnd.oasis.opendocument.presentation odp; - application/vnd.oasis.opendocument.spreadsheet ods; - application/vnd.oasis.opendocument.text odt; - application/vnd.openxmlformats-officedocument.presentationml.presentation - pptx; - application/vnd.openxmlformats-officedocument.spreadsheetml.sheet - xlsx; - application/vnd.openxmlformats-officedocument.wordprocessingml.document - docx; - application/vnd.wap.wmlc wmlc; - application/x-7z-compressed 7z; - application/x-cocoa cco; - application/x-java-archive-diff jardiff; - application/x-java-jnlp-file jnlp; - application/x-makeself run; - application/x-perl pl pm; - application/x-pilot prc pdb; - application/x-rar-compressed rar; - application/x-redhat-package-manager rpm; - application/x-sea sea; - application/x-shockwave-flash swf; - application/x-stuffit sit; - application/x-tcl tcl tk; - application/x-x509-ca-cert der pem crt; - application/x-xpinstall xpi; - application/xhtml+xml xhtml; - application/xspf+xml xspf; - application/zip zip; - - application/octet-stream bin exe dll; - application/octet-stream deb; - application/octet-stream dmg; - application/octet-stream iso img; - application/octet-stream msi msp msm; - - audio/midi mid midi kar; - audio/mpeg mp3; - audio/ogg ogg; - audio/x-m4a m4a; - audio/x-realaudio ra; - - video/3gpp 3gpp 3gp; - video/mp2t ts; - video/mp4 mp4; - video/mpeg mpeg mpg; - video/quicktime mov; - video/webm webm; - video/x-flv flv; - video/x-m4v m4v; - video/x-mng mng; - video/x-ms-asf asx asf; - video/x-ms-wmv wmv; - video/x-msvideo avi; -} diff --git a/vscode/rootfs/etc/nginx/includes/proxy_params.conf b/vscode/rootfs/etc/nginx/includes/proxy_params.conf deleted file mode 100644 index ec26601..0000000 --- a/vscode/rootfs/etc/nginx/includes/proxy_params.conf +++ /dev/null @@ -1,15 +0,0 @@ -proxy_http_version 1.1; -proxy_ignore_client_abort off; -proxy_read_timeout 86400s; -proxy_redirect off; -proxy_send_timeout 86400s; -proxy_max_temp_file_size 0; - -proxy_set_header Accept-Encoding "gzip"; -proxy_set_header Connection $connection_upgrade; -proxy_set_header Host $http_host; -proxy_set_header Upgrade $http_upgrade; -proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; -proxy_set_header X-Forwarded-Proto $scheme; -proxy_set_header X-NginX-Proxy true; -proxy_set_header X-Real-IP $remote_addr; diff --git a/vscode/rootfs/etc/nginx/includes/resolver.conf b/vscode/rootfs/etc/nginx/includes/resolver.conf deleted file mode 100644 index d864899..0000000 --- a/vscode/rootfs/etc/nginx/includes/resolver.conf +++ /dev/null @@ -1 +0,0 @@ -resolver %%dns_host%%; diff --git a/vscode/rootfs/etc/nginx/includes/server_params.conf b/vscode/rootfs/etc/nginx/includes/server_params.conf deleted file mode 100644 index 09c0654..0000000 --- a/vscode/rootfs/etc/nginx/includes/server_params.conf +++ /dev/null @@ -1,6 +0,0 @@ -root /dev/null; -server_name $hostname; - -add_header X-Content-Type-Options nosniff; -add_header X-XSS-Protection "1; mode=block"; -add_header X-Robots-Tag none; diff --git a/vscode/rootfs/etc/nginx/includes/ssl_params.conf b/vscode/rootfs/etc/nginx/includes/ssl_params.conf deleted file mode 100644 index 6f15005..0000000 --- a/vscode/rootfs/etc/nginx/includes/ssl_params.conf +++ /dev/null @@ -1,9 +0,0 @@ -ssl_protocols TLSv1.2; -ssl_prefer_server_ciphers on; -ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES256-SHA:DHE-RSA-AES256-SHA; -ssl_ecdh_curve secp384r1; -ssl_session_timeout 10m; -ssl_session_cache shared:SSL:10m; -ssl_session_tickets off; -ssl_stapling on; -ssl_stapling_verify on; diff --git a/vscode/rootfs/etc/nginx/includes/upstream.conf b/vscode/rootfs/etc/nginx/includes/upstream.conf deleted file mode 100644 index 8c9b878..0000000 --- a/vscode/rootfs/etc/nginx/includes/upstream.conf +++ /dev/null @@ -1,3 +0,0 @@ -upstream backend { - server 127.0.0.1:8443; -} diff --git a/vscode/rootfs/etc/nginx/lua/ha-auth.lua b/vscode/rootfs/etc/nginx/lua/ha-auth.lua deleted file mode 100644 index a2c633c..0000000 --- a/vscode/rootfs/etc/nginx/lua/ha-auth.lua +++ /dev/null @@ -1,83 +0,0 @@ -local http = require "resty.http" -local auths = ngx.shared.auths - -function authenticate() - - --- Test Authentication header is set and with a value - local header = ngx.req.get_headers()['Authorization'] - if header == nil or header:find(" ") == nil then - return false - end - - local divider = header:find(' ') - if header:sub(0, divider-1) ~= 'Basic' then - return false - end - - local auth = ngx.decode_base64(header:sub(divider+1)) - if auth == nil or auth:find(':') == nil then - return false - end - - divider = auth:find(':') - local username = auth:sub(0, divider-1) - local password = auth:sub(divider+1) - - --- Check if authentication is cached - if auths:get(username) == password then - ngx.log(ngx.DEBUG, "Authenticated user against Home Assistant (cache).") - return true - end - - --- HTTP request against the Supervisor API - local httpc = http.new() - local res, err = httpc:request_uri("http://supervisor.local.hass.io/auth", { - method = "POST", - body = ngx.encode_args({["username"]=username, ["password"]=password}), - headers = { - ["Content-Type"] = "application/x-www-form-urlencoded", - ["X-Supervisor-Token"] = os.getenv("SUPERVISOR_TOKEN"), - }, - keepalive_timeout = 60, - keepalive_pool = 10 - }) - - --- Error during API request - if err then - ngx.log(ngx.WARN, "Error during Home Assistant user authentication.", err) - return false - end - - --- No result? Something went wrong... - if not res then - ngx.log(ngx.WARN, "Error during Home Assistant user authentication.") - return false - end - - --- Valid response, the username/password is valid - if res.status == 200 then - ngx.log(ngx.INFO, "Authenticated user against Home Assistant.") - auths:set(username, password, 60) - return true - end - - --- Whatever the response is, it is invalid - ngx.log(ngx.WARN, "Authentication against Home Assistant failed!") - return false -end - --- Only authenticate if its not disabled -if not os.getenv('DISABLE_HA_AUTHENTICATION') then - - --- Try to authenticate against HA - local authenticated = authenticate() - - --- If authentication failed, throw a basic auth - if not authenticated then - ngx.header.content_type = 'text/plain' - ngx.header.www_authenticate = 'Basic realm="Home Assistant"' - ngx.status = ngx.HTTP_UNAUTHORIZED - ngx.say('401 Access Denied') - ngx.exit(ngx.HTTP_UNAUTHORIZED) - end -end diff --git a/vscode/rootfs/etc/nginx/modules/ndk_http.conf b/vscode/rootfs/etc/nginx/modules/ndk_http.conf deleted file mode 100644 index 2663122..0000000 --- a/vscode/rootfs/etc/nginx/modules/ndk_http.conf +++ /dev/null @@ -1 +0,0 @@ -load_module "/usr/lib/nginx/modules/ndk_http_module.so"; diff --git a/vscode/rootfs/etc/nginx/modules/ngx_http_lua.conf b/vscode/rootfs/etc/nginx/modules/ngx_http_lua.conf deleted file mode 100644 index f885ed9..0000000 --- a/vscode/rootfs/etc/nginx/modules/ngx_http_lua.conf +++ /dev/null @@ -1 +0,0 @@ -load_module "/usr/lib/nginx/modules/ngx_http_lua_module.so"; diff --git a/vscode/rootfs/etc/nginx/nginx.conf b/vscode/rootfs/etc/nginx/nginx.conf deleted file mode 100644 index c251be5..0000000 --- a/vscode/rootfs/etc/nginx/nginx.conf +++ /dev/null @@ -1,58 +0,0 @@ -# Run nginx in foreground. -daemon off; - -# This is run inside Docker. -user root; - -# Pid storage location. -pid /var/run/nginx.pid; - -# Set number of worker processes. -worker_processes 1; - -# Enables the use of JIT for regular expressions to speed-up their processing. -pcre_jit on; - -# Write error log to the add-on log. -error_log /proc/1/fd/1 error; - -# Load allowed environment vars -env SUPERVISOR_TOKEN; -env DISABLE_HA_AUTHENTICATION; - -# Load dynamic modules. -include /etc/nginx/modules/*.conf; - -# Max num of simultaneous connections by a worker process. -events { - worker_connections 512; -} - -http { - include /etc/nginx/includes/mime.types; - - log_format homeassistant '[$time_local] $status ' - '$http_x_forwarded_for($remote_addr) ' - '$request ($http_user_agent)'; - - access_log /proc/1/fd/1 homeassistant; - client_max_body_size 4G; - default_type application/octet-stream; - gzip on; - keepalive_timeout 65; - lua_shared_dict auths 16k; - sendfile on; - server_tokens off; - tcp_nodelay on; - tcp_nopush on; - - map $http_upgrade $connection_upgrade { - default upgrade; - '' close; - } - - include /etc/nginx/includes/resolver.conf; - include /etc/nginx/includes/upstream.conf; - - include /etc/nginx/servers/*.conf; -} diff --git a/vscode/rootfs/etc/nginx/servers/direct-ssl.disabled b/vscode/rootfs/etc/nginx/servers/direct-ssl.disabled deleted file mode 100644 index 5587fbe..0000000 --- a/vscode/rootfs/etc/nginx/servers/direct-ssl.disabled +++ /dev/null @@ -1,16 +0,0 @@ -server { - listen 80 default_server ssl http2; - - include /etc/nginx/includes/server_params.conf; - include /etc/nginx/includes/ssl_params.conf; - include /etc/nginx/includes/proxy_params.conf; - - ssl on; - ssl_certificate /ssl/%%certfile%%; - ssl_certificate_key /ssl/%%keyfile%%; - - location / { - access_by_lua_file /etc/nginx/lua/ha-auth.lua; - proxy_pass http://backend; - } -} diff --git a/vscode/rootfs/etc/nginx/servers/direct.disabled b/vscode/rootfs/etc/nginx/servers/direct.disabled deleted file mode 100644 index 0065acb..0000000 --- a/vscode/rootfs/etc/nginx/servers/direct.disabled +++ /dev/null @@ -1,11 +0,0 @@ -server { - listen 80 default_server; - - include /etc/nginx/includes/server_params.conf; - include /etc/nginx/includes/proxy_params.conf; - - location / { - access_by_lua_file /etc/nginx/lua/ha-auth.lua; - proxy_pass http://backend; - } -} diff --git a/vscode/rootfs/etc/nginx/servers/ingress.conf b/vscode/rootfs/etc/nginx/servers/ingress.conf deleted file mode 100644 index 225f316..0000000 --- a/vscode/rootfs/etc/nginx/servers/ingress.conf +++ /dev/null @@ -1,13 +0,0 @@ -server { - listen %%interface%%:1337 default_server; - - include /etc/nginx/includes/server_params.conf; - include /etc/nginx/includes/proxy_params.conf; - - location / { - allow 172.30.32.2; - deny all; - - proxy_pass http://backend; - } -} diff --git a/vscode/rootfs/etc/services.d/code/run b/vscode/rootfs/etc/services.d/code/run index 269ef06..54507e9 100644 --- a/vscode/rootfs/etc/services.d/code/run +++ b/vscode/rootfs/etc/services.d/code/run @@ -7,10 +7,10 @@ declare -a options bashio::log.info 'Starting the code server...' -options+=(--port 8443) +options+=(--port 1337) options+=(--user-data-dir "/data/vscode") options+=(--extensions-dir "/data/vscode/extensions") -options+=(--host 127.0.0.1) +options+=(--host 0.0.0.0) if bashio::config.true 'disable_telemetry'; then options+=(--disable-telemetry) diff --git a/vscode/rootfs/etc/services.d/nginx/finish b/vscode/rootfs/etc/services.d/nginx/finish deleted file mode 100644 index 8fa1a7f..0000000 --- a/vscode/rootfs/etc/services.d/nginx/finish +++ /dev/null @@ -1,9 +0,0 @@ -#!/usr/bin/execlineb -S0 -# ============================================================================== -# Home Assistant Community Add-on: Visual Studio Code -# Take down the S6 supervision tree when Nginx fails -# ============================================================================== -if { s6-test ${1} -ne 0 } -if { s6-test ${1} -ne 256 } - -s6-svscanctl -t /var/run/s6/services diff --git a/vscode/rootfs/etc/services.d/nginx/run b/vscode/rootfs/etc/services.d/nginx/run deleted file mode 100644 index 388dce5..0000000 --- a/vscode/rootfs/etc/services.d/nginx/run +++ /dev/null @@ -1,17 +0,0 @@ -#!/usr/bin/with-contenv bashio -# ============================================================================== -# Home Assistant Community Add-on: Visual Studio Code -# Runs the Nginx daemon -# ============================================================================== - -# Wait for code-server to become available -bashio::net.wait_for 8443 - -bashio::log.info "Starting NGinx..." - -# Disable HA Authentication if front door is open -if bashio::config.true 'leave_front_door_open'; then - export DISABLE_HA_AUTHENTICATION=true -fi - -exec nginx