├── .env ├── config └── hosts ├── .github └── FUNDING.yml ├── .devcontainer ├── devcontainer.json └── Dockerfile ├── docker-compose.yml ├── README.md ├── .gitignore └── LICENSE /.env: -------------------------------------------------------------------------------- 1 | # Cloudflare Tunnel Token (replace with your actual token) 2 | CLOUDFLARE_TUNNEL_TOKEN='' 3 | -------------------------------------------------------------------------------- /config/hosts: -------------------------------------------------------------------------------- 1 | 127.0.0.1 localhost 2 | 3 | ::1 localhost ip6-localhost ip6-loopback 4 | 5 | # Custom Hosts Section 6 | # Add any additional hostname mappings below: 7 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: jonas-merkle # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2] 4 | patreon: # Replace with a single Patreon username 5 | open_collective: # Replace with a single Open Collective username 6 | ko_fi: # Replace with a single Ko-fi username 7 | tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel 8 | community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry 9 | liberapay: # Replace with a single Liberapay username 10 | issuehunt: # Replace with a single IssueHunt username 11 | otechie: # Replace with a single Otechie username 12 | lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry 13 | custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2'] 14 | -------------------------------------------------------------------------------- /.devcontainer/devcontainer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "Ubuntu Dev Container", 3 | "build": { 4 | "dockerfile": "Dockerfile", 5 | "options": [ 6 | "--ssh=default" 7 | ] 8 | }, 9 | "features": { 10 | "ghcr.io/devcontainers/features/docker-in-docker:2": { 11 | "installDockerBuildx": true 12 | } 13 | }, 14 | "customizations": { 15 | "vscode": { 16 | "extensions": [ 17 | "vscode-icons-team.vscode-icons", 18 | "streetsidesoftware.code-spell-checker", 19 | "streetsidesoftware.code-spell-checker-german", 20 | "eamodio.gitlens", 21 | "seatonjiang.gitmoji-vscode" 22 | ], 23 | "settings": { 24 | "editor.fontFamily": "Hack Nerd Font Mono", 25 | "editor.tabSize": 4, 26 | "editor.insertSpaces": true, 27 | 28 | "files.autoSave": "afterDelay", 29 | 30 | "git.enableSmartCommit": true, 31 | "git.confirmSync": false, 32 | "git.autofetch": true, 33 | 34 | "terminal.integrated.defaultProfile.linux": "zsh", 35 | "terminal.integrated.fontFamily": "Hack Nerd Font Mono", 36 | 37 | "telemetry.telemetryLevel": "crash", 38 | 39 | "workbench.colorTheme": "Default Dark Modern", 40 | "workbench.iconTheme": "vscode-icons", 41 | 42 | "cSpell.language": "de,en", 43 | "gitlens.telemetry.enabled": false 44 | } 45 | } 46 | }, 47 | "remoteUser": "vscode" 48 | } 49 | -------------------------------------------------------------------------------- /.devcontainer/Dockerfile: -------------------------------------------------------------------------------- 1 | # Use the base dev container image 2 | FROM mcr.microsoft.com/devcontainers/base:ubuntu 3 | 4 | # Update package lists and install required packages 5 | RUN apt-get update && apt-get install -y \ 6 | curl \ 7 | wget \ 8 | btop \ 9 | fontconfig \ 10 | && apt-get clean \ 11 | && rm -rf /var/lib/apt/lists/* 12 | 13 | # Install Hack Nerd Font for terminal use 14 | RUN mkdir -p ~/.fonts && wget -q -P ~/.fonts https://github.com/ryanoasis/nerd-fonts/releases/latest/download/Hack.zip \ 15 | && unzip -o ~/.fonts/Hack.zip -d ~/.fonts && fc-cache -fv \ 16 | && rm -f ~/.fonts/Hack.zip 17 | 18 | # Switch to the vscode user (assumes the user already exists in this base image) 19 | USER vscode 20 | 21 | # Install Powerlevel10k theme 22 | RUN git clone --depth=1 https://github.com/romkatv/powerlevel10k.git /home/vscode/.oh-my-zsh/custom/themes/powerlevel10k \ 23 | && sed -i 's|ZSH_THEME=".*"|ZSH_THEME="powerlevel10k/powerlevel10k"|' /home/vscode/.zshrc 24 | 25 | # Install Zsh plugins 26 | RUN git clone https://github.com/zsh-users/zsh-autosuggestions /home/vscode/.oh-my-zsh/custom/plugins/zsh-autosuggestions \ 27 | && git clone https://github.com/zsh-users/zsh-syntax-highlighting /home/vscode/.oh-my-zsh/custom/plugins/zsh-syntax-highlighting \ 28 | && git clone https://github.com/zsh-users/zsh-history-substring-search /home/vscode/.oh-my-zsh/custom/plugins/history-substring-search \ 29 | && sed -i 's|plugins=(.*)|plugins=(git zsh-autosuggestions zsh-syntax-highlighting history-substring-search)|' /home/vscode/.zshrc 30 | 31 | # Switch to the root user 32 | USER root 33 | 34 | # Ensure proper permissions for the vscode user 35 | RUN chown -R vscode:vscode /home/vscode/.oh-my-zsh /home/vscode/.zshrc 36 | 37 | # Switch to the vscode user (assumes the user already exists in this base image) 38 | USER vscode 39 | 40 | # Set Zsh as the default shell and ensure the container starts with the vscode user 41 | WORKDIR /workspaces 42 | CMD [ "zsh" ] 43 | USER vscode 44 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # Docker Compose configuration for setting up a Cloudflare Tunnel container 2 | # 3 | # This configuration pulls the latest Cloudflare Tunnel image from the specified repository 4 | # and includes options for logging, automatic updates using Watchtower, health checks, and volume mounting. 5 | 6 | services: 7 | 8 | # Cloudflare Tunnel Service 9 | cloudflare-tunnel: 10 | image: cloudflare/cloudflared:latest # Pull the latest version of the Cloudflare Tunnel image 11 | container_name: cloudflare-tunnel # Name of the Cloudflare Tunnel container 12 | hostname: cloudflare-tunnel # Hostname for the Cloudflare Tunnel container 13 | 14 | restart: unless-stopped # Restart the container unless manually stopped 15 | 16 | # Logging configuration for Cloudflare Tunnel container 17 | logging: 18 | driver: "json-file" # Use the default json-file logging driver 19 | options: 20 | max-size: "100m" # Maximum log file size before rotation (100 MB) 21 | max-file: "10" # Maximum number of log files to retain (10) 22 | 23 | # Network mode configuration 24 | network_mode: "host" # Use the host network (no isolation between host and container) 25 | 26 | # Command to run Cloudflare Tunnel 27 | command: tunnel run # Command to start the Cloudflare tunnel 28 | 29 | # Volume configuration for time synchronization and hosts file persistence 30 | volumes: 31 | - /etc/localtime:/etc/localtime:ro # Synchronize time with the host 32 | - ./config/hosts:/etc/hosts # Mount hosts file from host to container 33 | 34 | # Environment variables for Cloudflare Tunnel 35 | environment: 36 | - "TUNNEL_TOKEN=${CLOUDFLARE_TUNNEL_TOKEN}" # Pass the Cloudflare Tunnel token from environment variable 37 | 38 | # Health check configuration to verify Cloudflare Tunnel readiness 39 | healthcheck: 40 | test: ["CMD", "cloudflared", "--version"] # Check if cloudflared version command works 41 | interval: 30s # Time between health check attempts 42 | timeout: 10s # Time to wait for a response 43 | retries: 3 # Number of retries before marking as unhealthy 44 | start_period: 10s # Delay before health checks begin 45 | 46 | # Container labels for additional metadata 47 | labels: 48 | - "com.centurylinklabs.watchtower.enable=true" # Enable automatic updates with Watchtower 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Container Cloudflare Tunnel 2 | 3 | A Docker Compose container setup for a [Cloudflare Tunnel](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/). This setup allows you to securely expose a local service to the internet using Cloudflare's infrastructure. 4 | 5 |
6 | 7 | Table of Contents 8 | 9 | ## Table of Contents 10 | 11 | - [Container Cloudflare Tunnel](#container-cloudflare-tunnel) 12 | - [Table of Contents](#table-of-contents) 13 | - [Introduction](#introduction) 14 | - [Setup](#setup) 15 | - [Requirements](#requirements) 16 | - [Environment Variables](#environment-variables) 17 | - [How to Obtain the Cloudflare Tunnel Token](#how-to-obtain-the-cloudflare-tunnel-token) 18 | - [Hosts Configuration](#hosts-configuration) 19 | - [Usage](#usage) 20 | - [Starting the Container](#starting-the-container) 21 | - [Stopping the Container](#stopping-the-container) 22 | - [Viewing Logs](#viewing-logs) 23 | - [Cleanup](#cleanup) 24 | - [Real-World Examples](#real-world-examples) 25 | - [Example 1: Hosting a Webpage with Apache and Docker](#example-1-hosting-a-webpage-with-apache-and-docker) 26 | - [Example 2: Secure Self-Hosting with Cloudflare Zero Trust Tunnels](#example-2-secure-self-hosting-with-cloudflare-zero-trust-tunnels) 27 | - [Security Notes](#security-notes) 28 | - [License](#license) 29 | - [Additional Resources](#additional-resources) 30 | 31 |
32 | 33 | ## Introduction 34 | 35 | Cloudflare Tunnel provides a secure way to expose a web server running on your local network to the public internet. This can be particularly useful for development, accessing internal services remotely, or securely publishing a service without opening ports on your router. The container in this project sets up a Cloudflare Tunnel, making it simple to deploy. 36 | 37 | ## Setup 38 | 39 | ### Requirements 40 | 41 | - Docker 42 | - Docker Compose 43 | 44 | This setup assumes that [Cloudflare](https://www.cloudflare.com/) is the DNS provider for your domain. 45 | 46 | ### Environment Variables 47 | 48 | Add the missing information for the environment variables in the `.env` file: 49 | 50 | ```env 51 | CLOUDFLARE_TUNNEL_TOKEN='' 52 | ``` 53 | 54 | - `CLOUDFLARE_TUNNEL_TOKEN`: This token is provided by Cloudflare when you create a new tunnel. Replace `''` with your actual token. 55 | 56 | #### How to Obtain the Cloudflare Tunnel Token 57 | 58 | To get the Cloudflare Tunnel token, follow these steps: 59 | 60 | 1. Log in to your [Cloudflare Dashboard](https://dash.cloudflare.com/). 61 | 2. Navigate to the **Zero Trust** section or **Access** section (depending on the Cloudflare interface). 62 | 3. Select **Tunnels** from the navigation menu. 63 | 4. Click on **Create a Tunnel**. 64 | 5. Follow the on-screen instructions to name your tunnel and select your desired configuration. 65 | 6. Once the tunnel is created, Cloudflare will provide a **Tunnel Token**. Copy this token and paste it into the `.env` file under `CLOUDFLARE_TUNNEL_TOKEN`. 66 | 67 | Make sure to edit the `.env` file and add your specific token: 68 | 69 | ```bash 70 | nano .env 71 | ``` 72 | 73 | To prevent `.env` from being tracked by version control, run the following command: 74 | 75 | ```bash 76 | git update-index --assume-unchanged .env 77 | ``` 78 | 79 | ### Hosts Configuration 80 | 81 | Modify the `hosts` file if needed to define any custom hostname mappings: 82 | 83 | ```bash 84 | nano config/hosts 85 | ``` 86 | 87 | Add any additional hosts that need to be mapped within the container. To avoid tracking changes to this file, run: 88 | 89 | ```bash 90 | git update-index --assume-unchanged config/hosts 91 | ``` 92 | 93 | ## Usage 94 | 95 | ### Starting the Container 96 | 97 | To start the Cloudflare Tunnel container, run: 98 | 99 | ```bash 100 | docker compose up -d 101 | ``` 102 | 103 | This command will start the container in detached mode. 104 | 105 | ### Stopping the Container 106 | 107 | To stop the running container, use: 108 | 109 | ```bash 110 | docker compose down 111 | ``` 112 | 113 | ### Viewing Logs 114 | 115 | To view the logs for the running container, which can help with troubleshooting: 116 | 117 | ```bash 118 | docker logs cloudflare-tunnel 119 | ``` 120 | 121 | ### Cleanup 122 | 123 | If you want to remove all containers, networks, and associated volumes: 124 | 125 | ```bash 126 | docker compose down --volumes --remove-orphans 127 | ``` 128 | 129 | ## Real-World Examples 130 | 131 | If you're looking for a step-by-step guide on how to use Cloudflare Tunnel in a real-world scenario, check out these blog posts: 132 | 133 | ### Example 1: Hosting a Webpage with Apache and Docker 134 | 135 | By [John Wuller (@2br-2b)](https://github.com/2br-2b): 136 | 137 | [**How to Host a Webpage Locally Using Cloudflare Tunnels, Apache, and Docker**](https://codegito.xyz/2024/12/01/cloudflare-apache-docker/) 138 | 139 | In this tutorial, John demonstrates based on this repository: 140 | 141 | - Setting up a local webpage with Apache and Docker. 142 | - Configuring a Cloudflare Tunnel to securely expose the webpage to the internet without requiring port forwarding. 143 | 144 | ### Example 2: Secure Self-Hosting with Cloudflare Zero Trust Tunnels 145 | 146 | By [Sven van Ginkel](https://medium.com/@svenvanginkel): 147 | 148 | [**Self-Hosting Securely with Cloudflare Zero Trust Tunnels**](https://medium.com/@svenvanginkel/self-hosting-securely-with-cloudflare-zero-trust-tunnels-0a9169378f78) 149 | 150 | In this guide, Sven explains the fundamental concepts of Cloudflare Zero Trust Tunnels and provides an in-depth walkthrough of the setup process on Cloudflare’s side. While his Docker Compose configuration is not based on this repository, the core principles remain similar. 151 | 152 | ## Security Notes 153 | 154 | - **Environment Variables**: Ensure that `.env` files are not shared or tracked in version control, as they may contain sensitive information such as API tokens or credentials. 155 | - **Sensitive Files**: Always keep sensitive files like `.env` secure and ensure they are not exposed publicly. 156 | 157 | ## License 158 | 159 | This project is licensed under the [**GNU Lesser General Public License v3.0**](https://www.gnu.org/licenses/lgpl-3.0.html) (LGPLv3). 160 | It is distributed "as is", without warranty of any kind. 161 | You are free to use, modify, and distribute this software under the terms specified in the LGPLv3. 162 | 163 | See the [LICENSE](./LICENSE) file for more detailed information. 164 | 165 | ## Additional Resources 166 | 167 | - [Cloudflare Tunnel Documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/): Learn more about how Cloudflare Tunnel works and its various use cases. 168 | - [Docker Documentation](https://docs.docker.com/): Official Docker documentation for commands and features used in this setup. 169 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Created by https://www.toptal.com/developers/gitignore/api/linux,macos,windows,visualstudio,jetbrains+all,visualstudiocode 2 | # Edit at https://www.toptal.com/developers/gitignore?templates=linux,macos,windows,visualstudio,jetbrains+all,visualstudiocode 3 | 4 | ### JetBrains+all ### 5 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 6 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 7 | 8 | # User-specific stuff 9 | .idea/**/workspace.xml 10 | .idea/**/tasks.xml 11 | .idea/**/usage.statistics.xml 12 | .idea/**/dictionaries 13 | .idea/**/shelf 14 | 15 | # AWS User-specific 16 | .idea/**/aws.xml 17 | 18 | # Generated files 19 | .idea/**/contentModel.xml 20 | 21 | # Sensitive or high-churn files 22 | .idea/**/dataSources/ 23 | .idea/**/dataSources.ids 24 | .idea/**/dataSources.local.xml 25 | .idea/**/sqlDataSources.xml 26 | .idea/**/dynamic.xml 27 | .idea/**/uiDesigner.xml 28 | .idea/**/dbnavigator.xml 29 | 30 | # Gradle 31 | .idea/**/gradle.xml 32 | .idea/**/libraries 33 | 34 | # Gradle and Maven with auto-import 35 | # When using Gradle or Maven with auto-import, you should exclude module files, 36 | # since they will be recreated, and may cause churn. Uncomment if using 37 | # auto-import. 38 | # .idea/artifacts 39 | # .idea/compiler.xml 40 | # .idea/jarRepositories.xml 41 | # .idea/modules.xml 42 | # .idea/*.iml 43 | # .idea/modules 44 | # *.iml 45 | # *.ipr 46 | 47 | # CMake 48 | cmake-build-*/ 49 | 50 | # Mongo Explorer plugin 51 | .idea/**/mongoSettings.xml 52 | 53 | # File-based project format 54 | *.iws 55 | 56 | # IntelliJ 57 | out/ 58 | 59 | # mpeltonen/sbt-idea plugin 60 | .idea_modules/ 61 | 62 | # JIRA plugin 63 | atlassian-ide-plugin.xml 64 | 65 | # Cursive Clojure plugin 66 | .idea/replstate.xml 67 | 68 | # SonarLint plugin 69 | .idea/sonarlint/ 70 | 71 | # Crashlytics plugin (for Android Studio and IntelliJ) 72 | com_crashlytics_export_strings.xml 73 | crashlytics.properties 74 | crashlytics-build.properties 75 | fabric.properties 76 | 77 | # Editor-based Rest Client 78 | .idea/httpRequests 79 | 80 | # Android studio 3.1+ serialized cache file 81 | .idea/caches/build_file_checksums.ser 82 | 83 | ### JetBrains+all Patch ### 84 | # Ignore everything but code style settings and run configurations 85 | # that are supposed to be shared within teams. 86 | 87 | .idea/* 88 | 89 | !.idea/codeStyles 90 | !.idea/runConfigurations 91 | 92 | ### Linux ### 93 | *~ 94 | 95 | # temporary files which can be created if a process still has a handle open of a deleted file 96 | .fuse_hidden* 97 | 98 | # KDE directory preferences 99 | .directory 100 | 101 | # Linux trash folder which might appear on any partition or disk 102 | .Trash-* 103 | 104 | # .nfs files are created when an open file is removed but is still being accessed 105 | .nfs* 106 | 107 | ### macOS ### 108 | # General 109 | .DS_Store 110 | .AppleDouble 111 | .LSOverride 112 | 113 | # Icon must end with two \r 114 | Icon 115 | 116 | 117 | # Thumbnails 118 | ._* 119 | 120 | # Files that might appear in the root of a volume 121 | .DocumentRevisions-V100 122 | .fseventsd 123 | .Spotlight-V100 124 | .TemporaryItems 125 | .Trashes 126 | .VolumeIcon.icns 127 | .com.apple.timemachine.donotpresent 128 | 129 | # Directories potentially created on remote AFP share 130 | .AppleDB 131 | .AppleDesktop 132 | Network Trash Folder 133 | Temporary Items 134 | .apdisk 135 | 136 | ### macOS Patch ### 137 | # iCloud generated files 138 | *.icloud 139 | 140 | ### VisualStudioCode ### 141 | .vscode/* 142 | !.vscode/settings.json 143 | !.vscode/tasks.json 144 | !.vscode/launch.json 145 | !.vscode/extensions.json 146 | !.vscode/*.code-snippets 147 | 148 | # Local History for Visual Studio Code 149 | .history/ 150 | 151 | # Built Visual Studio Code Extensions 152 | *.vsix 153 | 154 | ### VisualStudioCode Patch ### 155 | # Ignore all local history of files 156 | .history 157 | .ionide 158 | 159 | ### Windows ### 160 | # Windows thumbnail cache files 161 | Thumbs.db 162 | Thumbs.db:encryptable 163 | ehthumbs.db 164 | ehthumbs_vista.db 165 | 166 | # Dump file 167 | *.stackdump 168 | 169 | # Folder config file 170 | [Dd]esktop.ini 171 | 172 | # Recycle Bin used on file shares 173 | $RECYCLE.BIN/ 174 | 175 | # Windows Installer files 176 | *.cab 177 | *.msi 178 | *.msix 179 | *.msm 180 | *.msp 181 | 182 | # Windows shortcuts 183 | *.lnk 184 | 185 | ### VisualStudio ### 186 | ## Ignore Visual Studio temporary files, build results, and 187 | ## files generated by popular Visual Studio add-ons. 188 | ## 189 | ## Get latest from https://github.com/github/gitignore/blob/main/VisualStudio.gitignore 190 | 191 | # User-specific files 192 | *.rsuser 193 | *.suo 194 | *.user 195 | *.userosscache 196 | *.sln.docstates 197 | 198 | # User-specific files (MonoDevelop/Xamarin Studio) 199 | *.userprefs 200 | 201 | # Mono auto generated files 202 | mono_crash.* 203 | 204 | # Build results 205 | [Dd]ebug/ 206 | [Dd]ebugPublic/ 207 | [Rr]elease/ 208 | [Rr]eleases/ 209 | x64/ 210 | x86/ 211 | [Ww][Ii][Nn]32/ 212 | [Aa][Rr][Mm]/ 213 | [Aa][Rr][Mm]64/ 214 | bld/ 215 | [Bb]in/ 216 | [Oo]bj/ 217 | [Ll]og/ 218 | [Ll]ogs/ 219 | 220 | # Visual Studio 2015/2017 cache/options directory 221 | .vs/ 222 | # Uncomment if you have tasks that create the project's static files in wwwroot 223 | #wwwroot/ 224 | 225 | # Visual Studio 2017 auto generated files 226 | Generated\ Files/ 227 | 228 | # MSTest test Results 229 | [Tt]est[Rr]esult*/ 230 | [Bb]uild[Ll]og.* 231 | 232 | # NUnit 233 | *.VisualState.xml 234 | TestResult.xml 235 | nunit-*.xml 236 | 237 | # Build Results of an ATL Project 238 | [Dd]ebugPS/ 239 | [Rr]eleasePS/ 240 | dlldata.c 241 | 242 | # Benchmark Results 243 | BenchmarkDotNet.Artifacts/ 244 | 245 | # .NET Core 246 | project.lock.json 247 | project.fragment.lock.json 248 | artifacts/ 249 | 250 | # ASP.NET Scaffolding 251 | ScaffoldingReadMe.txt 252 | 253 | # StyleCop 254 | StyleCopReport.xml 255 | 256 | # Files built by Visual Studio 257 | *_i.c 258 | *_p.c 259 | *_h.h 260 | *.ilk 261 | *.meta 262 | *.obj 263 | *.iobj 264 | *.pch 265 | *.pdb 266 | *.ipdb 267 | *.pgc 268 | *.pgd 269 | *.rsp 270 | *.sbr 271 | *.tlb 272 | *.tli 273 | *.tlh 274 | *.tmp 275 | *.tmp_proj 276 | *_wpftmp.csproj 277 | *.log 278 | *.tlog 279 | *.vspscc 280 | *.vssscc 281 | .builds 282 | *.pidb 283 | *.svclog 284 | *.scc 285 | 286 | # Chutzpah Test files 287 | _Chutzpah* 288 | 289 | # Visual C++ cache files 290 | ipch/ 291 | *.aps 292 | *.ncb 293 | *.opendb 294 | *.opensdf 295 | *.sdf 296 | *.cachefile 297 | *.VC.db 298 | *.VC.VC.opendb 299 | 300 | # Visual Studio profiler 301 | *.psess 302 | *.vsp 303 | *.vspx 304 | *.sap 305 | 306 | # Visual Studio Trace Files 307 | *.e2e 308 | 309 | # TFS 2012 Local Workspace 310 | $tf/ 311 | 312 | # Guidance Automation Toolkit 313 | *.gpState 314 | 315 | # ReSharper is a .NET coding add-in 316 | _ReSharper*/ 317 | *.[Rr]e[Ss]harper 318 | *.DotSettings.user 319 | 320 | # TeamCity is a build add-in 321 | _TeamCity* 322 | 323 | # DotCover is a Code Coverage Tool 324 | *.dotCover 325 | 326 | # AxoCover is a Code Coverage Tool 327 | .axoCover/* 328 | !.axoCover/settings.json 329 | 330 | # Coverlet is a free, cross platform Code Coverage Tool 331 | coverage*.json 332 | coverage*.xml 333 | coverage*.info 334 | 335 | # Visual Studio code coverage results 336 | *.coverage 337 | *.coveragexml 338 | 339 | # NCrunch 340 | _NCrunch_* 341 | .*crunch*.local.xml 342 | nCrunchTemp_* 343 | 344 | # MightyMoose 345 | *.mm.* 346 | AutoTest.Net/ 347 | 348 | # Web workbench (sass) 349 | .sass-cache/ 350 | 351 | # Installshield output folder 352 | [Ee]xpress/ 353 | 354 | # DocProject is a documentation generator add-in 355 | DocProject/buildhelp/ 356 | DocProject/Help/*.HxT 357 | DocProject/Help/*.HxC 358 | DocProject/Help/*.hhc 359 | DocProject/Help/*.hhk 360 | DocProject/Help/*.hhp 361 | DocProject/Help/Html2 362 | DocProject/Help/html 363 | 364 | # Click-Once directory 365 | publish/ 366 | 367 | # Publish Web Output 368 | *.[Pp]ublish.xml 369 | *.azurePubxml 370 | # Note: Comment the next line if you want to checkin your web deploy settings, 371 | # but database connection strings (with potential passwords) will be unencrypted 372 | *.pubxml 373 | *.publishproj 374 | 375 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 376 | # checkin your Azure Web App publish settings, but sensitive information contained 377 | # in these scripts will be unencrypted 378 | PublishScripts/ 379 | 380 | # NuGet Packages 381 | *.nupkg 382 | # NuGet Symbol Packages 383 | *.snupkg 384 | # The packages folder can be ignored because of Package Restore 385 | **/[Pp]ackages/* 386 | # except build/, which is used as an MSBuild target. 387 | !**/[Pp]ackages/build/ 388 | # Uncomment if necessary however generally it will be regenerated when needed 389 | #!**/[Pp]ackages/repositories.config 390 | # NuGet v3's project.json files produces more ignorable files 391 | *.nuget.props 392 | *.nuget.targets 393 | 394 | # Microsoft Azure Build Output 395 | csx/ 396 | *.build.csdef 397 | 398 | # Microsoft Azure Emulator 399 | ecf/ 400 | rcf/ 401 | 402 | # Windows Store app package directories and files 403 | AppPackages/ 404 | BundleArtifacts/ 405 | Package.StoreAssociation.xml 406 | _pkginfo.txt 407 | *.appx 408 | *.appxbundle 409 | *.appxupload 410 | 411 | # Visual Studio cache files 412 | # files ending in .cache can be ignored 413 | *.[Cc]ache 414 | # but keep track of directories ending in .cache 415 | !?*.[Cc]ache/ 416 | 417 | # Others 418 | ClientBin/ 419 | ~$* 420 | *.dbmdl 421 | *.dbproj.schemaview 422 | *.jfm 423 | *.pfx 424 | *.publishsettings 425 | orleans.codegen.cs 426 | 427 | # Including strong name files can present a security risk 428 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 429 | #*.snk 430 | 431 | # Since there are multiple workflows, uncomment next line to ignore bower_components 432 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 433 | #bower_components/ 434 | 435 | # RIA/Silverlight projects 436 | Generated_Code/ 437 | 438 | # Backup & report files from converting an old project file 439 | # to a newer Visual Studio version. Backup files are not needed, 440 | # because we have git ;-) 441 | _UpgradeReport_Files/ 442 | Backup*/ 443 | UpgradeLog*.XML 444 | UpgradeLog*.htm 445 | ServiceFabricBackup/ 446 | *.rptproj.bak 447 | 448 | # SQL Server files 449 | *.mdf 450 | *.ldf 451 | *.ndf 452 | 453 | # Business Intelligence projects 454 | *.rdl.data 455 | *.bim.layout 456 | *.bim_*.settings 457 | *.rptproj.rsuser 458 | *- [Bb]ackup.rdl 459 | *- [Bb]ackup ([0-9]).rdl 460 | *- [Bb]ackup ([0-9][0-9]).rdl 461 | 462 | # Microsoft Fakes 463 | FakesAssemblies/ 464 | 465 | # GhostDoc plugin setting file 466 | *.GhostDoc.xml 467 | 468 | # Node.js Tools for Visual Studio 469 | .ntvs_analysis.dat 470 | node_modules/ 471 | 472 | # Visual Studio 6 build log 473 | *.plg 474 | 475 | # Visual Studio 6 workspace options file 476 | *.opt 477 | 478 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 479 | *.vbw 480 | 481 | # Visual Studio 6 auto-generated project file (contains which files were open etc.) 482 | *.vbp 483 | 484 | # Visual Studio 6 workspace and project file (working project files containing files to include in project) 485 | *.dsw 486 | *.dsp 487 | 488 | # Visual Studio 6 technical files 489 | 490 | # Visual Studio LightSwitch build output 491 | **/*.HTMLClient/GeneratedArtifacts 492 | **/*.DesktopClient/GeneratedArtifacts 493 | **/*.DesktopClient/ModelManifest.xml 494 | **/*.Server/GeneratedArtifacts 495 | **/*.Server/ModelManifest.xml 496 | _Pvt_Extensions 497 | 498 | # Paket dependency manager 499 | .paket/paket.exe 500 | paket-files/ 501 | 502 | # FAKE - F# Make 503 | .fake/ 504 | 505 | # CodeRush personal settings 506 | .cr/personal 507 | 508 | # Python Tools for Visual Studio (PTVS) 509 | __pycache__/ 510 | *.pyc 511 | 512 | # Cake - Uncomment if you are using it 513 | # tools/** 514 | # !tools/packages.config 515 | 516 | # Tabs Studio 517 | *.tss 518 | 519 | # Telerik's JustMock configuration file 520 | *.jmconfig 521 | 522 | # BizTalk build output 523 | *.btp.cs 524 | *.btm.cs 525 | *.odx.cs 526 | *.xsd.cs 527 | 528 | # OpenCover UI analysis results 529 | OpenCover/ 530 | 531 | # Azure Stream Analytics local run output 532 | ASALocalRun/ 533 | 534 | # MSBuild Binary and Structured Log 535 | *.binlog 536 | 537 | # NVidia Nsight GPU debugger configuration file 538 | *.nvuser 539 | 540 | # MFractors (Xamarin productivity tool) working folder 541 | .mfractor/ 542 | 543 | # Local History for Visual Studio 544 | .localhistory/ 545 | 546 | # Visual Studio History (VSHistory) files 547 | .vshistory/ 548 | 549 | # BeatPulse healthcheck temp database 550 | healthchecksdb 551 | 552 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 553 | MigrationBackup/ 554 | 555 | # Ionide (cross platform F# VS Code tools) working folder 556 | .ionide/ 557 | 558 | # Fody - auto-generated XML schema 559 | FodyWeavers.xsd 560 | 561 | # VS Code files for those working on multiple tools 562 | *.code-workspace 563 | 564 | # Local History for Visual Studio Code 565 | 566 | # Windows Installer files from build outputs 567 | 568 | # JetBrains Rider 569 | *.sln.iml 570 | 571 | ### VisualStudio Patch ### 572 | # Additional files built by Visual Studio 573 | 574 | # End of https://www.toptal.com/developers/gitignore/api/linux,macos,windows,visualstudio,jetbrains+all,visualstudiocode 575 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU LESSER 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 | 9 | This version of the GNU Lesser General Public License incorporates 10 | the terms and conditions of version 3 of the GNU General Public 11 | License, supplemented by the additional permissions listed below. 12 | 13 | 0. Additional Definitions. 14 | 15 | As used herein, "this License" refers to version 3 of the GNU Lesser 16 | General Public License, and the "GNU GPL" refers to version 3 of the GNU 17 | General Public License. 18 | 19 | "The Library" refers to a covered work governed by this License, 20 | other than an Application or a Combined Work as defined below. 21 | 22 | An "Application" is any work that makes use of an interface provided 23 | by the Library, but which is not otherwise based on the Library. 24 | Defining a subclass of a class defined by the Library is deemed a mode 25 | of using an interface provided by the Library. 26 | 27 | A "Combined Work" is a work produced by combining or linking an 28 | Application with the Library. The particular version of the Library 29 | with which the Combined Work was made is also called the "Linked 30 | Version". 31 | 32 | The "Minimal Corresponding Source" for a Combined Work means the 33 | Corresponding Source for the Combined Work, excluding any source code 34 | for portions of the Combined Work that, considered in isolation, are 35 | based on the Application, and not on the Linked Version. 36 | 37 | The "Corresponding Application Code" for a Combined Work means the 38 | object code and/or source code for the Application, including any data 39 | and utility programs needed for reproducing the Combined Work from the 40 | Application, but excluding the System Libraries of the Combined Work. 41 | 42 | 1. Exception to Section 3 of the GNU GPL. 43 | 44 | You may convey a covered work under sections 3 and 4 of this License 45 | without being bound by section 3 of the GNU GPL. 46 | 47 | 2. Conveying Modified Versions. 48 | 49 | If you modify a copy of the Library, and, in your modifications, a 50 | facility refers to a function or data to be supplied by an Application 51 | that uses the facility (other than as an argument passed when the 52 | facility is invoked), then you may convey a copy of the modified 53 | version: 54 | 55 | a) under this License, provided that you make a good faith effort to 56 | ensure that, in the event an Application does not supply the 57 | function or data, the facility still operates, and performs 58 | whatever part of its purpose remains meaningful, or 59 | 60 | b) under the GNU GPL, with none of the additional permissions of 61 | this License applicable to that copy. 62 | 63 | 3. Object Code Incorporating Material from Library Header Files. 64 | 65 | The object code form of an Application may incorporate material from 66 | a header file that is part of the Library. You may convey such object 67 | code under terms of your choice, provided that, if the incorporated 68 | material is not limited to numerical parameters, data structure 69 | layouts and accessors, or small macros, inline functions and templates 70 | (ten or fewer lines in length), you do both of the following: 71 | 72 | a) Give prominent notice with each copy of the object code that the 73 | Library is used in it and that the Library and its use are 74 | covered by this License. 75 | 76 | b) Accompany the object code with a copy of the GNU GPL and this license 77 | document. 78 | 79 | 4. Combined Works. 80 | 81 | You may convey a Combined Work under terms of your choice that, 82 | taken together, effectively do not restrict modification of the 83 | portions of the Library contained in the Combined Work and reverse 84 | engineering for debugging such modifications, if you also do each of 85 | the following: 86 | 87 | a) Give prominent notice with each copy of the Combined Work that 88 | the Library is used in it and that the Library and its use are 89 | covered by this License. 90 | 91 | b) Accompany the Combined Work with a copy of the GNU GPL and this license 92 | document. 93 | 94 | c) For a Combined Work that displays copyright notices during 95 | execution, include the copyright notice for the Library among 96 | these notices, as well as a reference directing the user to the 97 | copies of the GNU GPL and this license document. 98 | 99 | d) Do one of the following: 100 | 101 | 0) Convey the Minimal Corresponding Source under the terms of this 102 | License, and the Corresponding Application Code in a form 103 | suitable for, and under terms that permit, the user to 104 | recombine or relink the Application with a modified version of 105 | the Linked Version to produce a modified Combined Work, in the 106 | manner specified by section 6 of the GNU GPL for conveying 107 | Corresponding Source. 108 | 109 | 1) Use a suitable shared library mechanism for linking with the 110 | Library. A suitable mechanism is one that (a) uses at run time 111 | a copy of the Library already present on the user's computer 112 | system, and (b) will operate properly with a modified version 113 | of the Library that is interface-compatible with the Linked 114 | Version. 115 | 116 | e) Provide Installation Information, but only if you would otherwise 117 | be required to provide such information under section 6 of the 118 | GNU GPL, and only to the extent that such information is 119 | necessary to install and execute a modified version of the 120 | Combined Work produced by recombining or relinking the 121 | Application with a modified version of the Linked Version. (If 122 | you use option 4d0, the Installation Information must accompany 123 | the Minimal Corresponding Source and Corresponding Application 124 | Code. If you use option 4d1, you must provide the Installation 125 | Information in the manner specified by section 6 of the GNU GPL 126 | for conveying Corresponding Source.) 127 | 128 | 5. Combined Libraries. 129 | 130 | You may place library facilities that are a work based on the 131 | Library side by side in a single library together with other library 132 | facilities that are not Applications and are not covered by this 133 | License, and convey such a combined library under terms of your 134 | choice, if you do both of the following: 135 | 136 | a) Accompany the combined library with a copy of the same work based 137 | on the Library, uncombined with any other library facilities, 138 | conveyed under the terms of this License. 139 | 140 | b) Give prominent notice with the combined library that part of it 141 | is a work based on the Library, and explaining where to find the 142 | accompanying uncombined form of the same work. 143 | 144 | 6. Revised Versions of the GNU Lesser General Public License. 145 | 146 | The Free Software Foundation may publish revised and/or new versions 147 | of the GNU Lesser General Public License from time to time. Such new 148 | versions will be similar in spirit to the present version, but may 149 | differ in detail to address new problems or concerns. 150 | 151 | Each version is given a distinguishing version number. If the 152 | Library as you received it specifies that a certain numbered version 153 | of the GNU Lesser General Public License "or any later version" 154 | applies to it, you have the option of following the terms and 155 | conditions either of that published version or of any later version 156 | published by the Free Software Foundation. If the Library as you 157 | received it does not specify a version number of the GNU Lesser 158 | General Public License, you may choose any version of the GNU Lesser 159 | General Public License ever published by the Free Software Foundation. 160 | 161 | If the Library as you received it specifies that a proxy can decide 162 | whether future versions of the GNU Lesser General Public License shall 163 | apply, that proxy's public statement of acceptance of any version is 164 | permanent authorization for you to choose that version for the 165 | Library. 166 | 167 | GNU GENERAL PUBLIC LICENSE 168 | Version 3, 29 June 2007 169 | 170 | Copyright (C) 2007 Free Software Foundation, Inc. 171 | Everyone is permitted to copy and distribute verbatim copies 172 | of this license document, but changing it is not allowed. 173 | 174 | Preamble 175 | 176 | The GNU General Public License is a free, copyleft license for 177 | software and other kinds of works. 178 | 179 | The licenses for most software and other practical works are designed 180 | to take away your freedom to share and change the works. By contrast, 181 | the GNU General Public License is intended to guarantee your freedom to 182 | share and change all versions of a program--to make sure it remains free 183 | software for all its users. We, the Free Software Foundation, use the 184 | GNU General Public License for most of our software; it applies also to 185 | any other work released this way by its authors. You can apply it to 186 | your programs, too. 187 | 188 | When we speak of free software, we are referring to freedom, not 189 | price. Our General Public Licenses are designed to make sure that you 190 | have the freedom to distribute copies of free software (and charge for 191 | them if you wish), that you receive source code or can get it if you 192 | want it, that you can change the software or use pieces of it in new 193 | free programs, and that you know you can do these things. 194 | 195 | To protect your rights, we need to prevent others from denying you 196 | these rights or asking you to surrender the rights. Therefore, you have 197 | certain responsibilities if you distribute copies of the software, or if 198 | you modify it: responsibilities to respect the freedom of others. 199 | 200 | For example, if you distribute copies of such a program, whether 201 | gratis or for a fee, you must pass on to the recipients the same 202 | freedoms that you received. You must make sure that they, too, receive 203 | or can get the source code. And you must show them these terms so they 204 | know their rights. 205 | 206 | Developers that use the GNU GPL protect your rights with two steps: 207 | (1) assert copyright on the software, and (2) offer you this License 208 | giving you legal permission to copy, distribute and/or modify it. 209 | 210 | For the developers' and authors' protection, the GPL clearly explains 211 | that there is no warranty for this free software. For both users' and 212 | authors' sake, the GPL requires that modified versions be marked as 213 | changed, so that their problems will not be attributed erroneously to 214 | authors of previous versions. 215 | 216 | Some devices are designed to deny users access to install or run 217 | modified versions of the software inside them, although the manufacturer 218 | can do so. This is fundamentally incompatible with the aim of 219 | protecting users' freedom to change the software. The systematic 220 | pattern of such abuse occurs in the area of products for individuals to 221 | use, which is precisely where it is most unacceptable. Therefore, we 222 | have designed this version of the GPL to prohibit the practice for those 223 | products. If such problems arise substantially in other domains, we 224 | stand ready to extend this provision to those domains in future versions 225 | of the GPL, as needed to protect the freedom of users. 226 | 227 | Finally, every program is threatened constantly by software patents. 228 | States should not allow patents to restrict development and use of 229 | software on general-purpose computers, but in those that do, we wish to 230 | avoid the special danger that patents applied to a free program could 231 | make it effectively proprietary. To prevent this, the GPL assures that 232 | patents cannot be used to render the program non-free. 233 | 234 | The precise terms and conditions for copying, distribution and 235 | modification follow. 236 | 237 | TERMS AND CONDITIONS 238 | 239 | 0. Definitions. 240 | 241 | "This License" refers to version 3 of the GNU General Public License. 242 | 243 | "Copyright" also means copyright-like laws that apply to other kinds of 244 | works, such as semiconductor masks. 245 | 246 | "The Program" refers to any copyrightable work licensed under this 247 | License. Each licensee is addressed as "you". "Licensees" and 248 | "recipients" may be individuals or organizations. 249 | 250 | To "modify" a work means to copy from or adapt all or part of the work 251 | in a fashion requiring copyright permission, other than the making of an 252 | exact copy. The resulting work is called a "modified version" of the 253 | earlier work or a work "based on" the earlier work. 254 | 255 | A "covered work" means either the unmodified Program or a work based 256 | on the Program. 257 | 258 | To "propagate" a work means to do anything with it that, without 259 | permission, would make you directly or secondarily liable for 260 | infringement under applicable copyright law, except executing it on a 261 | computer or modifying a private copy. Propagation includes copying, 262 | distribution (with or without modification), making available to the 263 | public, and in some countries other activities as well. 264 | 265 | To "convey" a work means any kind of propagation that enables other 266 | parties to make or receive copies. Mere interaction with a user through 267 | a computer network, with no transfer of a copy, is not conveying. 268 | 269 | An interactive user interface displays "Appropriate Legal Notices" 270 | to the extent that it includes a convenient and prominently visible 271 | feature that (1) displays an appropriate copyright notice, and (2) 272 | tells the user that there is no warranty for the work (except to the 273 | extent that warranties are provided), that licensees may convey the 274 | work under this License, and how to view a copy of this License. If 275 | the interface presents a list of user commands or options, such as a 276 | menu, a prominent item in the list meets this criterion. 277 | 278 | 1. Source Code. 279 | 280 | The "source code" for a work means the preferred form of the work 281 | for making modifications to it. "Object code" means any non-source 282 | form of a work. 283 | 284 | A "Standard Interface" means an interface that either is an official 285 | standard defined by a recognized standards body, or, in the case of 286 | interfaces specified for a particular programming language, one that 287 | is widely used among developers working in that language. 288 | 289 | The "System Libraries" of an executable work include anything, other 290 | than the work as a whole, that (a) is included in the normal form of 291 | packaging a Major Component, but which is not part of that Major 292 | Component, and (b) serves only to enable use of the work with that 293 | Major Component, or to implement a Standard Interface for which an 294 | implementation is available to the public in source code form. A 295 | "Major Component", in this context, means a major essential component 296 | (kernel, window system, and so on) of the specific operating system 297 | (if any) on which the executable work runs, or a compiler used to 298 | produce the work, or an object code interpreter used to run it. 299 | 300 | The "Corresponding Source" for a work in object code form means all 301 | the source code needed to generate, install, and (for an executable 302 | work) run the object code and to modify the work, including scripts to 303 | control those activities. However, it does not include the work's 304 | System Libraries, or general-purpose tools or generally available free 305 | programs which are used unmodified in performing those activities but 306 | which are not part of the work. For example, Corresponding Source 307 | includes interface definition files associated with source files for 308 | the work, and the source code for shared libraries and dynamically 309 | linked subprograms that the work is specifically designed to require, 310 | such as by intimate data communication or control flow between those 311 | subprograms and other parts of the work. 312 | 313 | The Corresponding Source need not include anything that users 314 | can regenerate automatically from other parts of the Corresponding 315 | Source. 316 | 317 | The Corresponding Source for a work in source code form is that 318 | same work. 319 | 320 | 2. Basic Permissions. 321 | 322 | All rights granted under this License are granted for the term of 323 | copyright on the Program, and are irrevocable provided the stated 324 | conditions are met. This License explicitly affirms your unlimited 325 | permission to run the unmodified Program. The output from running a 326 | covered work is covered by this License only if the output, given its 327 | content, constitutes a covered work. This License acknowledges your 328 | rights of fair use or other equivalent, as provided by copyright law. 329 | 330 | You may make, run and propagate covered works that you do not 331 | convey, without conditions so long as your license otherwise remains 332 | in force. You may convey covered works to others for the sole purpose 333 | of having them make modifications exclusively for you, or provide you 334 | with facilities for running those works, provided that you comply with 335 | the terms of this License in conveying all material for which you do 336 | not control copyright. Those thus making or running the covered works 337 | for you must do so exclusively on your behalf, under your direction 338 | and control, on terms that prohibit them from making any copies of 339 | your copyrighted material outside their relationship with you. 340 | 341 | Conveying under any other circumstances is permitted solely under 342 | the conditions stated below. Sublicensing is not allowed; section 10 343 | makes it unnecessary. 344 | 345 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 346 | 347 | No covered work shall be deemed part of an effective technological 348 | measure under any applicable law fulfilling obligations under article 349 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 350 | similar laws prohibiting or restricting circumvention of such 351 | measures. 352 | 353 | When you convey a covered work, you waive any legal power to forbid 354 | circumvention of technological measures to the extent such circumvention 355 | is effected by exercising rights under this License with respect to 356 | the covered work, and you disclaim any intention to limit operation or 357 | modification of the work as a means of enforcing, against the work's 358 | users, your or third parties' legal rights to forbid circumvention of 359 | technological measures. 360 | 361 | 4. Conveying Verbatim Copies. 362 | 363 | You may convey verbatim copies of the Program's source code as you 364 | receive it, in any medium, provided that you conspicuously and 365 | appropriately publish on each copy an appropriate copyright notice; 366 | keep intact all notices stating that this License and any 367 | non-permissive terms added in accord with section 7 apply to the code; 368 | keep intact all notices of the absence of any warranty; and give all 369 | recipients a copy of this License along with the Program. 370 | 371 | You may charge any price or no price for each copy that you convey, 372 | and you may offer support or warranty protection for a fee. 373 | 374 | 5. Conveying Modified Source Versions. 375 | 376 | You may convey a work based on the Program, or the modifications to 377 | produce it from the Program, in the form of source code under the 378 | terms of section 4, provided that you also meet all of these conditions: 379 | 380 | a) The work must carry prominent notices stating that you modified 381 | it, and giving a relevant date. 382 | 383 | b) The work must carry prominent notices stating that it is 384 | released under this License and any conditions added under section 385 | 7. This requirement modifies the requirement in section 4 to 386 | "keep intact all notices". 387 | 388 | c) You must license the entire work, as a whole, under this 389 | License to anyone who comes into possession of a copy. This 390 | License will therefore apply, along with any applicable section 7 391 | additional terms, to the whole of the work, and all its parts, 392 | regardless of how they are packaged. This License gives no 393 | permission to license the work in any other way, but it does not 394 | invalidate such permission if you have separately received it. 395 | 396 | d) If the work has interactive user interfaces, each must display 397 | Appropriate Legal Notices; however, if the Program has interactive 398 | interfaces that do not display Appropriate Legal Notices, your 399 | work need not make them do so. 400 | 401 | A compilation of a covered work with other separate and independent 402 | works, which are not by their nature extensions of the covered work, 403 | and which are not combined with it such as to form a larger program, 404 | in or on a volume of a storage or distribution medium, is called an 405 | "aggregate" if the compilation and its resulting copyright are not 406 | used to limit the access or legal rights of the compilation's users 407 | beyond what the individual works permit. Inclusion of a covered work 408 | in an aggregate does not cause this License to apply to the other 409 | parts of the aggregate. 410 | 411 | 6. Conveying Non-Source Forms. 412 | 413 | You may convey a covered work in object code form under the terms 414 | of sections 4 and 5, provided that you also convey the 415 | machine-readable Corresponding Source under the terms of this License, 416 | in one of these ways: 417 | 418 | a) Convey the object code in, or embodied in, a physical product 419 | (including a physical distribution medium), accompanied by the 420 | Corresponding Source fixed on a durable physical medium 421 | customarily used for software interchange. 422 | 423 | b) Convey the object code in, or embodied in, a physical product 424 | (including a physical distribution medium), accompanied by a 425 | written offer, valid for at least three years and valid for as 426 | long as you offer spare parts or customer support for that product 427 | model, to give anyone who possesses the object code either (1) a 428 | copy of the Corresponding Source for all the software in the 429 | product that is covered by this License, on a durable physical 430 | medium customarily used for software interchange, for a price no 431 | more than your reasonable cost of physically performing this 432 | conveying of source, or (2) access to copy the 433 | Corresponding Source from a network server at no charge. 434 | 435 | c) Convey individual copies of the object code with a copy of the 436 | written offer to provide the Corresponding Source. This 437 | alternative is allowed only occasionally and noncommercially, and 438 | only if you received the object code with such an offer, in accord 439 | with subsection 6b. 440 | 441 | d) Convey the object code by offering access from a designated 442 | place (gratis or for a charge), and offer equivalent access to the 443 | Corresponding Source in the same way through the same place at no 444 | further charge. You need not require recipients to copy the 445 | Corresponding Source along with the object code. If the place to 446 | copy the object code is a network server, the Corresponding Source 447 | may be on a different server (operated by you or a third party) 448 | that supports equivalent copying facilities, provided you maintain 449 | clear directions next to the object code saying where to find the 450 | Corresponding Source. Regardless of what server hosts the 451 | Corresponding Source, you remain obligated to ensure that it is 452 | available for as long as needed to satisfy these requirements. 453 | 454 | e) Convey the object code using peer-to-peer transmission, provided 455 | you inform other peers where the object code and Corresponding 456 | Source of the work are being offered to the general public at no 457 | charge under subsection 6d. 458 | 459 | A separable portion of the object code, whose source code is excluded 460 | from the Corresponding Source as a System Library, need not be 461 | included in conveying the object code work. 462 | 463 | A "User Product" is either (1) a "consumer product", which means any 464 | tangible personal property which is normally used for personal, family, 465 | or household purposes, or (2) anything designed or sold for incorporation 466 | into a dwelling. In determining whether a product is a consumer product, 467 | doubtful cases shall be resolved in favor of coverage. For a particular 468 | product received by a particular user, "normally used" refers to a 469 | typical or common use of that class of product, regardless of the status 470 | of the particular user or of the way in which the particular user 471 | actually uses, or expects or is expected to use, the product. A product 472 | is a consumer product regardless of whether the product has substantial 473 | commercial, industrial or non-consumer uses, unless such uses represent 474 | the only significant mode of use of the product. 475 | 476 | "Installation Information" for a User Product means any methods, 477 | procedures, authorization keys, or other information required to install 478 | and execute modified versions of a covered work in that User Product from 479 | a modified version of its Corresponding Source. The information must 480 | suffice to ensure that the continued functioning of the modified object 481 | code is in no case prevented or interfered with solely because 482 | modification has been made. 483 | 484 | If you convey an object code work under this section in, or with, or 485 | specifically for use in, a User Product, and the conveying occurs as 486 | part of a transaction in which the right of possession and use of the 487 | User Product is transferred to the recipient in perpetuity or for a 488 | fixed term (regardless of how the transaction is characterized), the 489 | Corresponding Source conveyed under this section must be accompanied 490 | by the Installation Information. But this requirement does not apply 491 | if neither you nor any third party retains the ability to install 492 | modified object code on the User Product (for example, the work has 493 | been installed in ROM). 494 | 495 | The requirement to provide Installation Information does not include a 496 | requirement to continue to provide support service, warranty, or updates 497 | for a work that has been modified or installed by the recipient, or for 498 | the User Product in which it has been modified or installed. Access to a 499 | network may be denied when the modification itself materially and 500 | adversely affects the operation of the network or violates the rules and 501 | protocols for communication across the network. 502 | 503 | Corresponding Source conveyed, and Installation Information provided, 504 | in accord with this section must be in a format that is publicly 505 | documented (and with an implementation available to the public in 506 | source code form), and must require no special password or key for 507 | unpacking, reading or copying. 508 | 509 | 7. Additional Terms. 510 | 511 | "Additional permissions" are terms that supplement the terms of this 512 | License by making exceptions from one or more of its conditions. 513 | Additional permissions that are applicable to the entire Program shall 514 | be treated as though they were included in this License, to the extent 515 | that they are valid under applicable law. If additional permissions 516 | apply only to part of the Program, that part may be used separately 517 | under those permissions, but the entire Program remains governed by 518 | this License without regard to the additional permissions. 519 | 520 | When you convey a copy of a covered work, you may at your option 521 | remove any additional permissions from that copy, or from any part of 522 | it. (Additional permissions may be written to require their own 523 | removal in certain cases when you modify the work.) You may place 524 | additional permissions on material, added by you to a covered work, 525 | for which you have or can give appropriate copyright permission. 526 | 527 | Notwithstanding any other provision of this License, for material you 528 | add to a covered work, you may (if authorized by the copyright holders of 529 | that material) supplement the terms of this License with terms: 530 | 531 | a) Disclaiming warranty or limiting liability differently from the 532 | terms of sections 15 and 16 of this License; or 533 | 534 | b) Requiring preservation of specified reasonable legal notices or 535 | author attributions in that material or in the Appropriate Legal 536 | Notices displayed by works containing it; or 537 | 538 | c) Prohibiting misrepresentation of the origin of that material, or 539 | requiring that modified versions of such material be marked in 540 | reasonable ways as different from the original version; or 541 | 542 | d) Limiting the use for publicity purposes of names of licensors or 543 | authors of the material; or 544 | 545 | e) Declining to grant rights under trademark law for use of some 546 | trade names, trademarks, or service marks; or 547 | 548 | f) Requiring indemnification of licensors and authors of that 549 | material by anyone who conveys the material (or modified versions of 550 | it) with contractual assumptions of liability to the recipient, for 551 | any liability that these contractual assumptions directly impose on 552 | those licensors and authors. 553 | 554 | All other non-permissive additional terms are considered "further 555 | restrictions" within the meaning of section 10. If the Program as you 556 | received it, or any part of it, contains a notice stating that it is 557 | governed by this License along with a term that is a further 558 | restriction, you may remove that term. If a license document contains 559 | a further restriction but permits relicensing or conveying under this 560 | License, you may add to a covered work material governed by the terms 561 | of that license document, provided that the further restriction does 562 | not survive such relicensing or conveying. 563 | 564 | If you add terms to a covered work in accord with this section, you 565 | must place, in the relevant source files, a statement of the 566 | additional terms that apply to those files, or a notice indicating 567 | where to find the applicable terms. 568 | 569 | Additional terms, permissive or non-permissive, may be stated in the 570 | form of a separately written license, or stated as exceptions; 571 | the above requirements apply either way. 572 | 573 | 8. Termination. 574 | 575 | You may not propagate or modify a covered work except as expressly 576 | provided under this License. Any attempt otherwise to propagate or 577 | modify it is void, and will automatically terminate your rights under 578 | this License (including any patent licenses granted under the third 579 | paragraph of section 11). 580 | 581 | However, if you cease all violation of this License, then your 582 | license from a particular copyright holder is reinstated (a) 583 | provisionally, unless and until the copyright holder explicitly and 584 | finally terminates your license, and (b) permanently, if the copyright 585 | holder fails to notify you of the violation by some reasonable means 586 | prior to 60 days after the cessation. 587 | 588 | Moreover, your license from a particular copyright holder is 589 | reinstated permanently if the copyright holder notifies you of the 590 | violation by some reasonable means, this is the first time you have 591 | received notice of violation of this License (for any work) from that 592 | copyright holder, and you cure the violation prior to 30 days after 593 | your receipt of the notice. 594 | 595 | Termination of your rights under this section does not terminate the 596 | licenses of parties who have received copies or rights from you under 597 | this License. If your rights have been terminated and not permanently 598 | reinstated, you do not qualify to receive new licenses for the same 599 | material under section 10. 600 | 601 | 9. Acceptance Not Required for Having Copies. 602 | 603 | You are not required to accept this License in order to receive or 604 | run a copy of the Program. Ancillary propagation of a covered work 605 | occurring solely as a consequence of using peer-to-peer transmission 606 | to receive a copy likewise does not require acceptance. However, 607 | nothing other than this License grants you permission to propagate or 608 | modify any covered work. These actions infringe copyright if you do 609 | not accept this License. Therefore, by modifying or propagating a 610 | covered work, you indicate your acceptance of this License to do so. 611 | 612 | 10. Automatic Licensing of Downstream Recipients. 613 | 614 | Each time you convey a covered work, the recipient automatically 615 | receives a license from the original licensors, to run, modify and 616 | propagate that work, subject to this License. You are not responsible 617 | for enforcing compliance by third parties with this License. 618 | 619 | An "entity transaction" is a transaction transferring control of an 620 | organization, or substantially all assets of one, or subdividing an 621 | organization, or merging organizations. If propagation of a covered 622 | work results from an entity transaction, each party to that 623 | transaction who receives a copy of the work also receives whatever 624 | licenses to the work the party's predecessor in interest had or could 625 | give under the previous paragraph, plus a right to possession of the 626 | Corresponding Source of the work from the predecessor in interest, if 627 | the predecessor has it or can get it with reasonable efforts. 628 | 629 | You may not impose any further restrictions on the exercise of the 630 | rights granted or affirmed under this License. For example, you may 631 | not impose a license fee, royalty, or other charge for exercise of 632 | rights granted under this License, and you may not initiate litigation 633 | (including a cross-claim or counterclaim in a lawsuit) alleging that 634 | any patent claim is infringed by making, using, selling, offering for 635 | sale, or importing the Program or any portion of it. 636 | 637 | 11. Patents. 638 | 639 | A "contributor" is a copyright holder who authorizes use under this 640 | License of the Program or a work on which the Program is based. The 641 | work thus licensed is called the contributor's "contributor version". 642 | 643 | A contributor's "essential patent claims" are all patent claims 644 | owned or controlled by the contributor, whether already acquired or 645 | hereafter acquired, that would be infringed by some manner, permitted 646 | by this License, of making, using, or selling its contributor version, 647 | but do not include claims that would be infringed only as a 648 | consequence of further modification of the contributor version. For 649 | purposes of this definition, "control" includes the right to grant 650 | patent sublicenses in a manner consistent with the requirements of 651 | this License. 652 | 653 | Each contributor grants you a non-exclusive, worldwide, royalty-free 654 | patent license under the contributor's essential patent claims, to 655 | make, use, sell, offer for sale, import and otherwise run, modify and 656 | propagate the contents of its contributor version. 657 | 658 | In the following three paragraphs, a "patent license" is any express 659 | agreement or commitment, however denominated, not to enforce a patent 660 | (such as an express permission to practice a patent or covenant not to 661 | sue for patent infringement). To "grant" such a patent license to a 662 | party means to make such an agreement or commitment not to enforce a 663 | patent against the party. 664 | 665 | If you convey a covered work, knowingly relying on a patent license, 666 | and the Corresponding Source of the work is not available for anyone 667 | to copy, free of charge and under the terms of this License, through a 668 | publicly available network server or other readily accessible means, 669 | then you must either (1) cause the Corresponding Source to be so 670 | available, or (2) arrange to deprive yourself of the benefit of the 671 | patent license for this particular work, or (3) arrange, in a manner 672 | consistent with the requirements of this License, to extend the patent 673 | license to downstream recipients. "Knowingly relying" means you have 674 | actual knowledge that, but for the patent license, your conveying the 675 | covered work in a country, or your recipient's use of the covered work 676 | in a country, would infringe one or more identifiable patents in that 677 | country that you have reason to believe are valid. 678 | 679 | If, pursuant to or in connection with a single transaction or 680 | arrangement, you convey, or propagate by procuring conveyance of, a 681 | covered work, and grant a patent license to some of the parties 682 | receiving the covered work authorizing them to use, propagate, modify 683 | or convey a specific copy of the covered work, then the patent license 684 | you grant is automatically extended to all recipients of the covered 685 | work and works based on it. 686 | 687 | A patent license is "discriminatory" if it does not include within 688 | the scope of its coverage, prohibits the exercise of, or is 689 | conditioned on the non-exercise of one or more of the rights that are 690 | specifically granted under this License. You may not convey a covered 691 | work if you are a party to an arrangement with a third party that is 692 | in the business of distributing software, under which you make payment 693 | to the third party based on the extent of your activity of conveying 694 | the work, and under which the third party grants, to any of the 695 | parties who would receive the covered work from you, a discriminatory 696 | patent license (a) in connection with copies of the covered work 697 | conveyed by you (or copies made from those copies), or (b) primarily 698 | for and in connection with specific products or compilations that 699 | contain the covered work, unless you entered into that arrangement, 700 | or that patent license was granted, prior to 28 March 2007. 701 | 702 | Nothing in this License shall be construed as excluding or limiting 703 | any implied license or other defenses to infringement that may 704 | otherwise be available to you under applicable patent law. 705 | 706 | 12. No Surrender of Others' Freedom. 707 | 708 | If conditions are imposed on you (whether by court order, agreement or 709 | otherwise) that contradict the conditions of this License, they do not 710 | excuse you from the conditions of this License. If you cannot convey a 711 | covered work so as to satisfy simultaneously your obligations under this 712 | License and any other pertinent obligations, then as a consequence you may 713 | not convey it at all. For example, if you agree to terms that obligate you 714 | to collect a royalty for further conveying from those to whom you convey 715 | the Program, the only way you could satisfy both those terms and this 716 | License would be to refrain entirely from conveying the Program. 717 | 718 | 13. Use with the GNU Affero General Public License. 719 | 720 | Notwithstanding any other provision of this License, you have 721 | permission to link or combine any covered work with a work licensed 722 | under version 3 of the GNU Affero General Public License into a single 723 | combined work, and to convey the resulting work. The terms of this 724 | License will continue to apply to the part which is the covered work, 725 | but the special requirements of the GNU Affero General Public License, 726 | section 13, concerning interaction through a network will apply to the 727 | combination as such. 728 | 729 | 14. Revised Versions of this License. 730 | 731 | The Free Software Foundation may publish revised and/or new versions of 732 | the GNU General Public License from time to time. Such new versions will 733 | be similar in spirit to the present version, but may differ in detail to 734 | address new problems or concerns. 735 | 736 | Each version is given a distinguishing version number. If the 737 | Program specifies that a certain numbered version of the GNU General 738 | Public License "or any later version" applies to it, you have the 739 | option of following the terms and conditions either of that numbered 740 | version or of any later version published by the Free Software 741 | Foundation. If the Program does not specify a version number of the 742 | GNU General Public License, you may choose any version ever published 743 | by the Free Software Foundation. 744 | 745 | If the Program specifies that a proxy can decide which future 746 | versions of the GNU General Public License can be used, that proxy's 747 | public statement of acceptance of a version permanently authorizes you 748 | to choose that version for the Program. 749 | 750 | Later license versions may give you additional or different 751 | permissions. However, no additional obligations are imposed on any 752 | author or copyright holder as a result of your choosing to follow a 753 | later version. 754 | 755 | 15. Disclaimer of Warranty. 756 | 757 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 758 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 759 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 760 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 761 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 762 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 763 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 764 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 765 | 766 | 16. Limitation of Liability. 767 | 768 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 769 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 770 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 771 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 772 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 773 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 774 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 775 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 776 | SUCH DAMAGES. 777 | 778 | 17. Interpretation of Sections 15 and 16. 779 | 780 | If the disclaimer of warranty and limitation of liability provided 781 | above cannot be given local legal effect according to their terms, 782 | reviewing courts shall apply local law that most closely approximates 783 | an absolute waiver of all civil liability in connection with the 784 | Program, unless a warranty or assumption of liability accompanies a 785 | copy of the Program in return for a fee. 786 | 787 | END OF TERMS AND CONDITIONS 788 | 789 | How to Apply These Terms to Your New Programs 790 | 791 | If you develop a new program, and you want it to be of the greatest 792 | possible use to the public, the best way to achieve this is to make it 793 | free software which everyone can redistribute and change under these terms. 794 | 795 | To do so, attach the following notices to the program. It is safest 796 | to attach them to the start of each source file to most effectively 797 | state the exclusion of warranty; and each file should have at least 798 | the "copyright" line and a pointer to where the full notice is found. 799 | 800 | 801 | Copyright (C) 802 | 803 | This program is free software: you can redistribute it and/or modify 804 | it under the terms of the GNU General Public License as published by 805 | the Free Software Foundation, either version 3 of the License, or 806 | (at your option) any later version. 807 | 808 | This program is distributed in the hope that it will be useful, 809 | but WITHOUT ANY WARRANTY; without even the implied warranty of 810 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 811 | GNU General Public License for more details. 812 | 813 | You should have received a copy of the GNU General Public License 814 | along with this program. If not, see . 815 | 816 | Also add information on how to contact you by electronic and paper mail. 817 | 818 | If the program does terminal interaction, make it output a short 819 | notice like this when it starts in an interactive mode: 820 | 821 | Copyright (C) 822 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 823 | This is free software, and you are welcome to redistribute it 824 | under certain conditions; type `show c' for details. 825 | 826 | The hypothetical commands `show w' and `show c' should show the appropriate 827 | parts of the General Public License. Of course, your program's commands 828 | might be different; for a GUI interface, you would use an "about box". 829 | 830 | You should also get your employer (if you work as a programmer) or school, 831 | if any, to sign a "copyright disclaimer" for the program, if necessary. 832 | For more information on this, and how to apply and follow the GNU GPL, see 833 | . 834 | 835 | The GNU General Public License does not permit incorporating your program 836 | into proprietary programs. If your program is a subroutine library, you 837 | may consider it more useful to permit linking proprietary applications with 838 | the library. If this is what you want to do, use the GNU Lesser General 839 | Public License instead of this License. But first, please read 840 | . 841 | 842 | --------------------------------------------------------------------------------