├── images └── sample.png ├── nightscout ├── icon.png ├── logo.png ├── build.json ├── rootfs │ └── etc │ │ ├── services.d │ │ ├── nightscout │ │ │ ├── finish │ │ │ └── run │ │ ├── nginx │ │ │ ├── finish │ │ │ └── run │ │ └── mongodb │ │ │ ├── finish │ │ │ └── run │ │ ├── cont-init.d │ │ ├── nightscout.sh │ │ ├── mongodb.sh │ │ └── nginx.sh │ │ └── nginx │ │ ├── nginx.conf │ │ └── nginx-ssl.conf ├── config.json ├── Dockerfile └── DOCS.md ├── .gitattributes ├── .github ├── dependabot.yml └── workflows │ ├── manually_update_repo.yml │ ├── test.yml │ └── publish.yml ├── CHANGELOG.md ├── .devcontainer ├── Dockerfile └── devcontainer.json ├── .gitignore ├── README.md └── LICENSE.md /images/sample.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marciogranzotto/addon-nightscout/HEAD/images/sample.png -------------------------------------------------------------------------------- /nightscout/icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marciogranzotto/addon-nightscout/HEAD/nightscout/icon.png -------------------------------------------------------------------------------- /nightscout/logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/marciogranzotto/addon-nightscout/HEAD/nightscout/logo.png -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | *.{cmd,[cC][mM][dD]} text eol=crlf 3 | *.{bat,[bB][aA][tT]} text eol=crlf -------------------------------------------------------------------------------- /nightscout/build.json: -------------------------------------------------------------------------------- 1 | { 2 | "args": {}, 3 | "build_from": { 4 | "aarch64": "ghcr.io/hassio-addons/ubuntu-base/aarch64:6.2.1", 5 | "amd64": "ghcr.io/hassio-addons/ubuntu-base:8.1.1" 6 | } 7 | } -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | - package-ecosystem: docker 4 | directory: "/nightscout" 5 | schedule: 6 | interval: daily 7 | time: "08:00" 8 | open-pull-requests-limit: 10 9 | target-branch: master 10 | reviewers: 11 | - marciogranzotto 12 | assignees: 13 | - marciogranzotto 14 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/nightscout/finish: -------------------------------------------------------------------------------- 1 | #!/usr/bin/execlineb -S0 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # ============================================================================== 5 | if -n { s6-test $# -ne 0 } 6 | if -n { s6-test ${1} -eq 256 } 7 | 8 | #s6-svscanctl -t /var/run/s6/services 9 | /run/s6/basedir/bin/halt 10 | -------------------------------------------------------------------------------- /.github/workflows/manually_update_repo.yml: -------------------------------------------------------------------------------- 1 | name: Update addons repository 2 | on: 3 | repository_dispatch 4 | jobs: 5 | update-main-repo: 6 | name: Update addons repository 7 | runs-on: ubuntu-latest 8 | container: 9 | image: hassioaddons/repository-updater:latest 10 | steps: 11 | - name: upload 12 | run: repository-updater --token ${{ secrets.GIT_TOKEN }} --repository marciogranzotto/addons-repository --addon nightscout 13 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/nginx/finish: -------------------------------------------------------------------------------- 1 | #!/usr/bin/execlineb -S0 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # Take down the S6 supervision tree when Nginx fails 5 | # ============================================================================== 6 | if -n { s6-test $# -ne 0 } 7 | if -n { s6-test ${1} -eq 256 } 8 | 9 | #s6-svscanctl -t /var/run/s6/services 10 | /run/s6/basedir/bin/halt 11 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/mongodb/finish: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bash 2 | # ============================================================================== 3 | # Gracefully stop MongoDB 4 | # ============================================================================== 5 | 6 | # Send the SIGTERM signal to MongoDB to allow it to perform a graceful shutdown 7 | pkill -SIGTERM mongod 8 | 9 | # Wait for MongoDB to shut down 10 | timeout 30 sh -c 'until [ "$(pgrep mongod)" = "" ]; do sleep 1; done' 11 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Changelog 2 | All notable changes to this project will be documented in this file. 3 | 4 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 5 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). 6 | 7 | ## v1.2.0 8 | - Update Nightscout from 14.0.4 to 14.2.2 9 | - Update base images 10 | - Update dependencies 11 | - Remove unsupported architectures (armv7 and i386) 12 | 13 | ## [Unreleased] 14 | - Run Nightscout inside a Home Assistant Add-on -------------------------------------------------------------------------------- /nightscout/rootfs/etc/cont-init.d/nightscout.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # Configures Nightscout 5 | # ============================================================================== 6 | 7 | readonly api_key=$(bashio::config 'api_key') 8 | readonly mongodb_uri=$(bashio::config 'mongodb_uri') 9 | 10 | bashio::log.info "Setting up API KEY: ${api_key}" 11 | export API_SECRET="${api_key}" 12 | bashio::log.info "Using Mongo URI: ${mongodb_uri}" 13 | export MONGODB_URI="${mongodb_uri}" 14 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/mongodb/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # Runs MongoDB 5 | # ============================================================================== 6 | 7 | bashio::log.info "Starting MongoDB..." 8 | 9 | # Set the data directory and bind IP address 10 | export MONGODB_DBPATH="/var/lib/mongodb" 11 | export MONGODB_BIND_IP="127.0.0.1" 12 | 13 | # Start MongoDB with the specified options 14 | exec s6-setuidgid mongodb /usr/bin/mongod --dbpath "$MONGODB_DBPATH" --bind_ip "$MONGODB_BIND_IP" 15 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/cont-init.d/mongodb.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # ============================================================================== 3 | # Home Assistant Add-on: NightScout 4 | # Configures MongoDB 5 | # ============================================================================== 6 | 7 | # Ensures the data of the DB is store outside the container 8 | if ! bashio::fs.directory_exists '/data/nightscout/mongodb'; then 9 | mkdir -p /data/nightscout/mongodb 10 | fi 11 | rm -fr /var/lib/mongodb 12 | ln -s /data/nightscout/mongodb /var/lib/mongodb 13 | chown -R mongodb:mongodb /var/lib/mongodb 14 | chown -R mongodb:mongodb /data/nightscout/mongodb -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/nginx/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # Runs the Nginx daemon 5 | # ============================================================================== 6 | 7 | # Wait for Nightscout to become available 8 | bashio::log.info "Nginx waiting for Nightscout..." 9 | bashio::net.wait_for 1337 10 | 11 | bashio::log.info "Starting NGINX..." 12 | if bashio::config.true 'ssl'; then 13 | options='/etc/nginx/nginx-ssl.conf' 14 | else 15 | options='/etc/nginx/nginx.conf' 16 | fi 17 | 18 | exec nginx -c "$options" 19 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/cont-init.d/nginx.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # ============================================================================== 3 | # Home Assistant Add-on: Nightscout 4 | # Configures NGINX for use with Nightscout 5 | # ============================================================================== 6 | declare certfile 7 | declare keyfile 8 | 9 | # Check SSL requirements, if enabled 10 | bashio::config.require.ssl 11 | 12 | # Enable SSL 13 | if bashio::config.true 'ssl'; then 14 | certfile=$(bashio::config 'certfile') 15 | keyfile=$(bashio::config 'keyfile') 16 | 17 | sed -i "s/%%certfile%%/${certfile}/g" /etc/nginx/nginx-ssl.conf 18 | sed -i "s/%%keyfile%%/${keyfile}/g" /etc/nginx/nginx-ssl.conf 19 | fi 20 | -------------------------------------------------------------------------------- /.devcontainer/Dockerfile: -------------------------------------------------------------------------------- 1 | #------------------------------------------------------------------------------------------------------------- 2 | # Copyright (c) Microsoft Corporation. All rights reserved. 3 | # Licensed under the MIT License. See https://go.microsoft.com/fwlink/?linkid=2090316 for license information. 4 | #------------------------------------------------------------------------------------------------------------- 5 | 6 | # Update the VARIANT arg in devcontainer.json to pick an Ubuntu version: focal (or ubuntu-20.04), bionic (or ubuntu-18.04) 7 | # To fully customize the contents of this image, use the following Dockerfile instead: 8 | # https://github.com/microsoft/vscode-dev-containers/tree/v0.128.0/containers/ubuntu/.devcontainer/base.Dockerfile 9 | ARG VARIANT="focal" 10 | FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT} 11 | 12 | # ** [Optional] Uncomment this section to install additional packages. ** 13 | # 14 | # RUN apt-get update \ 15 | # && export DEBIAN_FRONTEND=noninteractive \ 16 | # && apt-get -y install --no-install-recommends 17 | 18 | ARG HADOLINT_VERSION=v2.5.0 19 | RUN wget -O /usr/local/bin/hadolint https://github.com/hadolint/hadolint/releases/download/${HADOLINT_VERSION}/hadolint-Linux-x86_64 \ 20 | && chmod +x /usr/local/bin/hadolint \ 21 | && curl https://raw.githubusercontent.com/nektos/act/master/install.sh | sudo bash -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | // For format details, see https://aka.ms/vscode-remote/devcontainer.json or this file's README at: 2 | // https://github.com/microsoft/vscode-dev-containers/tree/v0.128.0/containers/ubuntu 3 | { 4 | "name": "Ubuntu", 5 | "build": { 6 | "dockerfile": "Dockerfile", 7 | // Update 'VARIANT' to pick an Ubuntu version. Rebuild the container if it already 8 | // exists to update. Available variants: focal (or ubuntu-20.04), bionic (or ubuntu-18.04) 9 | "args": { "VARIANT": "focal" } 10 | }, 11 | 12 | // Set *default* container specific settings.json values on container create. 13 | "settings": { 14 | "terminal.integrated.shell.linux": "/bin/bash" 15 | }, 16 | 17 | // Add the IDs of extensions you want installed when the container is created. 18 | "extensions": [ 19 | "exiasr.hadolint", 20 | "omartawfik.github-actions-vscode", 21 | "mrmlnc.vscode-remark", 22 | "ms-azuretools.vscode-docker" 23 | ] 24 | 25 | // Use 'forwardPorts' to make a list of ports inside the container available locally. 26 | // "forwardPorts": [], 27 | 28 | // Use 'postCreateCommand' to run commands after the container is created. 29 | // "postCreateCommand": "uname -a", 30 | 31 | // Uncomment to use the Docker CLI from inside the container. See https://aka.ms/vscode-remote/samples/docker-from-docker. 32 | // "mounts": [ "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" ], 33 | 34 | // Uncomment when using a ptrace-based debugger like C++, Go, and Rust 35 | // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ], 36 | 37 | // Uncomment to connect as a non-root user. See https://aka.ms/vscode-remote/containers/non-root. 38 | // "remoteUser": "vscode" 39 | } -------------------------------------------------------------------------------- /.github/workflows/test.yml: -------------------------------------------------------------------------------- 1 | name: Test Docker build 2 | 3 | on: [pull_request] 4 | 5 | jobs: 6 | dockerlint: 7 | name: Dockerfile linter 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2 11 | - name: hadolint 12 | run: docker run --rm -i hadolint/hadolint < nightscout/Dockerfile 13 | markdown-link-check: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - uses: actions/checkout@master 17 | - uses: gaurav-nelson/github-action-markdown-link-check@v1 18 | build-amd64: 19 | name: Build amd64 image 20 | runs-on: ubuntu-latest 21 | needs: [dockerlint, markdown-link-check] 22 | steps: 23 | - uses: actions/checkout@v2 24 | - name: Patch files 25 | uses: onlyutkarsh/patch-files-action@v1.0.1 26 | with: 27 | files: | 28 | nightscout/config.json 29 | patch-syntax: | 30 | = /version => "${{ github.run_number }}" 31 | - name: build amd64 image 32 | run: docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v ~/.docker:/root/.docker -v "$(pwd)":/data homeassistant/amd64-builder -t nightscout --amd64 --test 33 | build-aarch64: 34 | name: Build aarch64 image 35 | runs-on: ubuntu-latest 36 | needs: [dockerlint, markdown-link-check] 37 | steps: 38 | - uses: actions/checkout@v2 39 | - name: Patch files 40 | uses: onlyutkarsh/patch-files-action@v1.0.1 41 | with: 42 | files: | 43 | nightscout/config.json 44 | patch-syntax: | 45 | = /version => "${{ github.run_number }}" 46 | - name: build aarch64 image 47 | run: docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v ~/.docker:/root/.docker -v "$(pwd)":/data homeassistant/amd64-builder -t nightscout --aarch64 --test -------------------------------------------------------------------------------- /nightscout/config.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Nightscout", 3 | "version": "dev", 4 | "slug": "nightscout", 5 | "description": "Nightscout acts as a web-based CGM (Continuous Glucose Montinor) to allow multiple caregivers to remotely view a patients glucose data in realtime.", 6 | "url": "https://github.com/marciogranzotto/addon-nightscout", 7 | "arch": ["aarch64", "amd64"], 8 | "webui": "[PROTO:ssl]://[HOST]:[PORT:5423]", 9 | "startup": "services", 10 | "init": "false", 11 | "boot": "auto", 12 | "image": "marciogranzotto/image-{arch}-addon-nightscout", 13 | "hassio_role": "default", 14 | "ports": { 15 | "5423/tcp": 5423 16 | }, 17 | "ports_description": { 18 | "5423/tcp": "Nightscout frontend" 19 | }, 20 | "map": ["ssl", "config:rw"], 21 | "options": { 22 | "log_level": "info", 23 | "ssl": true, 24 | "certfile": "fullchain.pem", 25 | "keyfile": "privkey.pem", 26 | "api_key": "", 27 | "mongodb_uri": "mongodb://127.0.0.1:27017/admin", 28 | "auth_default_roles": "readable", 29 | "theme": "colors", 30 | "import_config_url": "", 31 | "plugins": [ 32 | "careportal", 33 | "boluscalc", 34 | "food", 35 | "bwp", 36 | "cage", 37 | "sage", 38 | "iage", 39 | "iob", 40 | "cob", 41 | "basal", 42 | "ar2", 43 | "rawbg", 44 | "pushover", 45 | "bgi", 46 | "pump", 47 | "openaps" 48 | ] 49 | }, 50 | "schema": { 51 | "log_level": "list(trace|debug|info|notice|warning|error|fatal)?", 52 | "ssl": "bool", 53 | "certfile": "str", 54 | "keyfile": "str", 55 | "api_key": "str", 56 | "mongodb_uri": "str", 57 | "auth_default_roles": "list(admin|denied|status-only|readable|careportal|devicestatus-upload|activity)?", 58 | "theme": "list(default|colors|colorblindfriendly)", 59 | "import_config_url": "str?", 60 | "plugins": ["str"] 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/nginx/nginx.conf: -------------------------------------------------------------------------------- 1 | worker_processes 1; 2 | pid /var/run/nginx.pid; 3 | error_log /dev/stdout info; 4 | daemon off; 5 | env SUPERVISOR_TOKEN; 6 | env DISABLE_HA_AUTHENTICATION; 7 | load_module "/usr/lib/nginx/modules/ndk_http_module.so"; 8 | load_module "/usr/lib/nginx/modules/ngx_http_lua_module.so"; 9 | 10 | events { 11 | worker_connections 1024; 12 | } 13 | 14 | http { 15 | include mime.types; 16 | default_type application/octet-stream; 17 | keepalive_timeout 65; 18 | proxy_read_timeout 1200; 19 | lua_shared_dict auths 16k; 20 | resolver 127.0.0.11; 21 | 22 | upstream nightscout { 23 | ip_hash; 24 | server 127.0.0.1:1337; 25 | } 26 | 27 | map $http_upgrade $connection_upgrade { 28 | default upgrade; 29 | '' close; 30 | } 31 | 32 | server { 33 | listen 5423 default_server; 34 | root /dev/null; 35 | 36 | server_name _; 37 | access_log /dev/stdout combined; 38 | client_max_body_size 4G; 39 | keepalive_timeout 5; 40 | 41 | location / { 42 | proxy_redirect off; 43 | proxy_pass http://nightscout; 44 | 45 | proxy_http_version 1.1; 46 | proxy_set_header Upgrade $http_upgrade; 47 | proxy_set_header Connection $connection_upgrade; 48 | proxy_set_header Authorization ""; 49 | 50 | proxy_set_header X-Real-IP $remote_addr; 51 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 52 | proxy_set_header X-Forwarded-Proto $scheme; 53 | proxy_set_header Host $http_host; 54 | proxy_set_header X-NginX-Proxy true; 55 | proxy_hide_header X-Frame-Options; 56 | 57 | proxy_connect_timeout 600s; 58 | proxy_send_timeout 600s; 59 | proxy_read_timeout 600s; 60 | } 61 | } 62 | } 63 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/services.d/nightscout/run: -------------------------------------------------------------------------------- 1 | #!/usr/bin/with-contenv bashio 2 | # shellcheck disable=SC2191 3 | # ============================================================================== 4 | # Home Assistant Add-on: Nightscout 5 | # Runs Nightscout 6 | # ============================================================================== 7 | declare -a options 8 | 9 | # Wait for MongoDB to become available 10 | bashio::net.wait_for 27017 11 | 12 | bashio::log.info 'Starting the Nightscout server...' 13 | 14 | # Config server variables 15 | readonly api_key=$(bashio::config 'api_key') 16 | bashio::log.debug "Setting up API KEY: ${api_key}" 17 | readonly mongodb_uri=$(bashio::config 'mongodb_uri') 18 | bashio::log.debug "Setting up MONGODB_URI: ${mongodb_uri}" 19 | 20 | 21 | export API_SECRET="${api_key}" 22 | export HOSTNAME="127.0.0.1" 23 | export PORT=1337 24 | #export MONGO_CONNECTION="mongodb://127.0.0.1:27017/admin" 25 | export MONGODB_URI="${mongodb_uri}" 26 | export INSECURE_USE_HTTP=true 27 | export SECURE_HSTS_HEADER=false 28 | 29 | if bashio::config.has_value 'auth_default_roles'; then 30 | readonly auth_default_roles=$(bashio::config 'auth_default_roles') 31 | export AUTH_DEFAULT_ROLES="${auth_default_roles}" 32 | fi 33 | 34 | # Enable plugins 35 | readonly plugins=$(bashio::config 'plugins') 36 | joined="" 37 | delim="" 38 | for item in ${plugins}; do 39 | joined="$joined$delim$item" 40 | delim=" " 41 | done 42 | bashio::log.info "Enable plugins: ${joined}" 43 | export ENABLE="${joined}" 44 | 45 | # Theme 46 | if bashio::config.has_value 'theme'; then 47 | readonly theme=$(bashio::config 'theme') 48 | bashio::log.info "Setting theme to: ${theme}" 49 | export THEME="${theme}" 50 | fi 51 | 52 | # Theme 53 | if bashio::config.has_value 'import_config_url'; then 54 | readonly import_config_url=$(bashio::config 'import_config_url') 55 | bashio::log.info "Importing config from URL: ${import_config_url}" 56 | export IMPORT_CONFIG="${import_config_url}" 57 | fi 58 | 59 | # Change current working directory 60 | cd /opt/app || bashio::exit.nok 'Failed changing working directory' 61 | 62 | npm install 63 | 64 | # Run Nightscout server 65 | exec node server.js 66 | -------------------------------------------------------------------------------- /.github/workflows/publish.yml: -------------------------------------------------------------------------------- 1 | name: Docker build and publish 2 | 3 | on: 4 | release: 5 | types: [published] 6 | 7 | jobs: 8 | build-amd64: 9 | name: Build and publish amd64 image 10 | runs-on: ubuntu-latest 11 | steps: 12 | - uses: actions/checkout@v2 13 | - name: Get version 14 | env: 15 | TAG_NAME: ${{ github.event.release.tag_name }} 16 | run: echo "VERSION=${TAG_NAME#v}" >> $GITHUB_ENV 17 | - name: Patch files 18 | uses: onlyutkarsh/patch-files-action@v1.0.1 19 | with: 20 | files: | 21 | nightscout/config.json 22 | patch-syntax: | 23 | = /version => "${{ env.VERSION }}" 24 | - name: publish amd64 docker files 25 | if: github.event_name != 'pull_request' 26 | run: docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v ~/.docker:/root/.docker -v "$(pwd)":/data homeassistant/amd64-builder -t nightscout --amd64 --release-tag --docker-user marciogranzotto --docker-password ${{ secrets.DOCKER_PASSWORD }} 27 | 28 | build-aarch64: 29 | name: Build and publish aarch64 image 30 | runs-on: ubuntu-latest 31 | steps: 32 | - uses: actions/checkout@v2 33 | - name: Get version 34 | env: 35 | TAG_NAME: ${{ github.event.release.tag_name }} 36 | run: echo "VERSION=${TAG_NAME#v}" >> $GITHUB_ENV 37 | - name: Patch files 38 | uses: onlyutkarsh/patch-files-action@v1.0.1 39 | with: 40 | files: | 41 | nightscout/config.json 42 | patch-syntax: | 43 | = /version => "${{ env.VERSION }}" 44 | 45 | - name: publish aarch64 docker files 46 | if: github.event_name != 'pull_request' 47 | run: docker run --rm --privileged -v /var/run/docker.sock:/var/run/docker.sock -v ~/.docker:/root/.docker -v "$(pwd)":/data homeassistant/amd64-builder -t nightscout --aarch64 --release-tag --docker-user marciogranzotto --docker-password ${{ secrets.DOCKER_PASSWORD }} 48 | update-main-repo: 49 | needs: [build-amd64, build-aarch64] 50 | name: Update addons repository 51 | runs-on: ubuntu-latest 52 | container: 53 | image: hassioaddons/repository-updater:latest 54 | steps: 55 | - name: upload 56 | run: repository-updater --token ${{ secrets.GIT_TOKEN }} --repository marciogranzotto/addons-repository --addon nightscout 57 | -------------------------------------------------------------------------------- /nightscout/rootfs/etc/nginx/nginx-ssl.conf: -------------------------------------------------------------------------------- 1 | worker_processes 1; 2 | pid /var/run/nginx.pid; 3 | error_log /dev/stdout info; 4 | daemon off; 5 | env SUPERVISOR_TOKEN; 6 | env DISABLE_HA_AUTHENTICATION; 7 | load_module "/usr/lib/nginx/modules/ndk_http_module.so"; 8 | load_module "/usr/lib/nginx/modules/ngx_http_lua_module.so"; 9 | 10 | events { 11 | worker_connections 1024; 12 | } 13 | 14 | http { 15 | include mime.types; 16 | default_type application/octet-stream; 17 | keepalive_timeout 65; 18 | proxy_read_timeout 1200; 19 | lua_shared_dict auths 16k; 20 | resolver 127.0.0.11; 21 | 22 | upstream nightscout { 23 | ip_hash; 24 | server 127.0.0.1:1337; 25 | } 26 | 27 | map $http_upgrade $connection_upgrade { 28 | default upgrade; 29 | '' close; 30 | } 31 | 32 | server { 33 | listen 5423 default_server ssl; 34 | root /dev/null; 35 | 36 | server_name _; 37 | access_log /dev/stdout combined; 38 | client_max_body_size 4G; 39 | keepalive_timeout 5; 40 | 41 | ssl_certificate /ssl/%%certfile%%; 42 | ssl_certificate_key /ssl/%%keyfile%%; 43 | ssl_ecdh_curve secp384r1; 44 | ssl_session_timeout 10m; 45 | ssl_session_cache shared:SSL:10m; 46 | ssl_session_tickets off; 47 | ssl_stapling on; 48 | ssl_stapling_verify on; 49 | 50 | add_header X-Content-Type-Options nosniff; 51 | add_header X-XSS-Protection "1; mode=block"; 52 | add_header X-Robots-Tag none; 53 | 54 | location / { 55 | proxy_redirect off; 56 | proxy_pass http://nightscout; 57 | 58 | proxy_http_version 1.1; 59 | proxy_set_header Upgrade $http_upgrade; 60 | proxy_set_header Connection $connection_upgrade; 61 | proxy_set_header Authorization ""; 62 | 63 | proxy_set_header X-Real-IP $remote_addr; 64 | proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; 65 | proxy_set_header X-Forwarded-Proto $scheme; 66 | proxy_set_header Host $http_host; 67 | proxy_set_header X-NginX-Proxy true; 68 | proxy_hide_header X-Frame-Options; 69 | 70 | proxy_connect_timeout 600s; 71 | proxy_send_timeout 600s; 72 | proxy_read_timeout 600s; 73 | } 74 | } 75 | } 76 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Byte-compiled / optimized / DLL files 2 | __pycache__/ 3 | *.py[cod] 4 | *$py.class 5 | 6 | # C extensions 7 | *.so 8 | 9 | # Distribution / packaging 10 | .Python 11 | build/ 12 | develop-eggs/ 13 | dist/ 14 | downloads/ 15 | eggs/ 16 | .eggs/ 17 | lib/ 18 | lib64/ 19 | parts/ 20 | sdist/ 21 | var/ 22 | wheels/ 23 | pip-wheel-metadata/ 24 | share/python-wheels/ 25 | *.egg-info/ 26 | .installed.cfg 27 | *.egg 28 | MANIFEST 29 | 30 | # PyInstaller 31 | # Usually these files are written by a python script from a template 32 | # before PyInstaller builds the exe, so as to inject date/other infos into it. 33 | *.manifest 34 | *.spec 35 | 36 | # Installer logs 37 | pip-log.txt 38 | pip-delete-this-directory.txt 39 | 40 | # Unit test / coverage reports 41 | htmlcov/ 42 | .tox/ 43 | .nox/ 44 | .coverage 45 | .coverage.* 46 | .cache 47 | nosetests.xml 48 | coverage.xml 49 | *.cover 50 | *.py,cover 51 | .hypothesis/ 52 | .pytest_cache/ 53 | 54 | # Translations 55 | *.mo 56 | *.pot 57 | 58 | # Django stuff: 59 | *.log 60 | local_settings.py 61 | db.sqlite3 62 | db.sqlite3-journal 63 | 64 | # Flask stuff: 65 | instance/ 66 | .webassets-cache 67 | 68 | # Scrapy stuff: 69 | .scrapy 70 | 71 | # Sphinx documentation 72 | docs/_build/ 73 | 74 | # PyBuilder 75 | target/ 76 | 77 | # Jupyter Notebook 78 | .ipynb_checkpoints 79 | 80 | # IPython 81 | profile_default/ 82 | ipython_config.py 83 | 84 | # pyenv 85 | .python-version 86 | 87 | # pipenv 88 | # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. 89 | # However, in case of collaboration, if having platform-specific dependencies or dependencies 90 | # having no cross-platform support, pipenv may install dependencies that don't work, or not 91 | # install all needed dependencies. 92 | #Pipfile.lock 93 | 94 | # PEP 582; used by e.g. github.com/David-OConnor/pyflow 95 | __pypackages__/ 96 | 97 | # Celery stuff 98 | celerybeat-schedule 99 | celerybeat.pid 100 | 101 | # SageMath parsed files 102 | *.sage.py 103 | 104 | # Environments 105 | .env 106 | .venv 107 | env/ 108 | venv/ 109 | ENV/ 110 | env.bak/ 111 | venv.bak/ 112 | 113 | # Spyder project settings 114 | .spyderproject 115 | .spyproject 116 | 117 | # Rope project settings 118 | .ropeproject 119 | 120 | # mkdocs documentation 121 | /site 122 | 123 | # mypy 124 | .mypy_cache/ 125 | .dmypy.json 126 | dmypy.json 127 | 128 | # Pyre type checker 129 | .pyre/ 130 | -------------------------------------------------------------------------------- /nightscout/Dockerfile: -------------------------------------------------------------------------------- 1 | ARG BUILD_FROM 2 | # hadolint ignore=DL3006 3 | FROM $BUILD_FROM 4 | 5 | # Set shell 6 | SHELL ["/bin/bash", "-o", "pipefail", "-c"] 7 | 8 | RUN mkdir -p /opt/app 9 | COPY . /opt 10 | WORKDIR /opt/app 11 | 12 | ARG BUILD_ARCH=amd64 13 | ARG NIGHTSCOUT_VERSION=14.2.6 14 | # hadolint ignore=DL3008 15 | RUN \ 16 | URL="http://archive.ubuntu.com/ubuntu/" \ 17 | && if [ "${BUILD_ARCH}" = "aarch64" ]; then \ 18 | URL="http://ports.ubuntu.com/ubuntu-ports/"; \ 19 | fi \ 20 | && echo "deb ${URL} bionic universe" \ 21 | > /etc/apt/sources.list.d/bionic-universe.list \ 22 | \ 23 | && echo "deb ${URL} bionic main" \ 24 | > /etc/apt/sources.list.d/bionic-main.list \ 25 | \ 26 | && curl -sL "https://deb.nodesource.com/setup_14.x" | bash - \ 27 | && apt-get update \ 28 | && apt-get install -y --no-install-recommends \ 29 | mongodb-server \ 30 | nodejs \ 31 | git \ 32 | webpack \ 33 | build-essential \ 34 | python2.7 \ 35 | nginx \ 36 | libnginx-mod-http-lua \ 37 | && apt-get clean \ 38 | && rm -rf /var/lib/apt/lists/* \ 39 | \ 40 | && git clone --depth 1 --branch ${NIGHTSCOUT_VERSION} https://github.com/nightscout/cgm-remote-monitor.git /opt/app \ 41 | \ 42 | && npm install \ 43 | && npm run postinstall \ 44 | && npm run env \ 45 | && npm audit fix 46 | 47 | RUN npm install jsdom@21.1.1 48 | 49 | VOLUME ["/data/db"] 50 | 51 | # Copy root filesystem 52 | COPY rootfs / 53 | 54 | # Build arguments 55 | ARG BUILD_DATE 56 | ARG BUILD_REF 57 | ARG BUILD_VERSION 58 | 59 | # Labels 60 | LABEL \ 61 | io.hass.name="Nightscout" \ 62 | io.hass.description="Nightscout acts as a web-based CGM (Continuous Glucose Montinor) to allow multiple caregivers to remotely view a patients glucose data in realtime." \ 63 | io.hass.arch="${BUILD_ARCH}" \ 64 | io.hass.type="addon" \ 65 | io.hass.version=${BUILD_VERSION} \ 66 | maintainer="Marcio Granzotto " \ 67 | org.opencontainers.image.title="Nightscout" \ 68 | org.opencontainers.image.description="Nightscout acts as a web-based CGM (Continuous Glucose Montinor) to allow multiple caregivers to remotely view a patients glucose data in realtime." \ 69 | org.opencontainers.image.vendor="Marcio Granzotto" \ 70 | org.opencontainers.image.authors="Marcio Granzotto " \ 71 | org.opencontainers.image.licenses="GNUv3" \ 72 | org.opencontainers.image.source="https://github.com/marciogranzotto/addon-nightscout" \ 73 | org.opencontainers.image.documentation="https://github.com/marciogranzotto/addon-nightscout/blob/master/README.md" \ 74 | org.opencontainers.image.created=${BUILD_DATE} \ 75 | org.opencontainers.image.revision=${BUILD_REF} \ 76 | org.opencontainers.image.version=${BUILD_VERSION} 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Home Assistant Add-On for Nightscout 2 | 3 | [![GitHub Release][releases-shield]][releases] 4 | ![Project Stage][project-stage-shield] 5 | [![License][license-shield]](LICENSE.md) 6 | 7 | ![Supports armhf Architecture][armhf-shield] 8 | ![Supports armv7 Architecture][armv7-shield] 9 | ![Supports aarch64 Architecture][aarch64-shield] 10 | ![Supports amd64 Architecture][amd64-shield] 11 | ![Supports i386 Architecture][i386-shield] 12 | 13 | ![Project Maintenance][maintenance-shield] 14 | [![GitHub Activity][commits-shield]][commits] 15 | 16 | [![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] 17 | 18 | ## About 19 | 20 | Nightscout acts as a web-based CGM (Continuous Glucose Montinor) to allow multiple caregivers to remotely view a patients glucose data in realtime. 21 | 22 | This add-on is a wrapper around [nightscout/cgm-remote-monitor][cgm-remote-monitor]. 23 | Please refere to their documentation for issues releated to Nightscout and not this add-on. 24 | 25 | It includes a Mongo Database which is used to store the uploaded values. 26 | 27 | ![sample image](images/sample.png) 28 | 29 | ## Installation 30 | 31 | The installation of this add-on is pretty straightforward and not different in 32 | comparison to installing any other Home Assistant add-on. 33 | 34 | 1. [Add our Home Assistant add-ons repository][repository] to your Home Assistant instance. 35 | 2. Install the "Nightscout" add-on. 36 | 3. Change the configuration files with the required values. 37 | 4. Start the "Nightscout" add-on 38 | 5. Check the logs of the "Nightscout" add-on to see if everything went well. 39 | 6. Click "OPEN WEB UI" to open the Nightscout website. 40 | 7. Log in with your `api_key`. 41 | 42 | [:books: Read the full add-on documentation][docs] 43 | 44 | **NOTE**: Starting the add-on might take a couple of minutes (especially the 45 | first time starting the add-on). 46 | 47 | **NOTE**: Do not add this repository to Home Assistant, please use: 48 | `https://github.com/marciogranzotto/addons-repository`. 49 | 50 | ## Support 51 | 52 | Got questions? 53 | 54 | You can [open an issue here][issue] on GitHub. 55 | 56 | ## Contributing 57 | 58 | This is an active open-source project. We are always open to people who want to 59 | use the code or contribute to it. 60 | 61 | Thank you for being involved! :heart_eyes: 62 | 63 | ## Authors & contributors 64 | 65 | The original setup of this repository is by [Marcio Granzotto][marciogranzotto]. 66 | 67 | For a full list of all authors and contributors, 68 | check [the contributor's page][contributors]. 69 | 70 | ## License 71 | 72 | GNU GENERAL PUBLIC LICENSE 73 | Version 3, 29 June 2007 74 | 75 | Copyright (C) 2007 Free Software Foundation, Inc. 76 | Everyone is permitted to copy and distribute verbatim copies 77 | of this license document, but changing it is not allowed. 78 | 79 | [aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg 80 | 81 | [amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg 82 | 83 | [anchore-shield]: https://anchore.io/service/badges/image/67d1185473090e99d5ac5e1bb4d1aa2295117a9bd3d7abbf8cd8a71e331c8388 84 | 85 | [anchore]: https://anchore.io/image/dockerhub/marciogranzotto%2Funifi%3Alatest 86 | 87 | [armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg 88 | 89 | [armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg 90 | 91 | [i386-shield]: https://img.shields.io/badge/i386-no-red.svg 92 | 93 | [buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/guidelines/download-assets-sm-2.svg 94 | 95 | 96 | [buymeacoffee]: https://www.buymeacoffee.com/automarcio 97 | 98 | [commits-shield]: https://img.shields.io/github/commit-activity/y/marciogranzotto/addon-nightscout.svg 99 | 100 | [commits]: https://github.com/marciogranzotto/addon-nightscout/commits/master 101 | 102 | [contributors]: https://github.com/marciogranzotto/addon-nightscout/graphs/contributors 103 | 104 | [dockerhub]: https://hub.docker.com/r/marciogranzotto/nightscout 105 | 106 | [home-assistant]: https://home-assistant.io 107 | 108 | [issue]: https://github.com/marciogranzotto/addon-nightscout/issues 109 | 110 | [keepchangelog]: http://keepachangelog.com/en/1.0.0/ 111 | 112 | [license-shield]: https://img.shields.io/github/license/marciogranzotto/addon-nightscout.svg 113 | 114 | [maintenance-shield]: https://img.shields.io/maintenance/yes/2020.svg 115 | 116 | [project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg 117 | 118 | [releases-shield]: https://img.shields.io/github/release/marciogranzotto/addon-nightscout.svg 119 | 120 | [releases]: https://github.com/marciogranzotto/addon-nightscout/releases 121 | 122 | [repository]: https://github.com/marciogranzotto/addons-repository 123 | 124 | [cgm-remote-monitor]: https://github.com/nightscout/cgm-remote-monitor 125 | 126 | [marciogranzotto]: https://github.com/marciogranzotto 127 | 128 | [docs]: nightscout/DOCS.md 129 | -------------------------------------------------------------------------------- /nightscout/DOCS.md: -------------------------------------------------------------------------------- 1 | # Home Assistant Add-On for Nightscout 2 | 3 | Nightscout acts as a web-based CGM (Continuous Glucose Montinor) to allow multiple caregivers to remotely view a patients glucose data in realtime. 4 | 5 | This add-on is a wrapper around [nightscout/cgm-remote-monitor][cgm-remote-monitor]. 6 | Please refere to their documentation for issues releated to Nightscout and not this add-on. 7 | 8 | It includes a Mongo Database which is used to store the uploaded values. 9 | 10 | ## Installation 11 | 12 | The installation of this add-on is pretty straightforward and not different in 13 | comparison to installing any other Home Assistant add-on. 14 | 15 | 1. [Add our Home Assistant add-ons repository][repository] to your Home Assistant instance. 16 | 2. Install the "Nightscout" add-on. 17 | 3. Change the configuration files with the required values. 18 | 4. Start the "Nightscout" add-on 19 | 5. Check the logs of the "Nightscout" add-on to see if everything went well. 20 | 6. Click "OPEN WEB UI" to open the Nightscout website. 21 | 7. Log in with your `api_key`. 22 | 23 | **NOTE**: Starting the add-on might take a couple of minutes (especially the 24 | first time starting the add-on). 25 | 26 | **NOTE**: Do not add this repository to Home Assistant, please use: 27 | `https://github.com/marciogranzotto/addons-repository`. 28 | 29 | ## Configuration 30 | 31 | **Note**: _Remember to restart the add-on when the configuration is changed._ 32 | 33 | Example add-on configuration: 34 | 35 | ```yaml 36 | ssl: true 37 | certfile: fullchain.pem 38 | keyfile: privkey.pem 39 | api_key: CHANGEMEPLEASE 40 | auth_default_roles: readable 41 | plugins: 42 | - careportal 43 | - boluscalc 44 | ``` 45 | 46 | **Note**: _This is just an example, don't copy and paste it! Create your own!_ 47 | 48 | ### Option: `ssl` 49 | 50 | Enables/Disables SSL (HTTPS) on the web interface of Nightscout. Set it `true` 51 | to enable it, `false` otherwise. 52 | 53 | ### Option: `certfile` 54 | 55 | The certificate file to use for SSL. 56 | 57 | **Note**: _The file MUST be stored in `/ssl/`, which is the default_ 58 | 59 | ### Option: `keyfile` 60 | 61 | The private key file to use for SSL. 62 | 63 | **Note**: _The file MUST be stored in `/ssl/`, which is the default_ 64 | 65 | ### Option: `api_key` 66 | 67 | The api key that will be used to login and upload data to Nightscout. 68 | 69 | **Note**: _It has to be at least 12 characters long_ 70 | 71 | ### Option: `auth_default_roles` 72 | 73 | Possible values: `readable` (default), `denied`, `status-only`, or any valid role name, such as: `admin`, `careportal`, `devicestatus-upload`, and `activity`. 74 | 75 | This will set the `AUTH_DEFAULT_ROLES` enviroment variable as described in the [Nightscout documentation][nightscout-docs-features] 76 | 77 | When `readable`, anyone can view Nightscout without a token. You wont't need the token on the Home Assistant integration. 78 | 79 | Setting it to `denied` will require a token from every visit, using `status-only` will enable api-secret based login. This will make the token REQUIRED on the Home Assistant integration in order to fetch the sensor values. 80 | 81 | ### Option: `plugins` 82 | 83 | A list of plugins you would like to use. 84 | You can see the list of available plugins on [nightscout/cgm-remote-monitor][cgm-remote-monitor] 85 | The default list should be pretty much what you need. 86 | 87 | ### Option: `theme` 88 | 89 | Which default theme nightscout should use. 90 | The available themes are `default`, `color` and `colorblinfriendly` 91 | You can check more details on [Nightscout's docs][themes-docs] 92 | 93 | ### Option: `import_config_url` 94 | 95 | If you want to change any other settings that are not exposed on the add-on, you can link a settings json from an URL, such as a gist. 96 | Please check the docs on how to do that [HERE][import-config-docs] 97 | 98 | ## Embedding into Home Assistant 99 | 100 | It is possible to embed Nightscout directly into Home Assistant, allowing you to 101 | access your Nightscout through the Home Assistant frontend. 102 | 103 | Home Assistant provides the `panel_iframe` integration, for these purposes. 104 | 105 | Example configuration: 106 | 107 | ```yaml 108 | panel_iframe: 109 | nightscout: 110 | title: Nightscout 111 | icon: mdi:water-alert 112 | url: https://address.to.your.hass.io:5423 113 | ``` 114 | 115 | After HA `v0.115.0`, the Nightscout integration is available as a native one. You can check the documentation on 116 | 117 | ## Uploading data 118 | 119 | Using any of the supported apps, like `xDrip+`, `Gimp` and `Spike`, enter the URL of your instance following this pattern: 120 | 121 | ```url 122 | https://YOURAPIKEY@address.to.your.hass.io:5423/api/v1/ 123 | ``` 124 | 125 | Just change the api key, url address and port, if needed. 126 | 127 | ## Changelog & Releases 128 | 129 | This repository keeps a change log using [GitHub's releases][releases] 130 | functionality. The format of the log is based on 131 | [Keep a Changelog][keepchangelog]. 132 | 133 | Releases are based on [Semantic Versioning][semver], and use the format 134 | of `MAJOR.MINOR.PATCH`. In a nutshell, the version will be incremented 135 | based on the following: 136 | 137 | - `MAJOR`: Incompatible or major changes. 138 | - `MINOR`: Backwards-compatible new features and enhancements. 139 | - `PATCH`: Backwards-compatible bugfixes and package updates. 140 | 141 | [keepchangelog]: http://keepachangelog.com/en/1.0.0/ 142 | 143 | [releases]: https://github.com/marciogranzotto/addon-nightscout/releases 144 | 145 | [repository]: https://github.com/marciogranzotto/addons-repository 146 | 147 | [cgm-remote-monitor]: https://github.com/nightscout/cgm-remote-monitor 148 | 149 | [nightscout-docs-features]: https://github.com/nightscout/cgm-remote-monitor#features 150 | 151 | [themes-docs]: https://nightscout.github.io/nightscout/setup_variables/#theme-colors 152 | 153 | [import-config-docs]: https://nightscout.github.io/nightscout/setup_variables/#import_config 154 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------