├── .devcontainer └── devcontainer.json ├── .dockerignore ├── .github ├── dependabot.yml └── workflows │ ├── check_upstream_versions.sh │ ├── docker_build_and_push.sh │ ├── docker_build_pr.sh │ ├── docker_manifest.sh │ ├── workflow-build_and_push_image.yml │ ├── workflow-build_pr_image.yml │ └── workflow-update_image_for_upstream_updates.yml ├── .vscode └── extensions.json ├── Dockerfile ├── LICENSE ├── README.md └── root ├── etc ├── cont-init.d │ ├── 10-init_user_and_fix_permissions │ ├── 20-cleanup_stale_locks │ └── 30-update_cloudplow └── services.d │ └── cloudplow │ ├── finish │ └── run ├── tmp └── get_s6-overlay.sh └── usr └── bin └── cloudplow /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "alpine-cloudplow Devtainer", 3 | // Sets the run context to one level up instead of the .devcontainer folder. 4 | "context": "..", 5 | // Update the 'dockerFile' property if you aren't using the standard 'Dockerfile' filename. 6 | "dockerFile": "..\\Dockerfile", 7 | // Uncomment the next line to have VS Code connect as an existing non-root user in the container. 8 | // On Linux, by default, the container user's UID/GID will be updated to match your local user. See 9 | // https://aka.ms/vscode-remote/containers/non-root for details on adding a non-root user if none exist. 10 | // "remoteUser": "vscode", 11 | // Uncomment the next line if you will use a ptrace-based debugger like C++, Go, and Rust 12 | // "runArgs": [ "--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined" ], 13 | // Uncomment the next line to use Docker from inside the container. See https://aka.ms/vscode-remote/samples/docker-in-docker for details. 14 | "mounts": [ 15 | "source=/var/run/docker.sock,target=/var/run/docker.sock,type=bind" 16 | ], 17 | // Use 'settings' to set *default* container specific settings.json values on container create. 18 | // You can edit these settings after create using File > Preferences > Settings > Remote. 19 | "settings": { 20 | // This will ignore your local shell user setting for Linux since shells like zsh are typically 21 | // not in base container images. You can also update this to an specific shell to ensure VS Code 22 | // uses the right one for terminals and tasks. For example, /bin/bash (or /bin/ash for Alpine). 23 | "python.pythonPath": "/usr/bin/python3" 24 | }, 25 | // Use 'appPort' to create a container with published ports. If the port isn't working, be sure 26 | // your server accepts connections from all interfaces (0.0.0.0 or '*'), not just localhost. 27 | //"appPort": [], 28 | // Uncomment the next line to run commands after the container is created - for example installing git. 29 | "postCreateCommand": "apk add -U --no-cache docker-cli gcc gnupg musl-dev python3-dev openssh-client && python3 -m pip install --no-cache-dir --upgrade pylint autopep8", 30 | // Add the IDs of extensions you want installed when the container is created in the array below. 31 | "extensions": [ 32 | "davidanson.vscode-markdownlint", 33 | "esbenp.prettier-vscode", 34 | "ms-azuretools.vscode-docker", 35 | "ms-python.python" 36 | ], 37 | // Disable the default echo/sleep while loop 38 | "overrideCommand": true, 39 | "containerEnv": { 40 | "CLOUDPLOW_LOGLEVEL": "DEBUG" 41 | } 42 | } -------------------------------------------------------------------------------- /.dockerignore: -------------------------------------------------------------------------------- 1 | .devcontainer/* 2 | .git/* 3 | .github/* 4 | .vscode/* 5 | .dockerignore 6 | Dockerfile 7 | LICENSE 8 | README.md 9 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | # Maintain dependencies for GitHub Actions and Docker 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | - package-ecosystem: "docker" 9 | directory: "/" 10 | schedule: 11 | interval: "daily" 12 | -------------------------------------------------------------------------------- /.github/workflows/check_upstream_versions.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | image_cloudplow_ref=`docker run ghcr.io/$GITHUB_REPOSITORY "git --work-tree=/opt/cloudplow rev-parse HEAD"` 4 | image_s6_release=`docker run ghcr.io/$GITHUB_REPOSITORY "cat /etc/S6_RELEASE"` 5 | image_rclone_version=`docker run ghcr.io/$GITHUB_REPOSITORY "rclone version" | grep rclone | awk '{print $2}'` 6 | 7 | current_cloudplow_ref=`curl -sX GET "https://api.github.com/repos/l3uddz/cloudplow/commits/develop" | jq '.sha' | tr -d '"'` 8 | current_s6_release=`curl -sX GET "https://api.github.com/repos/just-containers/s6-overlay/releases/latest" | jq '.tag_name' | tr -d '"'` 9 | current_rclone_version=`docker run rclone/rclone "version" | grep rclone | awk '{print $2}'` 10 | 11 | 12 | if [ $image_rclone_version != $current_rclone_version ] 13 | then 14 | echo "New version of rclone is available." 15 | build=1 16 | fi 17 | if [ $image_cloudplow_ref != $current_cloudplow_ref ] 18 | then 19 | echo "New version of cloudplow is available." 20 | build=1 21 | fi 22 | if [ $image_s6_release != $current_s6_release ] 23 | then 24 | echo "New version of s6-overlay is available." 25 | build=1 26 | fi 27 | 28 | if [[ $build ]] 29 | then 30 | echo "Triggering build." 31 | echo "build=true" >> $GITHUB_OUTPUT 32 | else 33 | echo "No build needed." 34 | echo "build=false" >> $GITHUB_OUTPUT 35 | fi 36 | -------------------------------------------------------------------------------- /.github/workflows/docker_build_and_push.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | docker buildx build \ 4 | --platform ${ARCHITECTURE//-/\/} \ 5 | --output "type=image,push=true" \ 6 | --tag ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-${ARCHITECTURE//linux-/} \ 7 | --build-arg ARCH="${ARCHITECTURE//linux-/}" \ 8 | --build-arg BUILD_DATE="$(date -u +'%Y-%m-%dT%H:%M:%SZ')" \ 9 | --build-arg COMMIT_AUTHOR="$(git log -1 --pretty=format:'%ae')" \ 10 | --build-arg VCS_REF="${GITHUB_SHA}" \ 11 | --build-arg VCS_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \ 12 | --file ./Dockerfile ./ -------------------------------------------------------------------------------- /.github/workflows/docker_build_pr.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | TAG=${GITHUB_REF//refs\/pull\//PR} 3 | TAG=${TAG//\/merge/} 4 | docker buildx build \ 5 | --platform ${ARCHITECTURE//-/\/} \ 6 | --output "type=image,push=false" \ 7 | --tag ghcr.io/${GITHUB_REPOSITORY}:${TAG}-${GITHUB_SHA:0:7}-${ARCHITECTURE//linux-/} \ 8 | --build-arg ARCH="${ARCHITECTURE//linux-/}" \ 9 | --build-arg BUILD_DATE="$(date -u +'%Y-%m-%dT%H:%M:%SZ')" \ 10 | --build-arg COMMIT_AUTHOR="$(git log -1 --pretty=format:'%ae')" \ 11 | --build-arg VCS_REF="${GITHUB_SHA}" \ 12 | --build-arg VCS_URL="${GITHUB_SERVER_URL}/${GITHUB_REPOSITORY}" \ 13 | --file ./Dockerfile ./ -------------------------------------------------------------------------------- /.github/workflows/docker_manifest.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_SHA:0:7} \ 4 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-amd64 \ 5 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm-v7 \ 6 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm64 7 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_SHA:0:7} 8 | 9 | if [[ ${GITHUB_REF//refs\/heads\//} == "main" ]] 10 | then 11 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:latest \ 12 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-amd64 \ 13 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm-v7 \ 14 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm64 15 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:latest 16 | 17 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:amd64 \ 18 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-amd64 19 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:amd64 20 | 21 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:arm-v7 \ 22 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm-v7 23 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:arm-v7 24 | 25 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:arm64 \ 26 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm64 27 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:arm64 28 | else 29 | docker manifest create ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//} \ 30 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-amd64 \ 31 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm-v7 \ 32 | --amend ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//}-${GITHUB_SHA:0:7}-arm64 33 | docker manifest push ghcr.io/${GITHUB_REPOSITORY}:${GITHUB_REF//refs\/heads\//} 34 | fi -------------------------------------------------------------------------------- /.github/workflows/workflow-build_and_push_image.yml: -------------------------------------------------------------------------------- 1 | name: Build and push image 2 | on: 3 | workflow_dispatch: 4 | push: 5 | branches: 6 | - main 7 | paths-ignore: 8 | - ".devcontainer/**" 9 | - ".github/dependabot.yml" 10 | - ".vscode/**" 11 | - "LICENSE" 12 | - "README.md" 13 | 14 | jobs: 15 | build_main: 16 | runs-on: ubuntu-latest 17 | strategy: 18 | matrix: 19 | architecture: [linux-arm-v7, linux-arm64, linux-amd64] 20 | 21 | steps: 22 | - uses: actions/checkout@v4 23 | 24 | - name: Set up QEMU 25 | uses: docker/setup-qemu-action@v3 26 | 27 | - name: Set up Docker Buildx 28 | uses: docker/setup-buildx-action@v3 29 | with: 30 | version: latest 31 | driver-opts: image=moby/buildkit:v0.10.6 32 | 33 | - name: Log in to registry 34 | run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin 35 | 36 | - name: Build and push images using buildx 37 | run: ARCHITECTURE=${{ matrix.architecture }} .github/workflows/docker_build_and_push.sh 38 | 39 | publish: 40 | runs-on: ubuntu-latest 41 | needs: [build_main] 42 | steps: 43 | - name: Checkout 44 | uses: actions/checkout@v4 45 | 46 | - name: Enable experimental Docker features 47 | run: 'echo ''{"experimental": "enabled"}'' > ~/.docker/config.json' 48 | 49 | - name: Log in to registry 50 | run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin 51 | 52 | - name: Create and push docker manifest 53 | run: .github/workflows/docker_manifest.sh 54 | -------------------------------------------------------------------------------- /.github/workflows/workflow-build_pr_image.yml: -------------------------------------------------------------------------------- 1 | name: Test PR - Build image 2 | on: 3 | workflow_dispatch: 4 | pull_request: 5 | branches: 6 | - main 7 | 8 | jobs: 9 | build_pr: 10 | runs-on: ubuntu-latest 11 | strategy: 12 | matrix: 13 | architecture: [linux-arm-v7, linux-arm64, linux-amd64] 14 | 15 | steps: 16 | - uses: actions/checkout@v4 17 | 18 | - name: Set up QEMU 19 | uses: docker/setup-qemu-action@v3 20 | 21 | - name: Set up Docker Buildx 22 | uses: docker/setup-buildx-action@v3 23 | with: 24 | version: latest 25 | driver-opts: image=moby/buildkit:v0.10.6 26 | 27 | - name: Build images using buildx 28 | run: ARCHITECTURE=${{ matrix.architecture }} .github/workflows/docker_build_pr.sh 29 | -------------------------------------------------------------------------------- /.github/workflows/workflow-update_image_for_upstream_updates.yml: -------------------------------------------------------------------------------- 1 | name: Rebuild with upstream updates 2 | on: 3 | workflow_dispatch: 4 | schedule: 5 | - cron: "0 0 * * *" 6 | 7 | jobs: 8 | check_versions: 9 | runs-on: ubuntu-latest 10 | outputs: 11 | build: ${{ steps.check.outputs.build}} 12 | steps: 13 | - uses: actions/checkout@v4 14 | 15 | - name: Check for upstream updates 16 | id: check 17 | run: bash .github/workflows/check_upstream_versions.sh 18 | 19 | build_main: 20 | runs-on: ubuntu-latest 21 | needs: [check_versions] 22 | if: ${{ needs.check_versions.outputs.build == 'true' }} 23 | strategy: 24 | matrix: 25 | architecture: [linux-arm-v7, linux-arm64, linux-amd64] 26 | 27 | steps: 28 | - name: Checkout 29 | uses: actions/checkout@v4 30 | 31 | - name: Set up QEMU 32 | uses: docker/setup-qemu-action@v3 33 | 34 | - name: Set up Docker Buildx 35 | uses: docker/setup-buildx-action@v3 36 | with: 37 | version: latest 38 | driver-opts: image=moby/buildkit:v0.10.6 39 | 40 | - name: Log in to registry 41 | run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin 42 | 43 | - name: Build and push images using buildx 44 | run: ARCHITECTURE=${{ matrix.architecture }} .github/workflows/docker_build_and_push.sh 45 | 46 | publish: 47 | runs-on: ubuntu-latest 48 | needs: [build_main] 49 | steps: 50 | - name: Checkout 51 | uses: actions/checkout@v4 52 | 53 | - name: Enable experimental Docker features 54 | run: 'echo ''{"experimental": "enabled"}'' > ~/.docker/config.json' 55 | 56 | - name: Log in to registry 57 | run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin 58 | 59 | - name: Create and push docker manifest 60 | run: .github/workflows/docker_manifest.sh 61 | -------------------------------------------------------------------------------- /.vscode/extensions.json: -------------------------------------------------------------------------------- 1 | { 2 | "recommendations": [ 3 | "davidanson.vscode-markdownlint", 4 | "esbenp.prettier-vscode", 5 | "ms-azuretools.vscode-docker", 6 | "ms-python.python" 7 | ] 8 | } -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM rclone/rclone 2 | 3 | ARG BUILD_DATE="unknown" 4 | ARG COMMIT_AUTHOR="unknown" 5 | ARG VCS_REF="unknown" 6 | ARG VCS_URL="unknown" 7 | ARG ARCH="amd64" 8 | 9 | LABEL maintainer=${COMMIT_AUTHOR} \ 10 | org.label-schema.vcs-ref=${VCS_REF} \ 11 | org.label-schema.vcs-url=${VCS_URL} \ 12 | org.label-schema.build-date=${BUILD_DATE} 13 | 14 | # linking the base image's rclone binary to the path expected by cloudplow's default config 15 | RUN ln /usr/local/bin/rclone /usr/bin/rclone 16 | 17 | # configure environment variables to keep the start script clean 18 | ENV CLOUDPLOW_CONFIG=/config/config.json CLOUDPLOW_LOGFILE=/config/cloudplow.log CLOUDPLOW_LOGLEVEL=DEBUG CLOUDPLOW_CACHEFILE=/config/cache.db 19 | 20 | # map /config to host directory containing cloudplow config (used to store configuration from app) 21 | VOLUME /config 22 | 23 | # map /rclone_config to host directory containing rclone configuration files 24 | VOLUME /rclone_config 25 | 26 | # map /service_accounts to host directory containing Google Drive service account .json files 27 | VOLUME /service_accounts 28 | 29 | # map /data to media queued for upload 30 | VOLUME /data 31 | 32 | # install dependencies for cloudplow and user management, upgrade pip 33 | RUN apk -U add --no-cache \ 34 | coreutils \ 35 | findutils \ 36 | git \ 37 | grep \ 38 | py3-pip \ 39 | py3-wheel \ 40 | python3 \ 41 | shadow \ 42 | tzdata 43 | 44 | # add s6-overlay scripts and config 45 | ADD root/ / 46 | 47 | # install s6-overlay for process management 48 | RUN apk -Uq --no-cache add curl && \ 49 | /tmp/get_s6-overlay.sh && \ 50 | rm /tmp/get_s6-overlay.sh && \ 51 | apk -q del curl 52 | 53 | # download cloudplow 54 | RUN git clone --depth 1 --single-branch --branch develop https://github.com/l3uddz/cloudplow /opt/cloudplow 55 | 56 | WORKDIR /opt/cloudplow 57 | ENV PATH=/opt/cloudplow:${PATH} 58 | RUN git config pull.ff only 59 | 60 | # install pip requirements 61 | RUN python3 -m pip install --no-cache-dir --upgrade --break-system-packages -r requirements.txt 62 | 63 | ENTRYPOINT ["/bin/sh", "-c"] 64 | CMD ["/init"] 65 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # alpine-cloudplow 2 | 3 | [![License: GPL v3](https://img.shields.io/badge/License-GPL%203-blue.svg?style=flat)](https://github.com/sabrsorensen/alpine-cloudplow/blob/main/LICENSE) 4 | [![Container Build](https://img.shields.io/github/actions/workflow/status/sabrsorensen/alpine-cloudplow/workflow-build_and_push_image.yml?branch=main&label=Container%20Build)](https://github.com/sabrsorensen/alpine-cloudplow/actions?query=workflow%3A%22Build+and+push+image%22) 5 | [![Rebuild for Upstream Updates](https://img.shields.io/github/actions/workflow/status/sabrsorensen/alpine-cloudplow/workflow-update_image_for_upstream_updates.yml?branch=main&label=Rebuild%20for%20Upstream%20Updates)](https://github.com/sabrsorensen/alpine-cloudplow/actions?query=workflow%3A%22Rebuild+with+upstream+updates%22) 6 | [![rclone version](https://img.shields.io/github/v/release/rclone/rclone?label=rclone%20version)](https://hub.docker.com/r/rclone/rclone) 7 | 8 | A Docker image for the [cloudplow](https://github.com/l3uddz/cloudplow) cloud media sync service, using [rclone's official Docker image](https://hub.docker.com/r/rclone/rclone) based on Alpine Linux as a foundation. 9 | 10 | ## Application 11 | 12 | [cloudplow](https://github.com/l3uddz/cloudplow) 13 | 14 | [rclone](https://github.com/rclone/rclone) 15 | 16 | ## Description 17 | 18 | Cloudplow is an automatic rclone remote uploader with support for scheduled transfers, multiple remote/folder pairings, UnionFS control file cleanup, and synchronization between rclone remotes. 19 | 20 | ## Usage 21 | 22 | Sample docker-compose.yml configuration, where the host's rclone.conf is stored in ~/.config/rclone, one or more Google Drive service account .json files is located in ~/google_drive_service_accounts, and media to upload is stored in /imported_media: 23 | 24 | ```yaml 25 | cloudplow: 26 | image: ghcr.io/sabrsorensen/alpine-cloudplow 27 | container_name: cloudplow 28 | environment: 29 | - PUID=`id -u cloudplow` 30 | - PGID=`id -g cloudplow` 31 | - CLOUDPLOW_CONFIG=/config/config.json 32 | - CLOUDPLOW_LOGFILE=/config/cloudplow.log 33 | - CLOUDPLOW_LOGLEVEL=DEBUG 34 | - CLOUDPLOW_CACHEFILE=/config/cache.db 35 | volumes: 36 | - /opt/cloudplow:/config/:rw 37 | - /home//.config/rclone:/rclone_config/:rw 38 | - /home//google_drive_service_accounts:/service_accounts/:rw 39 | - /imported_media:/data/imported_media:rw 40 | - /etc/localtime:/etc/localtime:ro 41 | restart: unless-stopped 42 | ``` 43 | 44 | Upon first run, the container will generate a sample config.json in the container's /config. Edit this config.json to your liking, making sure to set rclone_config_path to the location of the rclone.conf you mapped into the container. Some suggested settings for uploading to a remote, but not synchronizing between remotes, are given below: 45 | 46 | ```json 47 | "core": { 48 | ... 49 | "rclone_binary_path": "/usr/bin/rclone", 50 | "rclone_config_path": "/rclone_config/rclone.conf" 51 | ... 52 | }, 53 | ... 54 | "plex": { 55 | ... 56 | "rclone": { 57 | ... 58 | "url": "http://127.0.0.1:7949" 59 | ... 60 | }, 61 | ... 62 | "url": "http://plex:32400" # URL of plex server, this example value specifies a Plex Docker container running on the same host. 63 | ... 64 | }, 65 | "remotes": { 66 | ... 67 | "media": { 68 | "rclone_command": "move", 69 | "rclone_excludes": [ 70 | ], 71 | "rclone_extras": { 72 | "--checkers": 4, 73 | "--drive-chunk-size": "8M", 74 | "--fast-list": null, 75 | "--min-age": "1d", 76 | "--skip-links": null, 77 | "--stats": "10s", 78 | "--timeout": "30s", 79 | "--transfers": 1, 80 | "--user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/74.0.3729.131 Safari/537.36", 81 | "-vv": null 82 | }, 83 | "rclone_sleeps": { 84 | "Failed to copy: googleapi: Error 403: User rate limit exceeded": { 85 | "count": 5, 86 | "sleep": 25, 87 | "timeout": 3600 88 | } 89 | }, 90 | "remove_empty_dir_depth": 2, 91 | "sync_remote": "googledrive:/media/", 92 | "upload_folder": "/data/imported_media", 93 | "upload_remote": "googledrive:/media/" 94 | }, 95 | ... 96 | }, 97 | "syncer": {}, 98 | "uploader": { 99 | ... 100 | "media": { 101 | "check_interval": 30, 102 | "exclude_open_files": true, 103 | "max_size_gb": 0, 104 | "opened_excludes": [ 105 | "/data/imported_media" 106 | ], 107 | "schedule": { 108 | "allowed_from": "01:00", 109 | "allowed_until": "09:00", 110 | "enabled": false 111 | }, 112 | "size_excludes": [ 113 | ], 114 | "service_account_path":"/service_accounts/" 115 | }, 116 | ... 117 | } 118 | } 119 | ``` 120 | 121 | Please refer to the official [cloudplow](https://github.com/l3uddz/cloudplow) documentation for additional information. 122 | -------------------------------------------------------------------------------- /root/etc/cont-init.d/10-init_user_and_fix_permissions: -------------------------------------------------------------------------------- 1 | #!/command/with-contenv sh 2 | 3 | debug=false 4 | if [ $CLOUDPLOW_LOGLEVEL == "DEBUG" ] 5 | then 6 | debug=true 7 | fi 8 | 9 | debug_echo() 10 | { 11 | if [ $debug == true ] 12 | then 13 | echo "$@" 14 | fi 15 | } 16 | 17 | uid=${PUID:-1000} 18 | debug_echo " 19 | PUID: $PUID 20 | UID: $uid 21 | " 22 | 23 | gid=${PGID:-1000} 24 | debug_echo " 25 | PGID: $PGID 26 | GID: $gid 27 | " 28 | 29 | if [ $uid == 0 ] && [ $gid == 0 ] 30 | then 31 | echo "Running as root, no permission changes necessary. Exiting successfully." 32 | exit 0 33 | fi 34 | 35 | group=$(getent group $gid | awk -F: '{print $1}') 36 | if [ $group ] 37 | then 38 | debug_echo "Group '$group' for running cloudplow exists: $(getent group $gid)" 39 | else 40 | debug_echo "Group for running cloudplow does not exist, creating group 'cloudplow'." 41 | groupadd -g $gid -r cloudplow 42 | debug_echo "Group 'cloudplow' created." 43 | group="cloudplow" 44 | fi 45 | 46 | user=$(getent passwd $uid | awk -F: '{print $1}') 47 | if [ $user ] 48 | then 49 | debug_echo "User '$user' for running cloudplow exists: $(getent passwd $uid)" 50 | groups $user | grep &>/dev/null "\b$group\b" 51 | if [ $? != 0 ] 52 | then 53 | usermod -a -G $group $user 54 | debug_echo "Supplemental group '$group' added to user '$user', now a member of groups: $(id -nG $uid)" 55 | fi 56 | else 57 | debug_echo "User account for running cloudplow does not exist, creating service user 'cloudplow'." 58 | useradd -u $uid -g $gid -N -r -m -s /sbin/nologin cloudplow 59 | debug_echo "User 'cloudplow' created. 60 | ------------------------------------ 61 | New user ID info: $(id $uid) 62 | ------------------------------------ 63 | " 64 | fi 65 | 66 | chown -R $uid:$gid /config 67 | find /config -type d -exec chmod 0777 {} + 68 | chmod 0666 /config/config.json 69 | 70 | chown -R $uid:$gid /opt/cloudplow 71 | find /opt/cloudplow -type d -exec chmod 0775 {} + 72 | find /opt/cloudplow -type f -exec chmod 0664 {} + 73 | chmod -R 0775 /opt/cloudplow/cloudplow.py /opt/cloudplow/scripts 74 | 75 | echo "Permissions on /config and /opt/cloudplow restored successfully." 76 | exit 0 77 | -------------------------------------------------------------------------------- /root/etc/cont-init.d/20-cleanup_stale_locks: -------------------------------------------------------------------------------- 1 | #!/command/with-contenv sh 2 | 3 | rm -rf /opt/cloudplow/locks 4 | -------------------------------------------------------------------------------- /root/etc/cont-init.d/30-update_cloudplow: -------------------------------------------------------------------------------- 1 | #!/command/with-contenv sh 2 | 3 | uid=${PUID:-1000} 4 | user=$(getent passwd $uid | awk -F: '{print $1}') 5 | cd /opt/cloudplow 6 | exec s6-setuidgid $user git pull 7 | exec s6-setuidgid $user python3 -m pip install --no-cache-dir --upgrade -r requirements.txt 8 | -------------------------------------------------------------------------------- /root/etc/services.d/cloudplow/finish: -------------------------------------------------------------------------------- 1 | #!/command/execlineb -S0 2 | if { s6-test ${1} -ne 0 } 3 | if { s6-test ${1} -ne 256 } 4 | 5 | s6-svscanctl -t /var/run/s6/services 6 | -------------------------------------------------------------------------------- /root/etc/services.d/cloudplow/run: -------------------------------------------------------------------------------- 1 | #!/command/with-contenv sh 2 | 3 | uid=${PUID:-1000} 4 | user=$(getent passwd $uid | awk -F: '{print $1}') 5 | if [ ! -f ${CLOUDPLOW_CONFIG} ] 6 | then 7 | exec s6-setuidgid $user env python3 /opt/cloudplow/cloudplow.py run 8 | echo "************************************************************************************" 9 | echo "INFO: Default config.json generated at ${CLOUDPLOW_CONFIG}, please configure for your environment. Exiting." 10 | echo "************************************************************************************" 11 | exit 1 12 | fi 13 | rclone_conf_path=$(grep -P "rclone_config_path" ${CLOUDPLOW_CONFIG} | awk -F: '{print $2}' | awk -F\" '{print $2}') 14 | if [ ! -f ${rclone_conf_path} ] 15 | then 16 | echo "************************************************************************************" 17 | echo "ERROR: ${CLOUDPLOW_CONFIG}:core.rclone_config_path does not point to an existing file." 18 | echo "************************************************************************************" 19 | exit 1 20 | elif rclone --config ${rclone_conf_path} config show &> /dev/null 21 | then 22 | exec s6-setuidgid $user env python3 /opt/cloudplow/cloudplow.py run 23 | exit 0 24 | else 25 | echo "************************************************************************************" 26 | echo "ERROR: ${CLOUDPLOW_CONFIG}:core.rclone_config_path is not a valid rclone config file." 27 | echo "************************************************************************************" 28 | exit 1 29 | fi 30 | -------------------------------------------------------------------------------- /root/tmp/get_s6-overlay.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ -n $ARCH ] 4 | then 5 | s6_arch=$ARCH 6 | else 7 | s6_arch="amd64" 8 | fi 9 | 10 | case "$s6_arch" in 11 | arm-v7) 12 | s6_arch="armhf" 13 | ;; 14 | arm64) 15 | s6_arch="aarch64" 16 | ;; 17 | amd64) 18 | s6_arch="x86_64" 19 | ;; 20 | esac 21 | curl -sX GET "https://api.github.com/repos/just-containers/s6-overlay/releases/latest" | awk '/tag_name/{print $4;exit}' FS='[""]' >/etc/S6_RELEASE && \ 22 | s6_arch_url="https://github.com/just-containers/s6-overlay/releases/download/`cat /etc/S6_RELEASE`/s6-overlay-$s6_arch.tar.xz" 23 | s6_noarch_url="https://github.com/just-containers/s6-overlay/releases/download/`cat /etc/S6_RELEASE`/s6-overlay-noarch.tar.xz" 24 | s6_symlinks_arch_url="https://github.com/just-containers/s6-overlay/releases/download/`cat /etc/S6_RELEASE`/s6-overlay-symlinks-arch.tar.xz" 25 | s6_symlinks_noarch_url="https://github.com/just-containers/s6-overlay/releases/download/`cat /etc/S6_RELEASE`/s6-overlay-symlinks-noarch.tar.xz" 26 | 27 | echo "Downloading from $s6_noarch_url" && \ 28 | wget $s6_noarch_url -O /tmp/s6-overlay-noarch.tar.xz && \ 29 | tar -C / -Jxpf /tmp/s6-overlay-noarch.tar.xz && \ 30 | rm /tmp/s6-overlay-noarch.tar.xz && \ 31 | 32 | echo "Downloading from $s6_arch_url" && \ 33 | wget $s6_arch_url -O /tmp/s6-overlay-${s6_arch}.tar.xz && \ 34 | tar -C / -Jxpf /tmp/s6-overlay-${s6_arch}.tar.xz && \ 35 | rm /tmp/s6-overlay-${s6_arch}.tar.xz && \ 36 | 37 | echo "Downloading from $s6_symlinks_noarch_url" && \ 38 | wget $s6_symlinks_noarch_url -O /tmp/s6-overlay-symlinks-noarch.tar.xz && \ 39 | tar -C / -Jxpf /tmp/s6-overlay-symlinks-noarch.tar.xz && \ 40 | rm /tmp/s6-overlay-symlinks-noarch.tar.xz && \ 41 | 42 | echo "Downloading from $s6_symlinks_arch_url" && \ 43 | wget $s6_symlinks_arch_url -O /tmp/s6-overlay-symlinks-arch.tar.xz && 44 | tar -C / -Jxpf /tmp/s6-overlay-symlinks-arch.tar.xz && \ 45 | rm /tmp/s6-overlay-symlinks-arch.tar.xz && \ 46 | echo "Installed s6-overlay `cat /etc/S6_RELEASE` ($s6_arch)" 47 | -------------------------------------------------------------------------------- /root/usr/bin/cloudplow: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | env python3 /opt/cloudplow/cloudplow.py $@ 4 | --------------------------------------------------------------------------------