├── .github └── workflows │ ├── release-full-platform.yml │ └── release-platform-memgraph-lab.yml ├── .gitignore ├── .gitmodules ├── Dockerfile ├── LICENSE ├── README.md ├── configs ├── programs │ ├── lab.conf │ └── memgraph.conf ├── supervisord-lab-only.conf ├── supervisord-memgraph-only.conf └── supervisord.conf ├── docker-compose.yml ├── init.ps1 ├── init.sh ├── memgraph_and_lab.Dockerfile ├── scripts ├── README.md ├── build_memgraph_native.sh ├── docker_image_mage.sh ├── docker_image_memgraph.sh ├── docker_image_platform.sh └── pack_memgraph_via_docker.sh └── tools └── remove_docker_tag.sh /.github/workflows/release-full-platform.yml: -------------------------------------------------------------------------------- 1 | name: Release full Memgraph Platform 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | memgraph_platform_version: 7 | description: "Memgraph Platform version." 8 | required: true 9 | memgraph_version: 10 | description: "Memgraph version that will be integrated into platform." 11 | required: true 12 | force_release: 13 | description: > 14 | "Force the release despite the version already exists on DockerHub." 15 | type: boolean 16 | required: false 17 | default: false 18 | docker_repository_name: 19 | description: "Dockerhub repository to upload to. (Mainly for testing)" 20 | required: false 21 | default: memgraph-platform 22 | 23 | env: 24 | DOCKER_ORGANIZATION_NAME: memgraph 25 | DOCKER_REPOSITORY_NAME: ${{ github.event.inputs.docker_repository_name }} 26 | 27 | # Reason for separating ARM and AMD is speed, buildx is extremely slow when 28 | # building for ARM on AMD, and it is better to use native ARM machine to build 29 | # that image 30 | jobs: 31 | release-memgraph-platform-amd: 32 | runs-on: [self-hosted, Linux, X64, Diff] 33 | steps: 34 | - name: Checkout repository and submodules 35 | uses: actions/checkout@v3 36 | with: 37 | fetch-depth: 0 38 | submodules: recursive 39 | token: ${{ secrets.PAT }} 40 | 41 | - name: Get Memgraph Lab release version 42 | run: | 43 | cd lab 44 | git fetch --all --tags 45 | MEMGRAPH_LAB_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 46 | echo $MEMGRAPH_LAB_VERSION 47 | echo "LAB_VERSION=${MEMGRAPH_LAB_VERSION:1}" >> $GITHUB_ENV 48 | 49 | - name: Get Memgraph Mage release version 50 | run: | 51 | cd mage 52 | git fetch --all --tags 53 | MEMGRAPH_MAGE_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 54 | echo $MEMGRAPH_MAGE_VERSION 55 | MEMGRAPH_MAGE_VERSION=${MEMGRAPH_MAGE_VERSION#v} 56 | echo "MAGE_VERSION=${MEMGRAPH_MAGE_VERSION%%-*}" >> $GITHUB_ENV 57 | 58 | - name: Set Memgraph Platform version 59 | run: | 60 | echo "PLATFORM_VERSION=${{ github.event.inputs.memgraph_platform_version }}-memgraph${{ github.event.inputs.memgraph_version }}-lab${{ env.LAB_VERSION }}-mage${{ env.MAGE_VERSION }}" >> $GITHUB_ENV 61 | 62 | - name: Set up QEMU 63 | uses: docker/setup-qemu-action@v2 64 | 65 | - name: Set up Docker Buildx 66 | id: buildx 67 | uses: docker/setup-buildx-action@v2 68 | 69 | - name: Available platforms 70 | run: echo ${{ steps.buildx.outputs.platforms }} 71 | 72 | - name: Log in to Docker Hub 73 | uses: docker/login-action@v2 74 | with: 75 | username: ${{ secrets.DOCKERHUB_USERNAME }} 76 | password: ${{ secrets.DOCKERHUB_TOKEN }} 77 | 78 | - name: Download memgraph binaries 79 | run: | 80 | curl -L https://download.memgraph.com/memgraph/v${{ github.event.inputs.memgraph_version }}/debian-11/memgraph_${{ github.event.inputs.memgraph_version }}-1_amd64.deb > memgraph-amd64.deb 81 | 82 | - name: Check if specified version is already pushed 83 | run: | 84 | EXISTS=$(docker manifest inspect $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }} > /dev/null; echo $?) 85 | echo $EXISTS 86 | if [[ ${EXISTS} -eq 0 ]]; then 87 | echo The specified version has been already released to DockerHub! 88 | if [[ ${{ github.event.inputs.force_release }} = true ]]; then 89 | echo Forcing the release 90 | else 91 | echo Stopping the release 92 | exit 1 93 | fi 94 | else 95 | echo All good the specified version has not been release to DockerHub 96 | fi 97 | 98 | - name: Build & push docker images 99 | run: | 100 | docker buildx build \ 101 | --build-arg BINARY_NAME="memgraph-" \ 102 | --build-arg NPM_PACKAGE_TOKEN="${{ secrets.PAT }}" \ 103 | --platform linux/amd64 \ 104 | --tag $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }}-amd \ 105 | --push . 106 | 107 | release-memgraph-platform-arm: 108 | runs-on: [self-hosted, ARM64] 109 | steps: 110 | - name: Checkout repository and submodules 111 | uses: actions/checkout@v3 112 | with: 113 | fetch-depth: 0 114 | submodules: recursive 115 | token: ${{ secrets.PAT }} 116 | 117 | - name: Get Memgraph Lab release version 118 | run: | 119 | cd lab 120 | git fetch --all --tags 121 | MEMGRAPH_LAB_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 122 | echo $MEMGRAPH_LAB_VERSION 123 | echo "LAB_VERSION=${MEMGRAPH_LAB_VERSION:1}" >> $GITHUB_ENV 124 | 125 | - name: Get Memgraph Mage release version 126 | run: | 127 | cd mage 128 | git fetch --all --tags 129 | MEMGRAPH_MAGE_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 130 | echo $MEMGRAPH_MAGE_VERSION 131 | MEMGRAPH_MAGE_VERSION=${MEMGRAPH_MAGE_VERSION#v} 132 | echo "MAGE_VERSION=${MEMGRAPH_MAGE_VERSION%%-*}" >> $GITHUB_ENV 133 | 134 | - name: Set Memgraph Platform version 135 | run: | 136 | echo "PLATFORM_VERSION=${{ github.event.inputs.memgraph_platform_version }}-memgraph${{ github.event.inputs.memgraph_version }}-lab${{ env.LAB_VERSION }}-mage${{ env.MAGE_VERSION }}" >> $GITHUB_ENV 137 | 138 | - name: Set up QEMU 139 | uses: docker/setup-qemu-action@v2 140 | 141 | - name: Log in to Docker Hub 142 | run: | 143 | security unlock-keychain -p ${{ secrets.HOST_PASSWORD }} 144 | docker login -u ${{ secrets.DOCKERHUB_USERNAME }} -p ${{ secrets.DOCKERHUB_TOKEN }} 145 | 146 | - name: Set up Docker Buildx 147 | id: buildx 148 | uses: docker/setup-buildx-action@v2 149 | 150 | - name: Available platforms 151 | run: echo ${{ steps.buildx.outputs.platforms }} 152 | 153 | - name: Download memgraph binaries 154 | run: | 155 | curl -L https://download.memgraph.com/memgraph/v${{ github.event.inputs.memgraph_version }}/debian-11-aarch64/memgraph_${{ github.event.inputs.memgraph_version }}-1_arm64.deb > memgraph-arm64.deb 156 | 157 | - name: Check if specified version is already pushed 158 | run: | 159 | EXISTS=$(docker manifest inspect $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }} > /dev/null; echo $?) 160 | echo $EXISTS 161 | if [[ ${EXISTS} -eq 0 ]]; then 162 | echo The specified version has been already released to DockerHub! 163 | if [[ ${{ github.event.inputs.force_release }} = true ]]; then 164 | echo Forcing the release 165 | else 166 | echo Stopping the release 167 | exit 1 168 | fi 169 | else 170 | echo All good the specified version has not been release to DockerHub 171 | fi 172 | 173 | - name: Build & push docker images 174 | run: | 175 | docker buildx build \ 176 | --build-arg BINARY_NAME="memgraph-" \ 177 | --build-arg NPM_PACKAGE_TOKEN="${{ secrets.PAT }}" \ 178 | --platform linux/arm64 \ 179 | --tag $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }}-arm \ 180 | --push . 181 | 182 | merge-images: 183 | runs-on: ubuntu-latest 184 | needs: [release-memgraph-platform-arm, release-memgraph-platform-amd] 185 | steps: 186 | - name: Checkout repository and submodules 187 | uses: actions/checkout@v3 188 | with: 189 | fetch-depth: 0 190 | submodules: recursive 191 | token: ${{ secrets.PAT }} 192 | 193 | - name: Log in to Docker Hub 194 | uses: docker/login-action@v2 195 | with: 196 | username: ${{ secrets.DOCKERHUB_USERNAME }} 197 | password: ${{ secrets.DOCKERHUB_TOKEN }} 198 | 199 | - name: Get Memgraph Lab release version 200 | run: | 201 | cd lab 202 | git fetch --all --tags 203 | MEMGRAPH_LAB_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 204 | echo $MEMGRAPH_LAB_VERSION 205 | echo "LAB_VERSION=${MEMGRAPH_LAB_VERSION:1}" >> $GITHUB_ENV 206 | 207 | - name: Get Memgraph Mage release version 208 | run: | 209 | cd mage 210 | git fetch --all --tags 211 | MEMGRAPH_MAGE_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 212 | echo $MEMGRAPH_MAGE_VERSION 213 | MEMGRAPH_MAGE_VERSION=${MEMGRAPH_MAGE_VERSION#v} 214 | echo "MAGE_VERSION=${MEMGRAPH_MAGE_VERSION%%-*}" >> $GITHUB_ENV 215 | 216 | - name: Set Memgraph Platform version 217 | run: | 218 | echo "PLATFORM_VERSION=${{ github.event.inputs.memgraph_platform_version }}-memgraph${{ github.event.inputs.memgraph_version }}-lab${{ env.LAB_VERSION }}-mage${{ env.MAGE_VERSION }}" >> $GITHUB_ENV 219 | 220 | - name: Set up QEMU 221 | uses: docker/setup-qemu-action@v2 222 | 223 | - name: Set up Docker Buildx 224 | id: buildx 225 | uses: docker/setup-buildx-action@v2 226 | 227 | - name: Build single image 228 | run: | 229 | docker buildx imagetools create \ 230 | --tag $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }} \ 231 | --tag $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:latest \ 232 | $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }}-arm \ 233 | $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }}-amd 234 | 235 | - name: Remove redundant ARM 236 | run: | 237 | ./tools/remove_docker_tag.sh ${{ secrets.DOCKERHUB_USERNAME }} \ 238 | ${{ secrets.DOCKERHUB_TOKEN }} \ 239 | $DOCKER_ORGANIZATION_NAME \ 240 | $DOCKER_REPOSITORY_NAME \ 241 | ${{ env.PLATFORM_VERSION }}-arm 242 | 243 | - name: Remove redundant AMD 244 | run: | 245 | ./tools/remove_docker_tag.sh ${{ secrets.DOCKERHUB_USERNAME }} \ 246 | ${{ secrets.DOCKERHUB_TOKEN }} \ 247 | $DOCKER_ORGANIZATION_NAME \ 248 | $DOCKER_REPOSITORY_NAME \ 249 | ${{ env.PLATFORM_VERSION }}-amd 250 | -------------------------------------------------------------------------------- /.github/workflows/release-platform-memgraph-lab.yml: -------------------------------------------------------------------------------- 1 | name: Release Memgraph Platform without mage 2 | 3 | on: 4 | workflow_dispatch: 5 | inputs: 6 | memgraph_platform_version: 7 | description: "Memgraph Platform version." 8 | required: true 9 | memgraph_version: 10 | description: "Memgraph version that will be integrated into platform." 11 | required: true 12 | force_release: 13 | description: > 14 | "Force the release despite the version already exists on DockerHub." 15 | type: boolean 16 | required: false 17 | default: false 18 | docker_repository_name: 19 | description: "Dockerhub repository to upload to. (Mainly for testing)" 20 | required: false 21 | default: memgraph-platform 22 | 23 | env: 24 | DOCKER_ORGANIZATION_NAME: memgraph 25 | DOCKER_REPOSITORY_NAME: ${{ github.event.inputs.docker_repository_name }} 26 | 27 | # Reason for separating ARM and AMD is speed, buildx is extremely slow when 28 | # building for ARM on AMD, and it is better to use native ARM machine to build 29 | # that image 30 | jobs: 31 | release-memgraph-platform-without-mage: 32 | runs-on: [self-hosted, Linux, X64, Diff] 33 | steps: 34 | - name: Checkout repository and submodules 35 | uses: actions/checkout@v3 36 | with: 37 | fetch-depth: 0 38 | submodules: recursive 39 | token: ${{ secrets.PAT }} 40 | 41 | - name: Get Memgraph Lab release version 42 | run: | 43 | cd lab 44 | git fetch --all --tags 45 | MEMGRAPH_LAB_VERSION=$(git rev-parse --verify HEAD | git tag --contains) 46 | echo $MEMGRAPH_LAB_VERSION 47 | echo "LAB_VERSION=${MEMGRAPH_LAB_VERSION:1}" >> $GITHUB_ENV 48 | 49 | - name: Set Memgraph Platform version 50 | run: | 51 | echo "PLATFORM_VERSION=${{ github.event.inputs.memgraph_platform_version }}-memgraph${{ github.event.inputs.memgraph_version }}-lab${{ env.LAB_VERSION }}" >> $GITHUB_ENV 52 | 53 | - name: Set up QEMU 54 | uses: docker/setup-qemu-action@v2 55 | 56 | - name: Set up Docker Buildx 57 | id: buildx 58 | uses: docker/setup-buildx-action@v2 59 | 60 | - name: Available platforms 61 | run: echo ${{ steps.buildx.outputs.platforms }} 62 | 63 | - name: Log in to Docker Hub 64 | uses: docker/login-action@v2 65 | with: 66 | username: ${{ secrets.DOCKERHUB_USERNAME }} 67 | password: ${{ secrets.DOCKERHUB_TOKEN }} 68 | 69 | - name: Download memgraph binaries 70 | run: | 71 | curl -L https://download.memgraph.com/memgraph/v${{ github.event.inputs.memgraph_version }}/debian-11/memgraph_${{ github.event.inputs.memgraph_version }}-1_amd64.deb > memgraph-amd64.deb 72 | curl -L https://download.memgraph.com/memgraph/v${{ github.event.inputs.memgraph_version }}/debian-11-aarch64/memgraph_${{ github.event.inputs.memgraph_version }}-1_arm64.deb > memgraph-arm64.deb 73 | 74 | - name: Check if specified version is already pushed 75 | run: | 76 | EXISTS=$(docker manifest inspect $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }} > /dev/null; echo $?) 77 | echo $EXISTS 78 | if [[ ${EXISTS} -eq 0 ]]; then 79 | echo The specified version has been already released to DockerHub! 80 | if [[ ${{ github.event.inputs.force_release }} = true ]]; then 81 | echo Forcing the release 82 | else 83 | echo Stopping the release 84 | exit 1 85 | fi 86 | else 87 | echo All good the specified version has not been release to DockerHub 88 | fi 89 | 90 | - name: Build & push docker image 91 | run: | 92 | docker buildx build \ 93 | --build-arg BINARY_NAME="memgraph-" \ 94 | --build-arg NPM_PACKAGE_TOKEN="${{ secrets.PAT }}" \ 95 | --platform linux/amd64,linux/arm64 \ 96 | --tag $DOCKER_ORGANIZATION_NAME/$DOCKER_REPOSITORY_NAME:${{ env.PLATFORM_VERSION }} \ 97 | --file memgraph_and_lab.Dockerfile \ 98 | --push . 99 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | scripts/dist 2 | *.deb 3 | -------------------------------------------------------------------------------- /.gitmodules: -------------------------------------------------------------------------------- 1 | [submodule "mage"] 2 | path = mage 3 | url = https://github.com/memgraph/mage.git 4 | branch = main 5 | [submodule "lab"] 6 | path = lab 7 | url = https://github.com/memgraph/lab.git 8 | branch = dev 9 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # For mage 2 | ARG PY_VERSION_DEFAULT=3.9 3 | 4 | FROM debian:bullseye as base 5 | 6 | ARG TARGETARCH 7 | ARG PY_VERSION_DEFAULT 8 | ENV PY_VERSION ${PY_VERSION_DEFAULT} 9 | 10 | # Essentials for production 11 | RUN apt-get update && apt-get install -y \ 12 | libcurl4 `memgraph` \ 13 | libpython${PY_VERSION} `memgraph` \ 14 | libssl-dev `memgraph` \ 15 | openssl `memgraph` \ 16 | build-essential `mage-memgraph` \ 17 | cmake `mage-memgraph` \ 18 | curl `mage-memgraph` \ 19 | g++ `mage-memgraph` \ 20 | python3 `mage-memgraph` \ 21 | python3-pip `mage-memgraph` \ 22 | python3-setuptools `mage-memgraph` \ 23 | python3-dev `mage-memgraph` \ 24 | clang `mage-memgraph` \ 25 | git `mage-memgraph` \ 26 | unixodbc-dev `mage-memgraph` \ 27 | supervisor `memgraph`\ 28 | netcat `memgraph-platform` \ 29 | --no-install-recommends \ 30 | && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* 31 | 32 | ################################################################################################################################################### 33 | 34 | # MAGE 35 | FROM base as mage-dev 36 | 37 | WORKDIR /mage 38 | COPY mage /mage 39 | 40 | RUN curl https://sh.rustup.rs -sSf | sh -s -- -y 41 | 42 | ENV PATH="/root/.cargo/bin:${PATH}" 43 | 44 | RUN python3 -m pip install --upgrade pip \ 45 | && python3 -m pip install --default-timeout=1000 -r /mage/python/requirements.txt 46 | 47 | RUN python3 -m pip --default-timeout=1000 --no-cache-dir install torch-sparse torch-cluster torch-spline-conv \ 48 | torch-geometric torch-scatter -f https://data.pyg.org/whl/torch-1.12.0+cu102.html 49 | 50 | RUN python3 /mage/setup build -p /usr/lib/memgraph/query_modules/ 51 | 52 | # DGL build from source 53 | RUN git clone --recurse-submodules -b 0.9.x https://github.com/dmlc/dgl.git \ 54 | && cd dgl && mkdir build && cd build && cmake .. \ 55 | && make -j4 && cd ../python && python3 setup.py install 56 | 57 | ################################################################################################################################################### 58 | 59 | # Lab: Build backend 60 | FROM node:18.15-alpine as lab-base 61 | 62 | WORKDIR /app 63 | # Python make and g++ are needed for arm node-gyp package 64 | RUN apk update && apk add git python3 make g++ 65 | ARG NPM_PACKAGE_TOKEN 66 | 67 | COPY lab/frontend/.npmrc ./frontend/ 68 | COPY lab/frontend/package*.json ./frontend/ 69 | RUN echo '//npm.pkg.github.com/:_authToken=${NPM_PACKAGE_TOKEN}' | tee -a ./frontend/.npmrc 70 | 71 | COPY lab/package*.json ./ 72 | 73 | RUN npm config rm proxy 74 | RUN npm config rm https-proxy 75 | RUN npm config set legacy-peer-deps true 76 | RUN npm install && npm cache clean --force 77 | RUN rm -f ./frontend/.npmrc 78 | 79 | COPY lab/tsconfig.json . 80 | COPY lab/tsconfig.build.json . 81 | COPY lab/.env . 82 | 83 | RUN sed -i "s/NODE_ENV=local/NODE_ENV=platform/" ./.env 84 | 85 | COPY lab/backend/ ./backend/ 86 | COPY lab/frontend/ ./frontend/ 87 | 88 | RUN npm run build 89 | 90 | RUN cd frontend && npm run build:production 91 | 92 | ################################################################################################################################################### 93 | 94 | FROM base as final 95 | 96 | # Copy the backend artifacts 97 | COPY --from=lab-base /app/dist-backend /lab/dist-backend 98 | COPY --from=lab-base /app/dist-frontend /lab/dist-frontend 99 | 100 | COPY --from=lab-base /app/node_modules /lab/node_modules 101 | COPY --from=lab-base /app/.env /lab/.env 102 | 103 | # This is needed for lab 104 | RUN apt-get update \ 105 | && curl -fsSL https://deb.nodesource.com/setup_18.x | bash - \ 106 | && apt-get install -y nodejs \ 107 | && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* 108 | 109 | # This is needed for memgraph built in algos 110 | RUN pip3 install --default-timeout=1000 networkx==2.4 numpy==1.21.4 scipy==1.7.3 111 | 112 | #copy modules 113 | COPY --from=mage-dev /usr/lib/memgraph/query_modules/ /usr/lib/memgraph/query_modules/ 114 | 115 | # rm modules with issues (temporary) 116 | RUN rm /usr/lib/memgraph/query_modules/node_classification.py \ 117 | && rm /usr/lib/memgraph/query_modules/link_prediction.py \ 118 | && rm /usr/lib/memgraph/query_modules/text.so 119 | 120 | #copy python build 121 | COPY --from=mage-dev /usr/local/lib/python${PY_VERSION}/ /usr/local/lib/python${PY_VERSION}/ 122 | 123 | COPY memgraph-${TARGETARCH}.deb . 124 | 125 | RUN dpkg -i memgraph-${TARGETARCH}.deb && rm memgraph-${TARGETARCH}.deb 126 | 127 | RUN rm -rf /mage \ 128 | && export PATH="/usr/local/lib/python${PY_VERSION}:${PATH}" \ 129 | && apt-get -y --purge autoremove clang git curl python3-pip python3-dev cmake build-essential \ 130 | && apt-get clean 131 | 132 | EXPOSE 3000 7444 7687 133 | COPY configs/ /etc/supervisor/ 134 | 135 | RUN chmod 777 -R /var/log/memgraph 136 | RUN chmod 777 -R /var/lib/memgraph 137 | RUN chmod 777 -R /usr/lib/memgraph 138 | RUN chmod 777 /usr/lib/memgraph/memgraph 139 | 140 | ENV MEMGRAPH="--also-log-to-stderr" 141 | 142 | ENTRYPOINT [ "/usr/bin/supervisord" ] 143 | CMD [ "-c", "/etc/supervisor/supervisord.conf" ] 144 | -------------------------------------------------------------------------------- /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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 |
3 |
One command to run it all.
5 | 6 |
7 |
8 |
9 |
125 |
126 |
127 |
128 |