├── .gitignore ├── .env ├── traefik-complete ├── .env └── docker-compose.yml ├── ubuntu ├── docker-compose.yml ├── entrypoint.sh └── Dockerfile ├── docker-compose.yml ├── entrypoint.sh ├── Dockerfile ├── README.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | .DS_Store 3 | -------------------------------------------------------------------------------- /.env: -------------------------------------------------------------------------------- 1 | # Set container timezone 2 | TZ=America/Edmonton 3 | 4 | # Used within the docker-compose.yml template to provide easy configuration for your domain. 5 | ROOT_DOMAIN=itflow.org 6 | 7 | # Generate a random password using `docker run php:8.0-apache openssl rand -base64 32` 8 | ITFLOW_DB_PASS=thisisnotsecure -------------------------------------------------------------------------------- /traefik-complete/.env: -------------------------------------------------------------------------------- 1 | # Where you want your itflow git clone files to be stored on your host. For windows, let DOCKERDIR=. 2 | DOCKERDIR=/srv/containers 3 | 4 | # Cloudflare API information for traefik LetsEncrypt deployment 5 | CLOUDFLARE_API_KEY= 6 | 7 | CLOUDFLARE_EMAIL= 8 | 9 | # Set container timezone 10 | TZ=America/Edmonton 11 | 12 | # Used within the docker-compose.yml template to provide easy configuration for your domain. 13 | ROOT_DOMAIN=itflow.org 14 | 15 | ITFLOW_URL=demo.$ROOT_DOMAIN 16 | 17 | # Generate a random password using `docker run php:8.0-apache openssl rand -base64 32` 18 | ITFLOW_DB_PASS=thisisnotsecure -------------------------------------------------------------------------------- /ubuntu/docker-compose.yml: -------------------------------------------------------------------------------- 1 | ########################### NETWORKS 2 | networks: 3 | wan: 4 | name: wan 5 | driver: bridge 6 | 7 | itflow-db: 8 | name: itflow-db 9 | external: false 10 | 11 | ########################### VOLUMES 12 | 13 | volumes: 14 | itflow-db: 15 | 16 | ########################### ITFLOW 17 | services: 18 | itflow: 19 | platform: linux/amd64 20 | hostname: itflow 21 | container_name: itflow 22 | # Comment out image for DockerHub image, use build for local DockerFile if you prefer to build from base 23 | image: itfloworg/itflow 24 | #build: 25 | #context: . 26 | #dockerfile: Dockerfile 27 | restart: unless-stopped 28 | depends_on: 29 | - itflow-db 30 | networks: 31 | - wan 32 | - itflow-db 33 | ports: 34 | - "80:8080" 35 | environment: 36 | - TZ=$TZ 37 | - ITFLOW_NAME=ITFlow 38 | - ITFLOW_URL=it.$ROOT_DOMAIN 39 | - ITFLOW_PORT=8080 40 | - ITFLOW_REPO=github.com/itflow-org/itflow 41 | - ITFLOW_REPO_BRANCH=master 42 | - ITFLOW_LOG_LEVEL=info 43 | - ITFLOW_DB_HOST=itflow-db 44 | - ITFLOW_DB_PASS=$ITFLOW_DB_PASS 45 | volumes: 46 | - ./itflow/:/var/www/html 47 | 48 | itflow-db: 49 | hostname: itflow-db 50 | container_name: itflow-db 51 | image: mariadb:10.6.11 52 | restart: always 53 | networks: 54 | - itflow-db 55 | environment: 56 | - MARIADB_RANDOM_ROOT_PASSWORD=true 57 | - MARIADB_DATABASE=itflow 58 | - MARIADB_USER=itflow 59 | - MARIADB_PASSWORD=$ITFLOW_DB_PASS 60 | volumes: 61 | - itflow-db:/var/lib/mysql/ 62 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | ########################### NETWORKS 2 | networks: 3 | wan: 4 | name: wan 5 | driver: bridge 6 | 7 | itflow-db: 8 | name: itflow-db 9 | external: false 10 | 11 | ########################### VOLUMES 12 | 13 | volumes: 14 | itflow-db: 15 | 16 | ########################### ITFLOW 17 | services: 18 | itflow: 19 | platform: linux/amd64 20 | hostname: itflow 21 | container_name: itflow 22 | # Comment out image for DockerHub image, use build for local DockerFile if you prefer to build from base 23 | image: itfloworg/itflow:latest 24 | #build: 25 | #context: . 26 | #dockerfile: Dockerfile 27 | restart: unless-stopped 28 | depends_on: 29 | - itflow-db 30 | networks: 31 | - wan 32 | - itflow-db 33 | ports: 34 | - "80:8080" 35 | environment: 36 | - TZ=$TZ 37 | - ITFLOW_NAME=ITFlow 38 | - ITFLOW_URL=it.$ROOT_DOMAIN 39 | - ITFLOW_PORT=8080 40 | - ITFLOW_REPO=github.com/itflow-org/itflow 41 | - ITFLOW_REPO_BRANCH=master 42 | - ITFLOW_LOG_LEVEL=info 43 | - ITFLOW_DB_HOST=itflow-db 44 | - ITFLOW_DB_PASS=$ITFLOW_DB_PASS 45 | volumes: 46 | - ./itflow/:/var/www/localhost/htdocs 47 | 48 | itflow-db: 49 | hostname: itflow-db 50 | container_name: itflow-db 51 | image: mariadb:10.11.6 52 | restart: always 53 | networks: 54 | - itflow-db 55 | environment: 56 | - MARIADB_RANDOM_ROOT_PASSWORD=true 57 | - MARIADB_DATABASE=itflow 58 | - MARIADB_USER=itflow 59 | - MARIADB_PASSWORD=$ITFLOW_DB_PASS 60 | volumes: 61 | - itflow-db:/var/lib/mysql/ 62 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/ash 2 | 3 | sed -i "s/^Listen.*/Listen $ITFLOW_PORT/g" /etc/apache2/httpd.conf 4 | rm -rf /var/www/localhost/htdocs/index.html 5 | # if itflow is not downloaded, perform the download after the volume mounting process within DockerFile is complete. 6 | if [[ -f /var/www/localhost/htdocs/index.php ]]; then 7 | cd /var/www/localhost/htdocs 8 | # git fetch 9 | else 10 | git clone --branch $ITFLOW_REPO_BRANCH https://$ITFLOW_REPO /var/www/localhost/htdocs 11 | fi 12 | 13 | git config --global --add safe.directory /var/www/localhost/htdocs 14 | 15 | # Verify permissions of itflow git repository 16 | chown -R apache:apache /var/www/localhost/htdocs 17 | 18 | # This updates the config.php file once initialization through setup.php has completed 19 | if [[ -f /var/www/localhost/htdocs/config.php ]]; then 20 | # Company Name 21 | sed -i "s/\$config_app_name.*';/\$config_app_name = '$ITFLOW_NAME';/g" /var/www/localhost/htdocs/config.php 22 | 23 | # MariaDB Host 24 | sed -i "s/\$dbhost.*';/\$dbhost = '$ITFLOW_DB_HOST';/g" /var/www/localhost/htdocs/config.php 25 | 26 | # Database Password 27 | sed -i "s/\$dbpassword.*';/\$dbpassword = '$ITFLOW_DB_PASS';/g" /var/www/localhost/htdocs/config.php 28 | 29 | # Base URL 30 | sed -i "s/\$config_base_url.*';/\$config_base_url = '$ITFLOW_URL';/g" /var/www/localhost/htdocs/config.php 31 | 32 | # Repo Branch 33 | sed -i "s/\$repo_branch.*';/\$repo_branch = '$ITFLOW_REPO_BRANCH';/g" /var/www/localhost/htdocs/config.php 34 | 35 | find /var/www/localhost/htdocs -type d -exec chmod 775 {} \; 36 | find /var/www/localhost/htdocs -type f -exec chmod 664 {} \; 37 | chmod 640 /var/www/localhost/htdocs/config.php 38 | else 39 | chmod -R 777 /var/www/localhost/htdocs 40 | fi 41 | 42 | # Start Cron 43 | 44 | crond & 45 | 46 | # Execute the command in the dockerfile's CMD 47 | exec "$@" 48 | -------------------------------------------------------------------------------- /ubuntu/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Update the apache2 sites-available 3 | echo " 4 | Order allow,deny 5 | Allow from all 6 | Require all granted 7 | 8 | 9 | ServerName $ITFLOW_URL 10 | DocumentRoot /var/www/html/ 11 | LogLevel $ITFLOW_LOG_LEVEL 12 | ErrorLog /var/log/apache2/error.log 13 | CustomLog /var/log/apache2/access.log combined 14 | " > /etc/apache2/sites-available/000-default.conf 15 | 16 | sed -i "s/^Listen.*/Listen $ITFLOW_PORT/g" /etc/apache2/ports.conf 17 | 18 | # if itflow is not downloaded, perform the download after the volume mounting process within dockerfile is complete. 19 | if [[ -f /var/www/html/index.php ]]; then 20 | cd /var/www/html 21 | # git fetch 22 | else 23 | git clone --branch $ITFLOW_REPO_BRANCH https://$ITFLOW_REPO /var/www/html 24 | fi 25 | 26 | git config --global --add safe.directory /var/www/html 27 | 28 | # Verify permissions of itflow git repository 29 | chown -R www-data:www-data /var/www/html 30 | 31 | # This updates the config.php file once initialization through setup.php has completed 32 | if [[ -f /var/www/html/config.php ]]; then 33 | # Company Name 34 | sed -i "s/\$config_app_name.*';/\$config_app_name = '$ITFLOW_NAME';/g" /var/www/html/config.php 35 | 36 | # MariaDB Host 37 | sed -i "s/\$dbhost.*';/\$dbhost = '$ITFLOW_DB_HOST';/g" /var/www/html/config.php 38 | 39 | # Database Password 40 | sed -i "s/\$dbpassword.*';/\$dbpassword = '$ITFLOW_DB_PASS';/g" /var/www/html/config.php 41 | 42 | # Base URL 43 | sed -i "s/\$config_base_url.*';/\$config_base_url = '$ITFLOW_URL';/g" /var/www/html/config.php 44 | 45 | # Repo Branch 46 | sed -i "s/\$repo_branch.*';/\$repo_branch = '$ITFLOW_REPO_BRANCH';/g" /var/www/html/config.php 47 | 48 | find /var/www/html -type d -exec chmod 775 {} \; 49 | find /var/www/html -type f -exec chmod 664 {} \; 50 | chmod 640 /var/www/html/config.php 51 | else 52 | chmod -R 777 /var/www/html 53 | fi 54 | 55 | # Execute the command in the dockerfile's CMD 56 | exec "$@" 57 | -------------------------------------------------------------------------------- /ubuntu/Dockerfile: -------------------------------------------------------------------------------- 1 | FROM ubuntu:24.04 2 | 3 | LABEL dockerfile.version="v25.01" dockerfile.release-date="2025-01-16" 4 | 5 | # Set up ENVs that will be utilized in compose file. 6 | ENV TZ=Etc/UTC 7 | 8 | ENV ITFLOW_NAME=ITFlow 9 | 10 | ENV ITFLOW_URL=demo.itflow.org 11 | 12 | ENV ITFLOW_PORT=8443 13 | 14 | ENV ITFLOW_REPO=github.com/itflow-org/itflow 15 | 16 | ENV ITFLOW_REPO_BRANCH=master 17 | 18 | # apache2 log levels: emerg, alert, crit, error, warn, notice, info, debug 19 | ENV ITFLOW_LOG_LEVEL=warn 20 | 21 | ENV ITFLOW_DB_HOST=itflow-db 22 | 23 | ENV ITFLOW_DB_PASS=null 24 | 25 | # Set timezone from TZ ENV 26 | RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone 27 | 28 | # PREREQS: php php-intl php-mysqli php-imap php-curl libapache2-mod-php mariadb-server git -y 29 | # Upgrade, then install prereqs. 30 | RUN apt-get update && apt-get upgrade -y && apt-get clean 31 | 32 | # ITFlow Requirements 33 | RUN apt-get install -y \ 34 | git\ 35 | apache2\ 36 | php\ 37 | whois 38 | 39 | # Ubuntu quality of life installs 40 | RUN apt-get install -y \ 41 | vim\ 42 | nano\ 43 | cron\ 44 | dnsutils\ 45 | iputils-ping 46 | 47 | # Install & enable php extensions 48 | RUN apt-get install -y \ 49 | php-intl\ 50 | php-mysqli\ 51 | php-curl\ 52 | php-imap\ 53 | php-mailparse\ 54 | php-gd\ 55 | php-mbstring 56 | 57 | RUN apt-get install -y \ 58 | libapache2-mod-php 59 | 60 | # Enable php apache mod 61 | RUN a2enmod php8.3 62 | 63 | # Set the work dir to the git repo. 64 | WORKDIR /var/www/html 65 | 66 | # Edit php.ini file 67 | 68 | RUN sed -i 's/upload_max_filesize = 2M/upload_max_filesize = 500M/g' /etc/php/8.3/apache2/php.ini && \ 69 | sed -i 's/post_max_size = 8M/post_max_size = 500M/g' /etc/php/8.3/apache2/php.ini && \ 70 | sed -i 's/max_execution_time = 30/max_execution_time = 300/g' /etc/php/8.3/apache2/php.ini 71 | 72 | # Entrypoint 73 | # On every run of the docker file, perform an entrypoint that verifies the container is good to go. 74 | COPY entrypoint.sh /usr/bin/ 75 | 76 | RUN chmod +x /usr/bin/entrypoint.sh 77 | 78 | # forward request and error logs to docker log collector 79 | RUN ln -sf /dev/stdout /var/log/apache2/access.log && ln -sf /dev/stderr /var/log/apache2/error.log 80 | 81 | ENTRYPOINT [ "entrypoint.sh" ] 82 | 83 | # Expose the apache port 84 | EXPOSE $ITFLOW_PORT 85 | 86 | # Start the httpd service and have logs appear in stdout 87 | CMD [ "apache2ctl", "-D", "FOREGROUND" ] 88 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # DO NOT USE THIS. IT WON'T WORK YET 2 | 3 | FROM alpine:3.21 4 | 5 | LABEL dockerfile.version="v25.05" dockerfile.release-date="2025-06-05" 6 | 7 | # Set up ENVs that will be utilized in compose file. 8 | ENV TZ=Etc/UTC 9 | 10 | ENV ITFLOW_NAME=ITFlow 11 | 12 | ENV ITFLOW_URL=demo.itflow.org 13 | 14 | ENV ITFLOW_PORT=8443 15 | 16 | ENV ITFLOW_REPO=github.com/itflow-org/itflow 17 | 18 | ENV ITFLOW_REPO_BRANCH=master 19 | 20 | # apache2 log levels: emerg, alert, crit, error, warn, notice, info, debug 21 | ENV ITFLOW_LOG_LEVEL=warn 22 | 23 | ENV ITFLOW_DB_HOST=itflow-db 24 | 25 | ENV ITFLOW_DB_PASS=null 26 | 27 | # Set timezone from TZ ENV 28 | RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone 29 | 30 | # PREREQS: php php-intl php-mysqli php-imap php-curl libapache2-mod-php mariadb-server git -y 31 | # Upgrade, then install prereqs. 32 | RUN apk update && apk upgrade 33 | 34 | # Basic Requirements 35 | RUN apk add \ 36 | git\ 37 | apache2\ 38 | php84\ 39 | whois\ 40 | bind-tools\ 41 | tzdata 42 | 43 | # Alpine quality of life installs 44 | RUN apk add \ 45 | vim\ 46 | nano 47 | 48 | # Install & enable php extensions 49 | RUN apk add \ 50 | php84-intl\ 51 | php84-mysqli\ 52 | php84-curl\ 53 | php84-imap\ 54 | php84-pecl-mailparse\ 55 | php84-gd\ 56 | php84-mbstring\ 57 | php84-ctype\ 58 | php84-session\ 59 | php84-posix\ 60 | php84-xml\ 61 | php84-zip 62 | 63 | # Install PHP into Apache 64 | RUN apk add \ 65 | php84-apache2 66 | 67 | # Set the work dir to the git repo. 68 | WORKDIR /var/www/localhost/htdocs 69 | 70 | # Edit php.ini file 71 | 72 | RUN sed -i 's/upload_max_filesize = 2M/upload_max_filesize = 500M/g' /etc/php84/php.ini && \ 73 | sed -i 's/post_max_size = 8M/post_max_size = 500M/g' /etc/php84/php.ini && \ 74 | sed -i 's/max_execution_time = 30/max_execution_time = 300/g' /etc/php84/php.ini 75 | 76 | # Entrypoint 77 | # On every run of the docker file, perform an entrypoint that verifies the container is good to go. 78 | COPY entrypoint.sh /usr/bin/ 79 | 80 | # Create crontab entries 81 | 82 | RUN echo "0 1 * * * /usr/bin/php84 /var/www/localhost/htdocs/cron/cron.php" >> /etc/crontabs/apache 83 | RUN echo "* * * * * /usr/bin/php84 /var/www/localhost/htdocs/cron/ticket_email_parser.php" >> /etc/crontabs/apache 84 | RUN echo "* * * * * /usr/bin/php84 /var/www/localhost/htdocs/cron/mail_queue.php" >> /etc/crontabs/apache 85 | RUN echo "0 2 * * * /usr/bin/php84 /var/www/localhost/htdocs/cron/certificate_refresher.php" >> /etc/crontabs/apache 86 | RUN echo "0 3 * * * /usr/bin/php84 /var/www/localhost/htdocs/cron/domain_refresher.php" >> /etc/crontabs/apache 87 | 88 | RUN chmod +x /usr/bin/entrypoint.sh 89 | 90 | # forward request and error logs to docker log collector 91 | RUN ln -sf /dev/stdout /var/log/apache2/access.log && ln -sf /dev/stderr /var/log/apache2/error.log 92 | 93 | # Create Symlink to PHP from PHP84 94 | RUN ln -s /usr/bin/php84 /usr/bin/php 95 | 96 | ENTRYPOINT [ "entrypoint.sh" ] 97 | 98 | # Expose the apache port 99 | EXPOSE $ITFLOW_PORT 100 | 101 | # Start the httpd service and have logs appear in stdout 102 | CMD [ "httpd", "-D", "FOREGROUND" ] 103 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 |

ITFlow

4 | 5 |

6 | IT documentation, ticketing and accounting system for small MSPs. 7 |
8 |
9 | View demo 10 |
11 | Username: demo@demo | Password: demo 12 |
13 |
14 | About 15 | · 16 | Docs 17 | · 18 | Forum 19 | · 20 | Report Bug 21 | · 22 | Request Feature 23 |

24 |
25 | 26 | -- 27 | 28 | # About this Image 29 | This is the Docker image of [ITFlow](https://github.com/itflow-org/itflow). This image was created by a community member, we don't "officially" support Docker. This image is not ready for production use. 30 | 31 | This image is based on Alpine 3.21 32 | 33 | Please see the wiki: https://docs.itflow.org/installation_docker 34 | 35 | # Usage 36 | ## ITFlow Only (no Reverse Proxy) 37 | 1. Copy [docker-compose.yml](https://raw.githubusercontent.com/itflow-org/itflow-docker/main/docker-compose.yml) and [Dockerfile](https://raw.githubusercontent.com/itflow-org/itflow-docker/main/Dockerfile) to a directory. 38 | 2. Within docker-compose.yml, adjust the ```environment:``` variables such as ITFLOW_NAME, ITFLOW_URL and ITFLOW_REPO (to your own MSPs fork). 39 | 3. Copy the [.env](https://raw.githubusercontent.com/itflow-org/itflow-docker/main/.env) file to the same directory. 40 | > Enter your timezone, root domain and database password within this file. You can avoid this step entirely by adding the information to your docker-compose.yml file directly instead. Or being safe, by using docker secrets. 41 | 4. Run ```docker compose up -d``` 42 | 5. Go to your domain. You should be redirected to setup.php. Enter server information correlated to your set up .env and docker-compose.yml files. 43 | > Defaults: Username: itflow, Password: $ITFLOW_DB_PASS from .env, Database: itflow, Server: itflow-db 44 | 6. You will either need to setup your reverse proxy from here to login or modify config.php in /var/www/localhost/htdocs if you're not using SSL 45 | > ```$config_https_only = FALSE;``` 46 | 47 | ## Complete [Traefik](https://doc.traefik.io/traefik/getting-started/quick-start/) Solution (Reverse Proxy) 48 | 1. Copy the traefik [docker-compose.yml](https://raw.githubusercontent.com/itflow-org/itflow-docker/main/traefik-complete/docker-compose.yml) to a directory. 49 | 2. Within docker-compose.yml, adjust the ```environment:``` variables such as ITFLOW_NAME, ITFLOW_URL and ITFLOW_REPO (to your own MSPs fork). 50 | 3. Copy the [.env](https://raw.githubusercontent.com/itflow-org/itflow-docker/main/traefik-complete/.env) file to the same directory. 51 | > Enter your docker path (/srv/docker, ., etc), cloudflare info, timezone, root domain and database password within this file. 52 | 4. Create your A records for your host. 53 | 5. Run ```docker compose up -d``` 54 | 6. Verify you are getting certificates through LetsEncrypt. You will have two public URLs, traefik.$ROOT_DOMAIN and $ITFLOW_URL. 55 | 7. Go to your domain. You should be redirected to setup.php. Enter server information correlated to .env and docker-compose.yml 56 | > Defaults: Username: itflow, Password: $ITFLOW_DB_PASS from .env, Database: itflow, Server: itflow-db 57 | 58 | ## Environment Variables 59 | ``` 60 | ENV TZ Etc/UTC 61 | 62 | ENV ITFLOW_NAME ITFlow 63 | 64 | ENV ITFLOW_REPO github.com/itflow-org/itflow 65 | 66 | ENV ITFLOW_REPO_BRANCH master 67 | 68 | ENV ITFLOW_URL demo.itflow.org 69 | 70 | ENV ITFLOW_PORT 8080 71 | 72 | # apache2 log levels: emerg, alert, crit, error, warn, notice, info, debug 73 | ENV ITFLOW_LOG_LEVEL warn 74 | 75 | ENV ITFLOW_DB_HOST itflow-db 76 | 77 | ENV ITFLOW_DB_PASS null 78 | ``` 79 | 80 | ## Changing ITFLOW_REPO* Environment Variables 81 | Please go about this by deleting your volume location ```./itflow``` 82 | 83 | ### In Beta 84 | * This project is still in early beta and is considered a **work in progress**. Many changes are being performed and may cause breakage upon updates. 85 | * Currently, we strongly recommend against storing confidential information in ITFlow; ITFlow has not undergone a third-party security assessment. 86 | -------------------------------------------------------------------------------- /traefik-complete/docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: "3.9" 2 | ########################### NETWORKS 3 | 4 | networks: 5 | wan: 6 | name: wan 7 | driver: bridge 8 | 9 | dockersocket: 10 | name: dockersocket 11 | 12 | itflow-db: 13 | name: itflow-db 14 | external: false 15 | 16 | ########################### VOLUMES 17 | 18 | volumes: 19 | traefik-acme: 20 | itflow-db: 21 | 22 | ########################### DOCKER / TRAEFIK 23 | 24 | services: 25 | traefik: # Reverse Proxy & Router 26 | image: traefik 27 | hostname: traefik 28 | container_name: traefik 29 | restart: unless-stopped 30 | command: 31 | - --global.sendAnonymousUsage=false 32 | - --entryPoints.web.address=:80 33 | - --entryPoints.websecure.address=:443 34 | - --entrypoints.web.http.redirections.entrypoint.to=websecure 35 | - --entrypoints.web.http.redirections.entrypoint.scheme=https 36 | # Allow these IPs to set the X-Forwarded-* headers - Cloudflare IPs: https://www.cloudflare.com/ips/ 37 | - --entrypoints.websecure.forwardedHeaders.trustedIPs=173.245.48.0/20,103.21.244.0/22,103.22.200.0/22,103.31.4.0/22,141.101.64.0/18,108.162.192.0/18,190.93.240.0/20,188.114.96.0/20,197.234.240.0/22,198.41.128.0/17,162.158.0.0/15,104.16.0.0/12,172.64.0.0/13,131.0.72.0/22 38 | - --api=true 39 | - --log=true 40 | - --log.level=DEBUG # DEBUG, INFO, WARN, ERROR, FATAL, PANIC 41 | - --providers.docker 42 | - --providers.docker.endpoint=tcp://docker_proxy:2375 #unix:///var/run/docker.sock 43 | - --providers.docker.defaultrule=Host(`{{ index .Labels "com.docker.compose.service" }}`) 44 | - --providers.docker.exposedByDefault=false 45 | - --providers.docker.network=wan 46 | - --providers.docker.swarmMode=false 47 | # Test acme resolution through LetsEncrypt's acme-staging-v02 URL to avoid blacklisting your IP. 48 | # When ready, uncomment the line below and comment out the "acme-staging-v02" URL and uncomment the "acme-v02" URL. 49 | #- --certificatesResolvers.dns-cloudflare.acme.caServer=https://acme-v02.api.letsencrypt.org/directory 50 | - --certificatesResolvers.dns-cloudflare.acme.caServer=https://acme-staging-v02.api.letsencrypt.org/directory 51 | - --certificatesResolvers.dns-cloudflare.acme.email=$CLOUDFLARE_EMAIL 52 | - --certificatesResolvers.dns-cloudflare.acme.storage=/acme/acme.json 53 | - --certificatesResolvers.dns-cloudflare.acme.dnsChallenge.provider=cloudflare 54 | - --certificatesResolvers.dns-cloudflare.acme.dnsChallenge.resolvers=1.1.1.1:53,1.0.0.1:53 55 | - --certificatesResolvers.dns-cloudflare.acme.dnsChallenge.delayBeforeCheck=90 56 | - --providers.file.directory=/dynamic-conf # Load dynamic configuration from one or more .toml or .yml files in a directory. 57 | - --providers.file.watch=true # Only works on top level files in the rules folder 58 | networks: 59 | - wan 60 | - dockersocket 61 | security_opt: 62 | - no-new-privileges:true 63 | ports: 64 | - 80:80 65 | - 443:443 66 | volumes: 67 | - traefik-acme:/acme 68 | - ${DOCKERDIR}/traefik:/dynamic-conf 69 | environment: 70 | - CF_API_EMAIL=$CLOUDFLARE_EMAIL 71 | - CF_API_KEY=$CLOUDFLARE_API_KEY 72 | - TZ=$TZ 73 | labels: 74 | - "traefik.enable=true" 75 | # Middleware Rules 76 | # # Basic Authentication - https://doc.traefik.io/traefik/middlewares/http/basicauth/ 77 | # - "traefik.http.middlewares.basic-auth.basicAuth.realm=Traefik Basic Authentication" 78 | # - "traefik.http.middlewares.basic-auth.basicAuth.users=admin:$$2y$$05$$so1Qmqxf8H6iA19nmqQX1usVZblGrKBM9w3SDEqS1WmEiYUqF3mT2" 79 | # # Rate Limit 80 | - "traefik.http.middlewares.rate-limit.rateLimit.average=100" 81 | - "traefik.http.middlewares.rate-limit.rateLimit.burst=50" # # Secure Headers 82 | - "traefik.http.middlewares.secure-headers.headers.framedeny=false" 83 | - "traefik.http.middlewares.secure-headers.headers.stsincludesubdomains=true" 84 | - "traefik.http.middlewares.secure-headers.headers.stspreload=true" 85 | - "traefik.http.middlewares.secure-headers.headers.forceSTSHeader=true" 86 | - "traefik.http.middlewares.secure-headers.headers.contentTypeNosniff=true" 87 | - "traefik.http.middlewares.secure-headers.headers.stsseconds=63072000" 88 | - "traefik.http.middlewares.secure-headers.headers.browserXssFilter=true" 89 | - "traefik.http.middlewares.secure-headers.headers.contenttypenosniff=true" 90 | - "traefik.http.middlewares.secure-headers.headers.accesscontrolallowmethods=GET,POST,PUT,OPTIONS" 91 | - "traefik.http.middlewares.secure-headers.headers.accesscontrolmaxage=100" 92 | - "traefik.http.middlewares.secure-headers.headers.addvaryheader=true" 93 | #- "traefik.http.middlewares.secure-headers.headers.contentsecuritypolicy=script-src 'self'" 94 | - "traefik.http.middlewares.secure-headers.headers.referrerpolicy=origin-when-cross-origin" 95 | #- "traefik.http.middlewares.secure-headers.headers.customResponseHeaders=none,noarchive,nosnippet,notranslate,noimageindex" 96 | - "traefik.http.middlewares.secure-headers.headers.hostsProxyHeaders=X-Forwarded-Host" 97 | # Middleware Chains 98 | - "traefik.http.middlewares.chain-no-auth.chain.middlewares=rate-limit,secure-headers" 99 | #- "traefik.http.middlewares.chain-basic-auth.chain.middlewares=rate-limit,secure-headers,basic-auth" 100 | # Services - API 101 | - "traefik.http.routers.traefik-rtr.service=api@internal" 102 | # HTTP Routers 103 | - "traefik.http.routers.traefik-rtr.entrypoints=websecure" 104 | - "traefik.http.routers.traefik-rtr.rule=Host(`traefik.$ROOT_DOMAIN`)" 105 | - "traefik.http.routers.traefik-rtr.tls=true" 106 | # Setting TLS to $DOMAIN# 107 | - "traefik.http.routers.traefik-rtr.tls.certResolver=dns-cloudflare" 108 | - "traefik.http.routers.traefik-rtr.tls.domains[0].main=$ROOT_DOMAIN" 109 | - "traefik.http.routers.traefik-rtr.tls.domains[0].sans=*.$ROOT_DOMAIN" 110 | 111 | watchtower: 112 | image: containrrr/watchtower 113 | hostname: watchtower 114 | container_name: watchtower 115 | restart: unless-stopped 116 | networks: 117 | - dockersocket 118 | environment: 119 | DOCKER_HOST: tcp://docker_proxy:2375 120 | 121 | docker_proxy: 122 | image: tecnativa/docker-socket-proxy 123 | hostname: docker_proxy 124 | container_name: docker_proxy 125 | restart: unless-stopped 126 | networks: 127 | - dockersocket 128 | volumes: 129 | - /var/run/docker.sock:/var/run/docker.sock:ro 130 | environment: 131 | CONTAINERS: 1 132 | NETWORKS: 1 133 | SERVICES: 1 134 | INFO: 1 135 | IMAGES: 1 136 | VOLUMES: 1 137 | POST: 1 138 | 139 | ########################### ITFLOW 140 | 141 | itflow: 142 | hostname: itflow 143 | container_name: itflow 144 | image: itfloworg/itflow 145 | # build: ../. 146 | restart: unless-stopped 147 | depends_on: 148 | - itflow-db 149 | networks: 150 | - wan 151 | - itflow-db 152 | environment: 153 | - TZ=$TZ 154 | - ITFLOW_NAME=ITFlow 155 | - ITFLOW_URL=$ITFLOW_URL 156 | - ITFLOW_PORT=8080 157 | - ITFLOW_REPO=github.com/itflow-org/itflow 158 | - ITFLOW_REPO_BRANCH=master 159 | - ITFLOW_LOG_LEVEL=info 160 | - ITFLOW_DB_HOST=itflow-db 161 | - ITFLOW_DB_PASS=$ITFLOW_DB_PASS 162 | volumes: 163 | - ${DOCKERDIR}/itflow/:/var/www/html 164 | labels: 165 | - "traefik.enable=true" 166 | ## HTTP Routers 167 | - "traefik.http.routers.itflow-rtr.entrypoints=websecure" 168 | - "traefik.http.routers.itflow-rtr.tls=true" 169 | - "traefik.http.routers.itflow-rtr.rule=Host(`$ITFLOW_URL`)" 170 | ## Middlewares 171 | - "traefik.http.routers.itflow-rtr.middlewares=chain-no-auth@docker" 172 | ## HTTP Services 173 | - "traefik.http.routers.itflow-rtr.service=itflow-svc" 174 | - "traefik.http.services.itflow-svc.loadbalancer.server.port=8080" 175 | 176 | itflow-db: 177 | hostname: itflow-db 178 | container_name: itflow-db 179 | image: mariadb:10.11.6 180 | restart: always 181 | networks: 182 | - itflow-db 183 | environment: 184 | - TZ=$TZ 185 | - MARIADB_RANDOM_ROOT_PASSWORD=true 186 | - MARIADB_DATABASE=itflow 187 | - MARIADB_USER=itflow 188 | - MARIADB_PASSWORD=$ITFLOW_DB_PASS 189 | volumes: 190 | - itflow-db:/var/lib/mysql/ 191 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------