├── .gitignore ├── features ├── feature-scripts.env ├── devcontainer-features.json ├── install.sh └── fabric-debian.sh ├── containers └── fabric-chaincode │ ├── Dockerfile │ └── devcontainer.json ├── README.md ├── .github └── workflows │ └── deploy-features.yml ├── docs └── hyperledger-fabric-feature.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .devcontainer/ 2 | -------------------------------------------------------------------------------- /features/feature-scripts.env: -------------------------------------------------------------------------------- 1 | _VSC_INSTALL_HYPERLEDGER_FABRIC="fabric-debian.sh true automatic ${_BUILD_ARG_HYPERLEDGER_FABRIC_VERSION:-lts} 2 | -------------------------------------------------------------------------------- /containers/fabric-chaincode/Dockerfile: -------------------------------------------------------------------------------- 1 | # See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/ubuntu/.devcontainer/base.Dockerfile 2 | 3 | # [Choice] Ubuntu version (use ubuntu-22.04 or ubuntu-18.04 on local arm64/Apple Silicon): ubuntu-22.04, ubuntu-20.04, ubuntu-18.04 4 | ARG VARIANT="ubuntu-22.04" 5 | FROM mcr.microsoft.com/vscode/devcontainers/base:0-${VARIANT} 6 | 7 | # [Optional] Uncomment this section to install additional OS packages. 8 | # RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \ 9 | # && apt-get -y install --no-install-recommends 10 | -------------------------------------------------------------------------------- /features/devcontainer-features.json: -------------------------------------------------------------------------------- 1 | { 2 | "features": [ 3 | { 4 | "id": "hyperledger-fabric", 5 | "name": "Hyperledger Fabric", 6 | "documentationURL": "https://github.com/hyperledgendary/vscode-dev-containers/blob/main/docs/hyperledger-fabric-feature.md", 7 | "options": { 8 | "version": { 9 | "type": "string", 10 | "proposals": [ "latest", "lts", "2.2", "2.4" ], 11 | "default": "lts", 12 | "description": "Select or enter a Hyperledger Fabric version to install" 13 | } 14 | }, 15 | "containerEnv": { 16 | "FABRIC_CFG_PATH": "/etc/hyperledger/fabric/config", 17 | "MICROFAB_HOME": "/opt/hyperledger/microfab", 18 | "MICROFAB_CONFIG": "{\"directory\":\"/var/opt/hyperledger/microfab\",\"couchdb\":false}" 19 | }, 20 | "include": ["ubuntu"] 21 | } 22 | ] 23 | } 24 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # vscode-dev-containers 2 | 3 | A repository of Hyperledger Fabric [development container](https://containers.dev/) definitions for the VS Code Remote - Containers extension and GitHub Codespaces 4 | 5 | ## TODO 6 | 7 | - make it work with fabric test networks?! 8 | https://github.com/microsoft/vscode-dev-containers/blob/main/CONTRIBUTING.md#contributing-dev-container-definitions 9 | - use docker-in-docker feature? 10 | https://github.com/microsoft/vscode-dev-containers/tree/main/script-library/docs 11 | - create "hyperledger-fabric" feature? 12 | https://github.com/microsoft/dev-container-features-template#adding-your-own-features 13 | - separate go node and java containers instead of including everything in one? (slow!) 14 | 15 | ## microfab (TBC) 16 | 17 | ``` 18 | export MICROFAB_HOME=/opt/hyperledger/microfab 19 | export MICROFAB_CONFIG='{"directory":"/var/opt/hyperledger/microfab","couchdb":false}' 20 | ``` 21 | -------------------------------------------------------------------------------- /.github/workflows/deploy-features.yml: -------------------------------------------------------------------------------- 1 | name: 'Deploy Features' 2 | on: 3 | push: 4 | tags: 5 | - 'v*' 6 | 7 | jobs: 8 | deploy: # make sure the action works on a clean machine without building 9 | runs-on: ubuntu-latest 10 | steps: 11 | - uses: actions/checkout@v2 12 | 13 | - name: Get tag name 14 | id: get_tag_name 15 | run: echo "::set-output name=tag::$(echo "${{ github.ref }}" | grep -oP 'refs/tags/\K(.+)')" 16 | 17 | - name: Publish dev container features 18 | uses: microsoft/publish-dev-container-features-action@main 19 | with: 20 | path-to-features: 'features' 21 | 22 | - name: Get or Create Release at current tag 23 | uses: ncipollo/release-action@v1 24 | with: 25 | allowUpdates: true # Lets us upload our own artifact from previous step 26 | artifactErrorsFailBuild: true 27 | artifacts: './devcontainer-features.tgz' 28 | token: ${{ secrets.GITHUB_TOKEN }} 29 | -------------------------------------------------------------------------------- /containers/fabric-chaincode/devcontainer.json: -------------------------------------------------------------------------------- 1 | // For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: 2 | // https://github.com/microsoft/vscode-dev-containers/tree/v0.241.1/containers/ubuntu 3 | { 4 | "name": "Hyperledger Fabric Chaincode", 5 | "build": { 6 | "dockerfile": "Dockerfile", 7 | // Update 'VARIANT' to pick an Ubuntu version: jammy / ubuntu-22.04, focal / ubuntu-20.04, bionic /ubuntu-18.04 8 | // Use ubuntu-22.04 or ubuntu-18.04 on local arm64/Apple Silicon. 9 | "args": { "VARIANT": "ubuntu-22.04" } 10 | }, 11 | 12 | // Use 'forwardPorts' to make a list of ports inside the container available locally. 13 | // "forwardPorts": [], 14 | 15 | // Use 'postCreateCommand' to run commands after the container is created. 16 | // "postCreateCommand": "uname -a", 17 | 18 | // Use 'postStartCommand' to start a Fabric environment? TBC 19 | // "postStartCommand": ["microfabd"], 20 | 21 | "containerEnv": { 22 | "FABRIC_CFG_PATH": "/etc/hyperledger/fabric/config", 23 | "MICROFAB_HOME": "/opt/hyperledger/microfab", 24 | "MICROFAB_CONFIG": "{\"directory\":\"/var/opt/hyperledger/microfab\",\"couchdb\":false}" 25 | }, 26 | 27 | // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root. 28 | "remoteUser": "vscode", 29 | 30 | "features": { 31 | "golang": "latest", 32 | "node": { 33 | "version": "lts", 34 | "nodeGypDependencies": true 35 | }, 36 | "java": "latest", 37 | "hyperledgendary/vscode-dev-containers/hyperledger-fabric": { 38 | "version": "latest" 39 | } 40 | } 41 | } 42 | -------------------------------------------------------------------------------- /docs/hyperledger-fabric-feature.md: -------------------------------------------------------------------------------- 1 | # Hyperledger Fabric Install Script 2 | 3 | **Script status:** Experimental 4 | 5 | **OS support**: Debian 9+, Ubuntu 20.04+, and downstream distros. 6 | 7 | > **Note:** Your host chip architecture needs to match the your container image architecture for this script to function. Cross-architecture emulation will not work. (TBC) 8 | 9 | ## Syntax 10 | 11 | ```text 12 | ./hyperledger-fabric.sh [Enable non-root docker access flag] [Non-root user] [Fabric Version] 13 | ``` 14 | 15 | Or as a feature: 16 | 17 | ```json 18 | "features": { 19 | "hyperledgendary/vscode-dev-containers/hyperledger-fabric": { 20 | "version": "latest" 21 | } 22 | } 23 | ``` 24 | 25 | |Argument| Feature option |Default|Description| 26 | |--------|----------------|-------|-----------| 27 | |Non-root access flag| | `true`| Flag (`true`/`false`) that specifies whether a non-root user should be granted access to Docker.| 28 | |Non-root user| | `automatic`| Specifies a user in the container other than root that will be using the desktop. A value of `automatic` will cause the script to check for a user called `vscode`, then `node`, `codespace`, and finally a user with a UID of `1000` before falling back to `root`. | 29 | | Fabric version | `version` | `latest` | Fabric version or `latest`. Partial version numbers allowed. | 30 | 31 | ## Usage 32 | 33 | ### Feature use 34 | 35 | You can use this script for your primary dev container by adding it to the `features` property in `devcontainer.json`. 36 | 37 | ```json 38 | "features": { 39 | "hyperledgendary/vscode-dev-containers/hyperledger-fabric": { 40 | "version": "latest", 41 | } 42 | } 43 | ``` 44 | 45 | If you have already built your development container, run the **Rebuild Container** command from the command palette (Ctrl/Cmd + Shift + P or F1) to pick up the change. 46 | 47 | ### Script use 48 | 49 | See the [`fabric-chaincode`](../containers/fabric-chaincode) definition for a complete working example. However, here are the general steps to use the script: 50 | 51 | 1. Add [`hyperledger-fabric.sh`](../features/hyperledger-fabric.sh) to `.devcontainer/library-scripts` 52 | 53 | 2. TBC... 54 | 55 | ## Resources 56 | 57 | TBC 58 | -------------------------------------------------------------------------------- /features/install.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | set -e 3 | cd "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" 4 | 5 | # Verify we're on a supported OS 6 | . /etc/os-release 7 | if [ "${ID}" != "debian" ] && [ "${ID_LIKE}" != "debian" ]; then 8 | cat << EOF 9 | 10 | *********** Unsupported operating system "${ID}" detected *********** 11 | 12 | Features support currently requires a Debian/Ubuntu-based image. Update your 13 | image or Dockerfile FROM statement to start with a supported OS. For example: 14 | mcr.microsoft.com/vscode/devcontainers/base:ubuntu 15 | 16 | Aborting build... 17 | 18 | EOF 19 | exit 2 20 | fi 21 | 22 | set -a 23 | . ./devcontainer-features.env 24 | set +a 25 | 26 | chmod +x *.sh 27 | 28 | # TODO why isn't this working? 29 | 30 | # Execute option scripts if correct environment variable is set to "true" 31 | # feature_marker_path="/usr/local/etc/vscode-dev-containers/features" 32 | # mkdir -p "${feature_marker_path}" 33 | # while IFS= read -r feature_line; do 34 | # # Extract the env var part of the line 35 | # feature_var_name="${feature_line%%=*}" 36 | # if [ ! -z "${!feature_var_name}" ]; then 37 | # # If a value is set for the env var, execute the script 38 | # feature_script_and_args="${feature_line##*=}" 39 | # feature_script_and_args="${feature_script_and_args%\"}" 40 | # script_command="$(eval echo "${feature_script_and_args#\"}")" 41 | # echo "(*) Script: ${script_command}" 42 | 43 | # # Check if script with same args has already been run 44 | # feature_marker="${feature_marker_path}/${feature_var_name}"; 45 | # if [ -e "${feature_marker}" ] && [ "${script_command}" = "$(cat ${feature_marker})" ]; then 46 | # echo "(*) Skipping. Script already run with same arguments." 47 | # else 48 | # # Execute script and create a marker with the script args 49 | # ./${script_command} 50 | # echo "${script_command}" > "${feature_marker}" 51 | # fi 52 | # fi 53 | # done < ./feature-scripts.env 54 | 55 | pwd 56 | ls -al 57 | echo "FAB" 58 | ./fabric-debian.sh true automatic ${_BUILD_ARG_HYPERLEDGER_FABRIC_VERSION:-lts} 59 | 60 | # Clean up 61 | apt-get autoremove -y 62 | apt-get clean -y 63 | rm -rf /var/lib/apt/lists/* 64 | -------------------------------------------------------------------------------- /features/fabric-debian.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | # 3 | # SPDX-License-Identifier: Apache-2.0 4 | # 5 | # Docs: https://github.com/microsoft/vscode-dev-containers/blob/main/docs/hyperledger-fabric-feature.md 6 | # Syntax: ./fabric-debian.sh [version] 7 | 8 | ENABLE_NONROOT=${1:-"true"} 9 | USERNAME=${2:-"automatic"} 10 | HLF_VERSION=${3:-"latest"} 11 | 12 | # TODO non-root? 13 | echo "FAB ${HLF_VERSION}" 14 | 15 | set -e 16 | 17 | if [ "$(id -u)" -ne 0 ]; then 18 | echo -e 'Script must be run as root. Use sudo, su, or add "USER root" to your Dockerfile before running this script.' 19 | exit 1 20 | fi 21 | 22 | ARCHITECTURE="$(uname -m)" 23 | case ${ARCHITECTURE} in 24 | x86_64) ARCHITECTURE="amd64";; 25 | *) echo -e "Architecture ${architecture} unsupported"; exit 1 ;; 26 | esac 27 | 28 | # Determine the appropriate non-root user 29 | if [ "${USERNAME}" = "auto" ] || [ "${USERNAME}" = "automatic" ]; then 30 | USERNAME="" 31 | POSSIBLE_USERS=("vscode" "node" "codespace" "$(awk -v val=1000 -F ":" '$3==val{print $1}' /etc/passwd)") 32 | for CURRENT_USER in ${POSSIBLE_USERS[@]}; do 33 | if id -u ${CURRENT_USER} > /dev/null 2>&1; then 34 | USERNAME=${CURRENT_USER} 35 | break 36 | fi 37 | done 38 | if [ "${USERNAME}" = "" ]; then 39 | USERNAME=root 40 | fi 41 | elif [ "${USERNAME}" = "none" ] || ! id -u ${USERNAME} > /dev/null 2>&1; then 42 | USERNAME=root 43 | fi 44 | 45 | # Determine the appropriate Fabric version 46 | if [ "${HLF_VERSION}" = "latest" ]; then 47 | HLF_VERSION=2.4.6 48 | elif [ "${HLF_VERSION}" = "lts" ]; then 49 | HLF_VERSION=2.2.8 50 | elif [ "${HLF_VERSION:0:4}" != "2.2" ] && [ "${HLF_VERSION:0:4}" != "2.3" ] && [ "${HLF_VERSION:0:4}" != "2.4" ]; then 51 | echo -e "Unsupported Fabric version ${HLF_VERSION}: only 2.2.x, 2.3.x, or 2.4.x versions are supported" 52 | exit 1 53 | fi 54 | 55 | # Function to run apt-get if needed 56 | apt_get_update_if_needed() 57 | { 58 | if [ ! -d "/var/lib/apt/lists" ] || [ "$(ls /var/lib/apt/lists/ | wc -l)" = "0" ]; then 59 | echo "Running apt-get update..." 60 | apt-get update 61 | else 62 | echo "Skipping apt-get update." 63 | fi 64 | } 65 | 66 | # Checks if packages are installed and installs them if not 67 | check_packages() { 68 | if ! dpkg -s "$@" > /dev/null 2>&1; then 69 | apt_get_update_if_needed 70 | apt-get -y install --no-install-recommends "$@" 71 | fi 72 | } 73 | 74 | export DEBIAN_FRONTEND=noninteractive 75 | 76 | # Install required packages if missing (TBC!) 77 | check_packages curl ca-certificates apt-transport-https dirmngr gnupg2 findutils gcc git gzip make python3 tar unzip 78 | if ! type git > /dev/null 2>&1; then 79 | apt_get_update_if_needed 80 | apt-get -y install --no-install-recommends git 81 | fi 82 | 83 | # Install couchdb 84 | # curl https://couchdb.apache.org/repo/keys.asc | gpg --dearmor | tee /usr/share/keyrings/couchdb-archive-keyring.gpg >/dev/null 2>&1 85 | # source /etc/os-release 86 | # echo "deb [signed-by=/usr/share/keyrings/couchdb-archive-keyring.gpg] https://apache.jfrog.io/artifactory/couchdb-deb/ ${VERSION_CODENAME} main" \ 87 | # | tee /etc/apt/sources.list.d/couchdb.list >/dev/null 88 | # apt_get_update_if_needed 89 | # apt-get -y install couchdb 90 | 91 | # Install yq 92 | curl -sSLo /usr/local/bin/yq https://github.com/mikefarah/yq/releases/download/v4.23.1/yq_linux_${ARCHITECTURE} && chmod +x /usr/local/bin/yq 93 | 94 | # Download Fabric install script 95 | mkdir -p /tmp/hyperledger/fabric 96 | curl -sSLo /tmp/hyperledger/fabric/install-fabric.sh https://raw.githubusercontent.com/hyperledger/fabric/main/scripts/install-fabric.sh && chmod +x /tmp/hyperledger/fabric/install-fabric.sh 97 | 98 | # Install Fabric binaries and config 99 | pushd /tmp/hyperledger/fabric 100 | ./install-fabric.sh --fabric-version ${HLF_VERSION} binary 101 | mkdir -p /opt/hyperledger/fabric 102 | if [ -d ./builders/ccaas ]; then 103 | mv ./builders /opt/hyperledger/fabric 104 | fi 105 | mkdir -p /usr/local/bin 106 | if [ -d ./bin/ccaas_builder ]; then 107 | rm -Rf ./bin/ccaas_builder 108 | fi 109 | mv ./bin/* /usr/local/bin 110 | FABRIC_CFG_PATH=/etc/hyperledger/fabric/config 111 | mkdir -p ${FABRIC_CFG_PATH} 112 | mv ./config/* ${FABRIC_CFG_PATH} 113 | popd 114 | 115 | # Install Fabric samples 116 | if [ "${USERNAME}" = "root" ]; then 117 | FABRIC_SAMPLES_PARENT=/usr/local/src/github.com/hyperledger 118 | else 119 | FABRIC_SAMPLES_PARENT=/home/${USERNAME} 120 | fi 121 | mkdir -p ${FABRIC_SAMPLES_PARENT} 122 | pushd ${FABRIC_SAMPLES_PARENT} 123 | /tmp/hyperledger/fabric/install-fabric.sh --fabric-version ${HLF_VERSION} samples 124 | ln -s /usr/local/bin ./fabric-samples/bin && ln -s /etc/hyperledger/fabric/config ./fabric-samples/config 125 | popd 126 | 127 | # Clean up Fabric install script 128 | rm -Rf /tmp/hyperledger/fabric 129 | 130 | # Configure ccaas builder 131 | yq e 'del(.vm.endpoint) | (.chaincode.externalBuilders[] | select(.name == "ccaas_builder") | .path) = "/opt/hyperledger/fabric/builders/ccaas"' -i ${FABRIC_CFG_PATH}/core.yaml 132 | 133 | # Install microfab 134 | curl --fail --silent --show-error -L "https://github.com/IBM-Blockchain/microfab/releases/download/v0.0.16/microfab-Linux-X64.tgz" -o "/tmp/microfab-Linux-X64.tgz" 135 | tar -C /usr/local/bin -xzf "/tmp/microfab-Linux-X64.tgz" microfabd 136 | rm "/tmp/microfab-Linux-X64.tgz" 137 | mkdir -p "/opt/hyperledger/microfab/builders" 138 | if [ -d /opt/hyperledger/fabric/builders/ccaas ]; then 139 | ln -s /opt/hyperledger/fabric/builders/ccaas /opt/hyperledger/microfab/builders/ccaas 140 | fi 141 | groupadd microfab 142 | mkdir -p "/var/opt/hyperledger/microfab" 143 | chown root:microfab /var/opt/hyperledger/microfab 144 | chmod 2775 /var/opt/hyperledger/microfab 145 | 146 | if [ "${USERNAME}" != "root" ]; then 147 | chown -R ${USERNAME}:${USERNAME} /home/${USERNAME} 148 | adduser ${USERNAME} microfab 149 | fi 150 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | --------------------------------------------------------------------------------