From e5c68508bda3afe104d2483aeab102c19564e9bd Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:00:33 +0100 Subject: [PATCH 01/12] build: add postgres migration service --- contrib/pg-upgrade/Dockerfile | 9 ++ contrib/pg-upgrade/README.md | 16 ++++ contrib/pg-upgrade/docker-compose.yml | 117 ++++++++++++++++++++++++++ contrib/pg-upgrade/upgrade-db.sh | 50 +++++++++++ 4 files changed, 192 insertions(+) create mode 100644 contrib/pg-upgrade/Dockerfile create mode 100644 contrib/pg-upgrade/README.md create mode 100644 contrib/pg-upgrade/docker-compose.yml create mode 100644 contrib/pg-upgrade/upgrade-db.sh diff --git a/contrib/pg-upgrade/Dockerfile b/contrib/pg-upgrade/Dockerfile new file mode 100644 index 00000000..40bd64d7 --- /dev/null +++ b/contrib/pg-upgrade/Dockerfile @@ -0,0 +1,9 @@ +FROM tianon/postgres-upgrade:14-to-16 + +RUN set -ex \ + && apt-get update \ + && DEBIAN_FRONTEND=noninteractive apt-get install \ + -y --no-install-recommends \ + "postgresql-14-postgis-3" \ + "postgresql-16-postgis-3" \ + && rm -rf /var/lib/apt/lists/* diff --git a/contrib/pg-upgrade/README.md b/contrib/pg-upgrade/README.md new file mode 100644 index 00000000..45a05826 --- /dev/null +++ b/contrib/pg-upgrade/README.md @@ -0,0 +1,16 @@ +# Postgres Version Upgrades + +- Based on images from https://github.com/tianon/docker-postgres-upgrade +- Adds the PostGIS dependency and builds an image for our repo. +- The image is used for upgrading between containerised Postgres versions. + +```bash +# From the repo root +bash contrib/pg-upgrade/upgrade-db.sh +``` + +This will start the upgrade, wait for completion, then mount +the data and start the new Postgres 16 container. + +> Note it is important to shut down the postgres container first, or +> a postmaster error will be encountered. diff --git a/contrib/pg-upgrade/docker-compose.yml b/contrib/pg-upgrade/docker-compose.yml new file mode 100644 index 00000000..630a8ba5 --- /dev/null +++ b/contrib/pg-upgrade/docker-compose.yml @@ -0,0 +1,117 @@ +# The services run in sequential order, via depends_on + +volumes: + pg-14-data: + name: drone-tm-pg-14-data + pg-16-data: + external: true + name: drone-tm-pg-16-data + +services: + db-check-upgrade: + image: postgis/postgis:16-3.4-alpine + volumes: + - pg-16-data:/var/lib/postgresql/data + restart: "no" + entrypoint: /bin/sh -c + command: + - | + # The new database directory is empty, so continue upgrade + if [ ! -f "/var/lib/postgresql/data/PG_VERSION" ]; then + echo "Database is empty" + exit 0 + fi + + if [ "$(cat /var/lib/postgresql/data/PG_VERSION)" = "16" ]; then + # The database is already upgraded, skip + echo "Database already upgraded" + exit 1 + else + # The database is not upgraded, continue + echo "Database not upgraded yet" + exit 0 + fi + + # Only required as we are migrating from filesystem to volume + db-to-volume: + image: postgis/postgis:16-3.4-alpine + volumes: + - ${PROJECT_DIR:-.}/DockerData/dtm_db_data:/var/lib/postgresql/old/data + - pg-14-data:/var/lib/postgresql/new/data + restart: "no" + entrypoint: /bin/sh -c + command: + - | + rm -rf /var/lib/postgresql/new/data + cp -r /var/lib/postgresql/old/data/* /var/lib/postgresql/new/data/ + echo 'Copied postgres data to docker volume' + + db-upgrade-version: + image: ghcr.io/hotosm/fmtm/pg-upgrade:14-to-16 + build: contrib/pg-upgrade + depends_on: + db-to-volume: + condition: service_completed_successfully + volumes: + - pg-14-data:/var/lib/postgresql/14/data + # Volume defined in main docker-compose.yml + - pg-16-data:/var/lib/postgresql/16/data + env_file: .env + environment: + PGUSER: ${POSTGRES_USER} + POSTGRES_INITDB_ARGS: -U ${POSTGRES_USER} + restart: "no" + + db-config-hba: + image: postgis/postgis:16-3.4-alpine + depends_on: + db-upgrade-version: + condition: service_completed_successfully + volumes: + - ${PROJECT_DIR:-.}/DockerData/dtm_db_data:/var/lib/postgresql/14/data + - pg-16-data:/var/lib/postgresql/16/data + restart: "no" + entrypoint: /bin/sh -c + command: + - | + cp -f \ + /var/lib/postgresql/14/data/pg_hba.conf \ + /var/lib/postgresql/16/data/ + echo 'Copied pg_hba.conf to new postgres dir' + + db-startup: + image: postgis/postgis:16-3.4-alpine + depends_on: + db-config-hba: + condition: service_completed_successfully + volumes: + - pg-16-data:/var/lib/postgresql/data + env_file: .env + networks: + - dtm-network + restart: unless-stopped + healthcheck: + test: pg_isready -U ${POSTGRES_USER:-dtm} -d ${POSTGRES_DB:-dtm_db} + start_period: 5s + interval: 10s + timeout: 5s + retries: 3 + + db-upgrade: + image: postgis/postgis:16-3.4-alpine + depends_on: + db-startup: + condition: service_healthy + env_file: .env + networks: + - dtm-network + restart: "no" + entrypoint: /bin/sh -c + command: + - | + PGPASSWORD=${POSTGRES_PASSWORD} \ + vacuumdb \ + --host=db-startup \ + --username=${POSTGRES_USER} \ + --all \ + --analyze-in-stages diff --git a/contrib/pg-upgrade/upgrade-db.sh b/contrib/pg-upgrade/upgrade-db.sh new file mode 100644 index 00000000..d07a5dc8 --- /dev/null +++ b/contrib/pg-upgrade/upgrade-db.sh @@ -0,0 +1,50 @@ +#!/bin/bash + +# Pull upgrade container +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + pull db-upgrade-version + +# Get exit code from db version check +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + up db-check-upgrade --exit-code-from db-check-upgrade +exit_code=$? + +# Exit script if upgrade complete +if [ "$exit_code" -eq 1 ]; then + echo "Database is already upgraded. Skipping." + + docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + rm --force db-check-upgrade + + exit 0 +fi + +# Stop any existing locks on db +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + down + +# Do the db upgrade +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + up -d db-upgrade + +# View any logs +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + logs db-upgrade-version + +# Shut down db to prior to restart +docker compose \ + -f docker-compose.yml \ + -f contrib/pg-upgrade/docker-compose.yml \ + down From 8de76abe25abcaaf67bfd4ec5daa60e842454b84 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:02:52 +0100 Subject: [PATCH 02/12] build: upgrade postgres 14 --> 16 in compose files --- docker-compose.vm.yml | 10 +++++++--- docker-compose.yml | 17 ++++++++++------- 2 files changed, 17 insertions(+), 10 deletions(-) diff --git a/docker-compose.vm.yml b/docker-compose.vm.yml index 92eec82e..2116c1c8 100644 --- a/docker-compose.vm.yml +++ b/docker-compose.vm.yml @@ -22,13 +22,13 @@ services: - dtm-network db: - image: postgis/postgis:14-3.4-alpine - restart: always + image: postgis/postgis:16-3.4-alpine volumes: - - ${PROJECT_DIR:-.}/DockerData/dtm_db_data:/var/lib/postgresql/data/ + - pg-16-data:/var/lib/postgresql/data env_file: .env networks: - dtm-network + restart: unless-stopped healthcheck: test: pg_isready -U ${POSTGRES_USER:-dtm} -d ${POSTGRES_DB:-dtm_db} start_period: 5s @@ -80,3 +80,7 @@ services: networks: dtm-network: name: dtm-network + +volumes: + pg-16-data: + name: drone-tm-pg-16-data diff --git a/docker-compose.yml b/docker-compose.yml index da50c718..ee99e0e2 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,11 +1,8 @@ -version: "3" - services: backend: build: context: . dockerfile: src/backend/Dockerfile - restart: always depends_on: - db - minio @@ -16,6 +13,7 @@ services: env_file: .env networks: - dtm-network + restart: unless-stopped frontend: build: @@ -34,13 +32,13 @@ services: - /var/run/docker.sock:/var/run/docker.sock db: - image: postgis/postgis:14-3.4-alpine - restart: always + image: postgis/postgis:16-3.4-alpine volumes: - - ${PROJECT_DIR:-.}/DockerData/dtm_db_data:/var/lib/postgresql/data/ + - pg-16-data:/var/lib/postgresql/data env_file: .env networks: - dtm-network + restart: unless-stopped healthcheck: test: pg_isready -U ${POSTGRES_USER:-dtm} -d ${POSTGRES_DB:-dtm_db} start_period: 5s @@ -50,7 +48,6 @@ services: minio: image: "docker.io/minio/minio:${MINIO_TAG:-RELEASE.2023-10-25T06-33-25Z}" - restart: always command: server /export --console-address 0.0.0.0:9090 --address 0.0.0.0:9000 volumes: - ${PROJECT_DIR:-.}/DockerData/minio_data:/export @@ -63,6 +60,7 @@ services: - 9090:9090 networks: - dtm-network + restart: unless-stopped createbuckets: image: "docker.io/minio/minio:${MINIO_TAG:-RELEASE.2023-10-25T06-33-25Z}" @@ -74,6 +72,7 @@ services: - minio networks: - dtm-network + restart: "no" migrations: build: @@ -94,3 +93,7 @@ services: networks: dtm-network: name: dtm-network + +volumes: + pg-16-data: + name: drone-tm-pg-16-data From cfe689c304361a369d5886981bfa986efdc6c9b1 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:03:11 +0100 Subject: [PATCH 03/12] ci: auto-migrate deployed database --> postgres v16 --- .github/workflows/build_and_deploy.yml | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml index e94cf603..d0b551a1 100644 --- a/.github/workflows/build_and_deploy.yml +++ b/.github/workflows/build_and_deploy.yml @@ -87,8 +87,9 @@ jobs: - name: Deploy to VM run: | - docker compose --file docker-compose.vm.yml --env-file .env pull + bash contrib/pg-upgrade/upgrade-db.sh + docker compose --file docker-compose.vm.yml --env-file .env up \ - --detach --remove-orphans --force-recreate + --detach --remove-orphans --force-recreate --pull=always env: DOCKER_HOST: "ssh://${{ secrets.SSH_USER }}@${{ secrets.SSH_HOST }}" From 6a83a03a6a40fc425e2bde5d8946f1858649a822 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:04:00 +0100 Subject: [PATCH 04/12] docs: add note to compose file about pg upgrade --- docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docker-compose.yml b/docker-compose.yml index ee99e0e2..35a7b343 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -31,6 +31,7 @@ services: - ${PROJECT_DIR:-.}/src/frontend:/app - /var/run/docker.sock:/var/run/docker.sock + # If error, please upgrade the db `bash contrib/pg-upgrade/upgrade-db.sh` db: image: postgis/postgis:16-3.4-alpine volumes: From 70fba317f86afb53c951cd3aa616817e70b7d832 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:08:12 +0100 Subject: [PATCH 05/12] docs: add comments for each db upgrade stage in compose --- contrib/pg-upgrade/docker-compose.yml | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/contrib/pg-upgrade/docker-compose.yml b/contrib/pg-upgrade/docker-compose.yml index 630a8ba5..0bb1b884 100644 --- a/contrib/pg-upgrade/docker-compose.yml +++ b/contrib/pg-upgrade/docker-compose.yml @@ -8,6 +8,7 @@ volumes: name: drone-tm-pg-16-data services: + # Check if the upgrade has already be complete --> v16 db-check-upgrade: image: postgis/postgis:16-3.4-alpine volumes: @@ -46,6 +47,7 @@ services: cp -r /var/lib/postgresql/old/data/* /var/lib/postgresql/new/data/ echo 'Copied postgres data to docker volume' + # Do the actual db upgrade db-upgrade-version: image: ghcr.io/hotosm/fmtm/pg-upgrade:14-to-16 build: contrib/pg-upgrade @@ -62,6 +64,7 @@ services: POSTGRES_INITDB_ARGS: -U ${POSTGRES_USER} restart: "no" + # Replace the generated pg_hba.conf access file with the original db-config-hba: image: postgis/postgis:16-3.4-alpine depends_on: @@ -79,6 +82,7 @@ services: /var/lib/postgresql/16/data/ echo 'Copied pg_hba.conf to new postgres dir' + # Start the db so we can run maintenance tasks db-startup: image: postgis/postgis:16-3.4-alpine depends_on: @@ -97,6 +101,7 @@ services: timeout: 5s retries: 3 + # Run maintenance, db vacuum db-upgrade: image: postgis/postgis:16-3.4-alpine depends_on: From 5346d481801e4e95aaeeb76bb8e3388bb3962538 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Mon, 22 Jul 2024 18:19:11 +0100 Subject: [PATCH 06/12] build: consistent use of docker volume for upgrade --- contrib/pg-upgrade/docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contrib/pg-upgrade/docker-compose.yml b/contrib/pg-upgrade/docker-compose.yml index 0bb1b884..3d92866b 100644 --- a/contrib/pg-upgrade/docker-compose.yml +++ b/contrib/pg-upgrade/docker-compose.yml @@ -71,7 +71,7 @@ services: db-upgrade-version: condition: service_completed_successfully volumes: - - ${PROJECT_DIR:-.}/DockerData/dtm_db_data:/var/lib/postgresql/14/data + - pg-14-data:/var/lib/postgresql/14/data - pg-16-data:/var/lib/postgresql/16/data restart: "no" entrypoint: /bin/sh -c From 7f6d438b97e3a09bc7552dd4e0df50e78dbf94e3 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Tue, 23 Jul 2024 12:51:11 +0100 Subject: [PATCH 07/12] docs: update license file with markdown suffix --- LICENSE | 661 ----------------------------------------------------- LICENSE.md | 660 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 660 insertions(+), 661 deletions(-) delete mode 100644 LICENSE create mode 100644 LICENSE.md diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 0ad25db4..00000000 --- a/LICENSE +++ /dev/null @@ -1,661 +0,0 @@ - GNU AFFERO GENERAL PUBLIC LICENSE - Version 3, 19 November 2007 - - Copyright (C) 2007 Free Software Foundation, Inc. - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 00000000..3c805b55 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,660 @@ +# GNU AFFERO GENERAL PUBLIC LICENSE + +Version 3, 19 November 2007 + +Copyright (C) 2007 Free Software Foundation, Inc. + + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + +## Preamble + +The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + +The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains +free software for all its users. + +When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + +Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + +A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + +The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + +An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing +under this license. + +The precise terms and conditions for copying, distribution and +modification follow. + +## TERMS AND CONDITIONS + +### 0. Definitions + +"This License" refers to version 3 of the GNU Affero General Public +License. + +"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks. + +"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + +To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of +an exact copy. The resulting work is called a "modified version" of +the earlier work or a work "based on" the earlier work. + +A "covered work" means either the unmodified Program or a work based +on the Program. + +To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + +To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user +through a computer network, with no transfer of a copy, is not +conveying. + +An interactive user interface displays "Appropriate Legal Notices" to +the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + +### 1. Source Code + +The "source code" for a work means the preferred form of the work for +making modifications to it. "Object code" means any non-source form of +a work. + +A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + +The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + +The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + +The Corresponding Source need not include anything that users can +regenerate automatically from other parts of the Corresponding Source. + +The Corresponding Source for a work in source code form is that same +work. + +### 2. Basic Permissions + +All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + +You may make, run and propagate covered works that you do not convey, +without conditions so long as your license otherwise remains in force. +You may convey covered works to others for the sole purpose of having +them make modifications exclusively for you, or provide you with +facilities for running those works, provided that you comply with the +terms of this License in conveying all material for which you do not +control copyright. Those thus making or running the covered works for +you must do so exclusively on your behalf, under your direction and +control, on terms that prohibit them from making any copies of your +copyrighted material outside their relationship with you. + +Conveying under any other circumstances is permitted solely under the +conditions stated below. Sublicensing is not allowed; section 10 makes +it unnecessary. + +### 3. Protecting Users' Legal Rights From Anti-Circumvention Law + +No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + +When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such +circumvention is effected by exercising rights under this License with +respect to the covered work, and you disclaim any intention to limit +operation or modification of the work as a means of enforcing, against +the work's users, your or third parties' legal rights to forbid +circumvention of technological measures. + +### 4. Conveying Verbatim Copies + +You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + +You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + +### 5. Conveying Modified Source Versions + +You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these +conditions: + +- a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. +- b) The work must carry prominent notices stating that it is + released under this License and any conditions added under + section 7. This requirement modifies the requirement in section 4 + to "keep intact all notices". +- c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. +- d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + +A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + +### 6. Conveying Non-Source Forms + +You may convey a covered work in object code form under the terms of +sections 4 and 5, provided that you also convey the machine-readable +Corresponding Source under the terms of this License, in one of these +ways: + +- a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. +- b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the Corresponding + Source from a network server at no charge. +- c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. +- d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. +- e) Convey the object code using peer-to-peer transmission, + provided you inform other peers where the object code and + Corresponding Source of the work are being offered to the general + public at no charge under subsection 6d. + +A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + +A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, +family, or household purposes, or (2) anything designed or sold for +incorporation into a dwelling. In determining whether a product is a +consumer product, doubtful cases shall be resolved in favor of +coverage. For a particular product received by a particular user, +"normally used" refers to a typical or common use of that class of +product, regardless of the status of the particular user or of the way +in which the particular user actually uses, or expects or is expected +to use, the product. A product is a consumer product regardless of +whether the product has substantial commercial, industrial or +non-consumer uses, unless such uses represent the only significant +mode of use of the product. + +"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to +install and execute modified versions of a covered work in that User +Product from a modified version of its Corresponding Source. The +information must suffice to ensure that the continued functioning of +the modified object code is in no case prevented or interfered with +solely because modification has been made. + +If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + +The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or +updates for a work that has been modified or installed by the +recipient, or for the User Product in which it has been modified or +installed. Access to a network may be denied when the modification +itself materially and adversely affects the operation of the network +or violates the rules and protocols for communication across the +network. + +Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + +### 7. Additional Terms + +"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + +When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + +Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders +of that material) supplement the terms of this License with terms: + +- a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or +- b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or +- c) Prohibiting misrepresentation of the origin of that material, + or requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or +- d) Limiting the use for publicity purposes of names of licensors + or authors of the material; or +- e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or +- f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions + of it) with contractual assumptions of liability to the recipient, + for any liability that these contractual assumptions directly + impose on those licensors and authors. + +All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + +If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + +Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; the +above requirements apply either way. + +### 8. Termination + +You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + +However, if you cease all violation of this License, then your license +from a particular copyright holder is reinstated (a) provisionally, +unless and until the copyright holder explicitly and finally +terminates your license, and (b) permanently, if the copyright holder +fails to notify you of the violation by some reasonable means prior to +60 days after the cessation. + +Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + +Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + +### 9. Acceptance Not Required for Having Copies + +You are not required to accept this License in order to receive or run +a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + +### 10. Automatic Licensing of Downstream Recipients + +Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + +An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + +You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + +### 11. Patents + +A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + +A contributor's "essential patent claims" are all patent claims owned +or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + +Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + +In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + +If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + +If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + +A patent license is "discriminatory" if it does not include within the +scope of its coverage, prohibits the exercise of, or is conditioned on +the non-exercise of one or more of the rights that are specifically +granted under this License. You may not convey a covered work if you +are a party to an arrangement with a third party that is in the +business of distributing software, under which you make payment to the +third party based on the extent of your activity of conveying the +work, and under which the third party grants, to any of the parties +who would receive the covered work from you, a discriminatory patent +license (a) in connection with copies of the covered work conveyed by +you (or copies made from those copies), or (b) primarily for and in +connection with specific products or compilations that contain the +covered work, unless you entered into that arrangement, or that patent +license was granted, prior to 28 March 2007. + +Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + +### 12. No Surrender of Others' Freedom + +If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under +this License and any other pertinent obligations, then as a +consequence you may not convey it at all. For example, if you agree to +terms that obligate you to collect a royalty for further conveying +from those to whom you convey the Program, the only way you could +satisfy both those terms and this License would be to refrain entirely +from conveying the Program. + +### 13. Remote Network Interaction; Use with the GNU General Public License + +Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your +version supports such interaction) an opportunity to receive the +Corresponding Source of your version by providing access to the +Corresponding Source from a network server at no charge, through some +standard or customary means of facilitating copying of software. This +Corresponding Source shall include the Corresponding Source for any +work covered by version 3 of the GNU General Public License that is +incorporated pursuant to the following paragraph. + +Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + +### 14. Revised Versions of this License + +The Free Software Foundation may publish revised and/or new versions +of the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever +published by the Free Software Foundation. + +If the Program specifies that a proxy can decide which future versions +of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + +Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + +### 15. Disclaimer of Warranty + +THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT +WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND +PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE +DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR +CORRECTION. + +### 16. Limitation of Liability + +IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR +CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES +ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT +NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR +LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM +TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER +PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. + +### 17. Interpretation of Sections 15 and 16 + +If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + +END OF TERMS AND CONDITIONS + +## How to Apply These Terms to Your New Programs + +If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these +terms. + +To do so, attach the following notices to the program. It is safest to +attach them to the start of each source file to most effectively state +the exclusion of warranty; and each file should have at least the +"copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper +mail. + +If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for +the specific requirements. + +You should also get your employer (if you work as a programmer) or +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. For more information on this, and how to apply and follow +the GNU AGPL, see . From 9597d51d25bdfa15a585a347f4968532ed47d706 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Tue, 23 Jul 2024 12:51:25 +0100 Subject: [PATCH 08/12] refactor: update refs fmtm --> drone-tm --- contrib/pg-upgrade/docker-compose.yml | 2 +- src/backend/app/main.py | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/contrib/pg-upgrade/docker-compose.yml b/contrib/pg-upgrade/docker-compose.yml index 3d92866b..cdd27f4a 100644 --- a/contrib/pg-upgrade/docker-compose.yml +++ b/contrib/pg-upgrade/docker-compose.yml @@ -49,7 +49,7 @@ services: # Do the actual db upgrade db-upgrade-version: - image: ghcr.io/hotosm/fmtm/pg-upgrade:14-to-16 + image: ghcr.io/hotosm/drone-tm/pg-upgrade:14-to-16 build: contrib/pg-upgrade depends_on: db-to-volume: diff --git a/src/backend/app/main.py b/src/backend/app/main.py index 21ea4b58..11b63bae 100644 --- a/src/backend/app/main.py +++ b/src/backend/app/main.py @@ -72,7 +72,7 @@ def get_application() -> FastAPI: description="HOTOSM Drone Tasking Manager", license_info={ "name": "GPL-3.0-only", - "url": "https://raw.githubusercontent.com/hotosm/fmtm/main/LICENSE.md", + "url": "https://raw.githubusercontent.com/hotosm/Drone-TM/main/LICENSE.md", }, debug=settings.DEBUG, docs_url="/api/docs", From 86f3a17dad3339c9cf1dccd0eabe782396392072 Mon Sep 17 00:00:00 2001 From: spwoodcock Date: Tue, 23 Jul 2024 14:58:28 +0100 Subject: [PATCH 09/12] docs: init docs setup with github workflow and main page --- .github/workflows/build_and_deploy.yml | 3 +- .github/workflows/docs.yml | 26 ++ docs/CNAME | 1 + docs/css/extra.css | 5 + docs/images/dev_roadmap_badge.svg | 1 + docs/images/docs_badge.svg | 1 + docs/images/favicon.png | Bin 0 -> 1225 bytes docs/images/hot_logo.png | Bin 0 -> 3789 bytes docs/images/timeline_badge.svg | 1 + docs/images/user_roadmap_badge.svg | 1 + docs/index.md | 3 + mkdocs.yml | 68 ++++ src/backend/pdm.lock | 495 ++++++++++++++++++++++++- src/backend/pyproject.toml | 13 +- 14 files changed, 595 insertions(+), 23 deletions(-) create mode 100644 .github/workflows/docs.yml create mode 100644 docs/CNAME create mode 100644 docs/css/extra.css create mode 100644 docs/images/dev_roadmap_badge.svg create mode 100644 docs/images/docs_badge.svg create mode 100644 docs/images/favicon.png create mode 100644 docs/images/hot_logo.png create mode 100644 docs/images/timeline_badge.svg create mode 100644 docs/images/user_roadmap_badge.svg create mode 100644 docs/index.md create mode 100644 mkdocs.yml diff --git a/.github/workflows/build_and_deploy.yml b/.github/workflows/build_and_deploy.yml index d0b551a1..a0bda19a 100644 --- a/.github/workflows/build_and_deploy.yml +++ b/.github/workflows/build_and_deploy.yml @@ -2,8 +2,7 @@ name: Build and Deploy Drone Tasking Manager on: push: - branches: - - main + branches: [main] workflow_dispatch: permissions: diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000..c22e5092 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,26 @@ +name: 📖 Publish Docs + +on: + push: + paths: + - docs/** + - src/** + - mkdocs.yml + branches: [main] + # Allow manual trigger (workflow_dispatch) + workflow_dispatch: + +jobs: + build_openapi_json: + uses: hotosm/gh-workflows/.github/workflows/openapi_build.yml@1.6.0 + with: + image: ghcr.io/${{ github.repository }}/backend:ci-${{ github.ref_name }} + example_env_file_path: ".env.sample" + output_path: docs/openapi.json + + publish_docs: + uses: hotosm/gh-workflows/.github/workflows/mkdocs_build.yml@1.6.0 + needs: + - build_openapi_json + with: + openapi: true diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 00000000..fb3dfcef --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +hotosm.github.io diff --git a/docs/css/extra.css b/docs/css/extra.css new file mode 100644 index 00000000..6ff6b31b --- /dev/null +++ b/docs/css/extra.css @@ -0,0 +1,5 @@ +:root { + --md-primary-fg-color: #d73f3f; + --md-primary-fg-color--light: #e27575; + --md-primary-fg-color--dark: #c22929; +} diff --git a/docs/images/dev_roadmap_badge.svg b/docs/images/dev_roadmap_badge.svg new file mode 100644 index 00000000..25056020 --- /dev/null +++ b/docs/images/dev_roadmap_badge.svg @@ -0,0 +1 @@ +🎯 Dev Roadmap🎯 Dev Roadmap \ No newline at end of file diff --git a/docs/images/docs_badge.svg b/docs/images/docs_badge.svg new file mode 100644 index 00000000..e05dfed7 --- /dev/null +++ b/docs/images/docs_badge.svg @@ -0,0 +1 @@ +📖 Docs📖 Docs \ No newline at end of file diff --git a/docs/images/favicon.png b/docs/images/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..60383b8cb618224a83f1f1f47e1f07d82af3c082 GIT binary patch literal 1225 zcmZ{iYfMvj6u>V!AG9#GIj1AKAq*7(E!63Tpa`wy(N z%zz-v3LAS9!x3bjTY@x2%+9#j*~jePv+Uy;+F^%X7TDDVd%78lq;Cvk85w9q1iE!A z8X1WnJ<33eot=T#u7X{=&~4iYosOAuGBjiWU@(lv09jv;ipA*m?I0rq*J?>qD`__2 z5?Goeh*qkeP{!L_jJf8|oSKKI?kK5IAWx0=XQONJz7p zb-BpeS~MyO4G*VIpQbG5flNkqS%}I?qN0MCe88{_J$8qAz|yxIaO5UgQv(tc;g!qO z)qX--MwFEiIxSvQgvP{x_;@%p#Bf8l8sSYV+0#uJ3`9*0WwDUP7W}(!Y5OQ`v%x?A zz%?3l%NCH7#N5Bf0F)@#k?rk7o0-tp!2Uk6%}kn1432@66f|NhrcyzNow+-X=N|yc z$@KkugxO4(O|Y+*9<`CJtysaA%)JTPHiG5m!s~<7#U7%rj`+EXb~u1sh95o*`}*MU z5J*jBoRh3`l7WyJA7iH(KJz2g_r(7^>l;81T-#=>O6}|rPSHq$i@b;sS)hm z3-;{;c`EGSL8|u(``AS`G@v_nfUGQ>Tfd?lQ!0tZMw%j-sVTC$8eZ(dOG-dm8XOpa z7R%h+T)tc%!hMO`-gt@V%(aDS*SKJjCRQe1^pNM_;o*BJe9Vh0x5kRLr>wo5lWkm< zog3w5U(Qn~uy=}Uo91UO5UyFa*=ydDXHWS?n^5S^d%Bpoirg9ZQ#GMkmKN?3SeMY^h792k+>#R&e9}*pf4KR~Brp zs`Q`lClvY#mzZlm^{P7InUU2}l0K1|Zm`Pr!?0v{Yy=aJ*QOb)j;43d3=ZENC9Ef{ zx3~ES)_(TM#-MQDP@7I-*uBZy<#E-Z;PaKumtU3MXmjc(x^HSu9k&M=PhL>_tXr;r zUYz9|*$|Tu6ciUA4-8Pf6~J871qW)wE|{t%2J88CK6l!CPi^X1UmnoWEa|&WjQ*bZ zvG)?0BXVh0@QO}(!R*SW6`553P=CZryT|LomKQIdK6w${KQd?+D1E&y{V45>IJ95> zY?AG2UV-pBiUW3#0f=(FIqVL z%}0f~Ztmvx$eDzk3FU_yl8&o4>?vu^GkgwCBs*-pqaI5;Mk-Hy^=Kuszjvp5iXvRf z-OpbmR%mjS8dX@%Ar!3MMpi*m;1%+>BHu}$LIR=Rp%SGp+vXA`(l)h?` literal 0 HcmV?d00001 diff --git a/docs/images/hot_logo.png b/docs/images/hot_logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9faa960bc3f1d34acfdb147867ef5f1edf7c8a83 GIT binary patch literal 3789 zcmaKv`9Bkm=MS&rFL*s(iRPw8oa}<^OiWCi_l*r6Gclc!{g)%oGyl^&tQAH7 z%-j6o6Y%Nj>A0@$0s^st$Nyz8{!C6Dt*uQM7%*tG{h^`bt*!0)`h|#yX)CLfy}gB~ zsNIf^IX}Pkj~_RQ#2FVCT3j4`W@Z`+-DzoAD=3%`4BYGKS;1nbAduDE+(~2OB_#5v zqvNcH$1(TE(p z(sG`s%s1O@zqSb@?X5}3X!2Bn#M-xGbWef!NhTf+>vcSemOW`7uw~@-2N@l#&p#(<4a3+b|7k23M2iy8&p0l;j-c-lzHhpf6-?%xE#^c>nk2IQ1w>*puE zNat5Iih7F;PYN9u>ux0}Dl1hjYr6#O42{L#^>=G-uzgW3XVhCIav+M`Gk{t2KC!>p`RKwy3Dl;G}^1@upP?AQ_7Z zw8qxz4hOD|!Y4d+UA@+%A%V$8FcsM@p|mTy2lOF3=u;BO=c+zvO6k;!34X0)iWnaR zB*0(gU^<^&BA#%4GRV}ATE?ZLgM5X|qzd$?mXlk!{jkt-8P{Efpp!SJHXR}0Ysz>d$C%q1 zz4D*{bY>tL7)Np%(bU9wwL}>5)SFHA)Nqc(c8T9WdK-2;Ym^LuCq5h=;wkWtq9sl9 zK&1dO^~1Y7ugRBoOktsy#>-W(G@=Z(@L@A^?O{4TQU(e@ON2`GF5P8YoTGj7OqDS< z;~XFuXl-x1>hZS`J~2N)Nl4!y(SxCJCoBY;%QO%9{^J{M{YxO~D)dJ`8)N{$Dc%9rFwaE#H( z#TCbrGLDfbK1$RZSzx|Ik=K3?*Twep-d*MIPh@S@QhKjL`Lv^?I2Q5|*$8zgN?MX% z_PPjJ@#-BBtv7eOF;f-D^#AB(Yp$UU>NQpkHfAtzc;X~+?K(7F$8lOv$AsT=H`&X3 z_rBXTCo!`U*%}O=+c58g3v61)+i`nR0+ru4urJXX{-i=7pNhNQ=s}^1+1_Z}Go@C2 z{0JdILu(=759Z-7)DaZdI5+(UQWkHp1ezcm3)d0tR++xzn$j|GRq>RdU^xhn`e&Aj zfXXO*gUW^Bj_D3Sx~})uVSXCl3)9QVZECjmivm@!(&d{FxqSA|Wnb%bTFocSJ1x_> z$E<~$>K1-`wzdZDEfQ4E@iYeG4tm#|%hFt)t@zeistkF)4mZy2g>Wl}ZNydiceu!l zmGXT?)K>!puzh^ZvtI6iz^*5b$@SW}A7?)h(rmJ2daCI=>XkpP23Xc9XkB8djMlC! z1J~MPCHX2K8m01Sw?2)~nR-n+)A2XTvM=9lNz^Qik#NXa8%c_VJTRA8rEH@7svI zs67zsEPhAaw|`OFA=oOPoUj(L?=u};`yuf5snImB*~sOP6VgTSc-A--wCTn+6>}@+ zjE=|7=XAVEPGU5z*>vw>JHw5?1Cg8PbQY?&&GhbSTt8TRnm=n<-9|EXE~A0QuNK`9 zwtm*f+wX$vO%qm`DpdsgXzT6XfGRsvs9aK1h>q6WgbwCrj3Oo9=+nz$w5h?Kj>LF# zqblbDXt?;2sw+0Dcf$(hn*MM_^<7jT-1xcmu!fBj_^QXflt*0X;D-i{uCuN?z7T)D z?3GkmfBT381o6uak#oZSm(I1J4^E{$JxKTJvX%sWuM#1{&$nWb%Kmv00?$u=9)fe- z^Jg=;4>%(71qNzuTOP`fofun@5pjwgv{KPPAtzsI)vPZx+)x4ol+z7-B;78|@~1H) z_+8EAXxz6Yn;H57BMH|U1)}h9BP6}L07y+t5I-YH9>L=lnN*eLd`DPiszya(ygk)^ zX(93Db=C7PKPJF9es3!au-H&zG78sIu4rsdW{wYlAEeA|y}aq$7xsgNR3CP=1jC7_ z1_fzs7iO|rvb=TcI~7OKsN|{bGd!@)$B0{f?@sWGY-0W+ zHO}dl4SRiN?C!Aka8Ybkp|EdQZ@G$MP0R9y>c$Ny^NP6~JX~Z^Ryh&Japhx|?ckT8 z_@)i;9|{c#<6LD9sSAcu4rRJW_HZq8oq3JF5JwgU|*X#f0skKSTCw4DmI#k0pHdx5Nr zRGD=-P}5S85624}8;P}1s@z7}eAPEk#B>#W4!|QM)53(q7X&jEsW?TY9D%_CyCG5)QYU0epo4F!IwSAkGDl3p}=ZHGH z!$pxN>`I`}GM{4jsRCjNmau)ULTi0WabiZD&0$1Z2C3^F*8i37Z`Gh__AzL@>W;X> ztVnSv09mhH-7}iws)uE%fX00F=7!OXeuj&e&vlBH*(8k^pK;7oY31nmabtmQkX~ox z*4KOhDGB+-%-M1R*1{#L2%qk=q;w#8(J|R`dkhdI-^~Og7-*R`dzv75OQf4bkV^M9 z<=;?a(C!2BRL&nWL%-o%+xNn8Iz7}q(M=?UuBp1E_k&b-J(*J9tPJpjlN8qPgQi2lnKQ)W6 z`*amO1@~K)AWZcVl|v-GuTlA;S1*8^L{E|D<%R*TT|^xu;$b{a4ua!fW;M*e1MOsq zn2$s(8>tnrd$>Ll6ObKmtfO!>ns@>DTkiLA$iZ9#=l!ciR$ zCO&quyG;Vx{TS}C3DbGIzwCP7<>2r<>(*v%Cq6cYXeI{5sTWx!IhV&OFFF*N=d*c* z6tfnYQE%2#^LsUn-4hv!gMrq4&yiZqnC!UxyD#kCF7mH<`vxF3{tnLzy1VDGbEmz! z_CkUFi#E*NHqVIxxpN>>V8T^L6_b{9QEEw}s9xC1et;TgR83<%=V`MbOKKZGN8NB> z@$si!5O)Z|5@W$sVEoi>}E!|IM%1no<(&jmwa+R;81#d|pmw z2&QWLO^!V#ky3FUTV|u0-riR~2f4Wn)(XFO2F4OCvJ^|ZxT7|(k~jB; zR|F-kwm)wz+F+5V2lO`-@>nJ6{8UR5dRV580^Ja zINXBQ*5p~9mlW}+ZOUt_X`;5og2|W$oBr^y3neCH>-OHPd8ZV(QPdR>7Wn#W=>`Q0 zT*-Q6b_6YNx$+p^i^wx`IOt8j+pY}%1&iz}w0mW-n*{3swm8YyF z8rUg&O zG?m|jubR6|PJg0N$C`Zxwc>|mnj@8u!lB-EdE`?3ctW6$7nLRbu859CskqanJ5D%c`{U$-cN)M5#$D5r0JAaUV>hWRbPQ#nK4(2 zypTM;bk^SCy|W6&C5i5hhD{qJOSi8x<=r8(K%y1|QvdQ$B4+C2g53Dol3~@j(sE>j zon!BJofCuTfh^vF(kUTlpD4b{8m#?$>SL<0RhK6(x7CyOm=QwxSEH=UHX1i(j1*cD zag+TW`xBSD1j*U5wGQ8BDU;S%dK0=*(yKFOlTWpSC$n$Eq4-EU0h` zYGzbMA7vZ`VGjV)`05!~)%P*Xx}IfSlUog5;E>f;A;{3JQhm8&`1_8^kKuf{r=t9g z9X*z0Se?aN2|mXLyO?{5RLsgu}F#T6f}*~eb+SJ s6;Z+fqA5cawO7zj%>N(gZgkPiqn=-xZ#X>v{Zpp📅 Timeline📅 Timeline