├── .gitignore ├── README.md ├── .env.example ├── docker-compose.yaml └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .env 2 | .vscode 3 | /docker/* 4 | /hydra2/* 5 | /lidarr/* 6 | /jackett/* 7 | /muximux/* 8 | /nginx-proxy/* 9 | /pihole/* 10 | /plex/* 11 | /sonarr/* 12 | /radarr/* 13 | letsencrypt/* 14 | portainer/* 15 | sabnzbd/* 16 | calibre/* -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # bageera HTPC Setup 2 | 3 | 4 | ## Containers 5 | - [Traefik](https://containo.us/traefik/) - cloud natibe edge router 6 | - [Plex Media Server](https://www.plex.tv/) - for managing media and serving files to Plex Clients 7 | - [Radarr](https://radarr.video/) - for Movie Management 8 | - [Sonarr](https://sonarr.tv/) - for TV Series Management 9 | - mylar 10 | - lidar 11 | - sabnbzd 12 | - pihole 13 | - nextcloud 14 | - mariadb 15 | - [Ombi](https://ombi.io/) - for requesting additional library content 16 | - [Tautulli](http://tautulli.com/) - for Plex library statistics and usage 17 | - [Portainer](https://portainer.io/) - for managing all of your Docker containers 18 | - [Watchtower](https://github.com/containerrr/watchtower) - for automatically updating running containers 19 | - [NetData](https://my-netdata.io/) - for system resource monitoring 20 | - [Bitwarden](https://bitwarden.com/) - open source password management solution 21 | 22 | ## Prereqs 23 | * First pull down the repo and update cp the .env.example to a .env 24 | 25 | ## Instructions 26 | * the following command will bring up your environment 27 | docker-compose up -d 28 | 29 | 30 | ## Tips and Tricks 31 | * gain shell access to a docker container 32 | docker-composer exec bash CONTAINER_NAME 33 | 34 | 35 | # Known issues 36 | 37 | 38 | 39 | 40 | # Disclaimer 41 | 42 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 43 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 44 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 45 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 46 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 47 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 48 | SOFTWARE. -------------------------------------------------------------------------------- /.env.example: -------------------------------------------------------------------------------- 1 | ### H T P C - D O C K E R C O N F I G S E T T I N G S 2 | ### ----------------------------------------------------- 3 | ### The values configured here are applied during 4 | ### $ docker-compose up 5 | ### ----------------------------------------------- 6 | ### DOCKER-COMPOSE ENVIRONMENT VARIABLES BEGIN HERE 7 | ### ----------------------------------------------- 8 | ### 9 | 10 | LOCALUSER= 11 | USERDIR=./ 12 | DATADIR=/path/to/data 13 | HOSTNAME= 14 | IP_ADDRESS=192.168.1.0 #pick your server ip 15 | IPv6_ADDRESS= 16 | PUID=1000 17 | PGID=1000 18 | PMSTOKEN= 19 | PIAUNAME= 20 | PIAPASS= 21 | VPN_REMOTE= 22 | HTTP_USERNAME= 23 | HTTP_PASSWORD= 24 | CLOUDNS_AUTH_ID= 25 | CLOUDNS_AUTH_PASSWORD= 26 | CIDR_ADDRESS=192.168.1.0/24 #pick you local network 27 | TZ=UTC 28 | PMSTAG= 29 | EMAIL=someone@example.local 30 | DOMAIN=yourdomain.local 31 | WATCHTOWER_EMAIL=someone@example.local 32 | SMTP_FROM=someone@example.local 33 | SMTP_SERVER=mail.server.local 34 | SMTP_PORT=587 35 | SMTP_USER=someone@example.local 36 | SMTP_PASS=superawesomepassword 37 | APP_PATH= 38 | 39 | ### MARIADB ############################################### 40 | 41 | MARIADB_DATABASE=default 42 | MARIADB_USER=homestead 43 | MARIADB_PASSWORD=secret 44 | MARIADB_PORT=3308 45 | MARIADB_ROOT_PASSWORD=supersecretpassword 46 | MARIADB_ENTRYPOINT_INITDB=./mariadb/docker-entrypoint-initdb.d 47 | 48 | ### NEXTCLOUD 49 | NEXTCLOUD_DB=nextcloud 50 | NEXTCLOUD_DB_USER=ncdbuser 51 | NEXTCLOUD_DB_PASSWORD=supersecretpassword 52 | NEXTCLOUD_ADMIN_USER=ncadmin 53 | NEXTCLOUD_ADMIN_PASSWORD=supersecretpassword 54 | NEXTCLOUD_DATA_DIR=/data/nextcloud #location where you want your nextcloud data stored 55 | NEXTCLOUD_TRUSTED_DOMAINS=nextcloud.localdomain newdomain.localdomain #domains that wyou want to be trusted 56 | 57 | ### BITWARDEN config 58 | BW_SMTP= 59 | BW_SMTP_FROM= 60 | BW_SMTP_PORT=587 61 | BW_SMTP_USERNAME= 62 | BW_SMTP_PASSWORD= 63 | BW_ADMIN_TOKEN= -------------------------------------------------------------------------------- /docker-compose.yaml: -------------------------------------------------------------------------------- 1 | ## 2 | ## ------------------------- 3 | ## | H T P C - D O C K E R | 4 | ## ------------------------- 5 | ## 6 | ## Container based media tools configuration 7 | ## 8 | ## -- DO NOT EDIT THIS FILE -- 9 | ## 10 | ## Configuration items for this file are taken from the .env file 11 | ## 12 | ## Have docker-compose.yml and .env in the same directory to launch the stack 13 | 14 | version: '3.2' 15 | 16 | ###################### 17 | # SERVICES TO LAUNCH # 18 | ###################### 19 | 20 | services: 21 | 22 | traefik: 23 | hostname: traefik 24 | image: traefik:latest 25 | container_name: traefik 26 | restart: always 27 | domainname: alpha.${DOMAIN} 28 | command: 29 | - "--providers.docker=true" 30 | - "--entrypoints.web.address=:80" 31 | - "--entrypoints.websecure.address=:443" 32 | networks: 33 | - default 34 | - traefik_proxy 35 | ports: 36 | - "80:80" 37 | - "8088:8080" 38 | - "443:443" 39 | environment: 40 | - CLOUDNS_AUTH_ID=${CLOUDNS_AUTH_ID} 41 | - CLOUDNS_AUTH_PASSWORD=${CLOUDNS_AUTH_PASSWORD} 42 | 43 | labels: 44 | - "traefik.enable=true" 45 | - "traefik.backend=traefik" 46 | - "traefik.http.routers.api.rule=Host(`traefik.${DOMAIN}`)" 47 | - "traefik.http.routers.api.rule=Host(`traefik.${DOMAINNAME}`)" 48 | - "traefik.http.middlewares.traefik-https-redirect.redirectscheme.scheme=https" 49 | - "traefik.docker.network=traefik_proxy" 50 | - "traefik.http.routers.traefik.entrypoints=web" 51 | - "traefik.http.middlewares.traefik-auth.basicauth.users=${TFUSER}:${TFPASSWORD}" 52 | - "traefik.http.routers.traefik-secure.entrypoints=web-secure" 53 | - "traefik.http.routers.traefik-secure.rule=Host(`traefik.${DOMAINNAME}`)" 54 | - "traefik.http.routers.traefik-secure.middlewares=traefik-auth" 55 | - "traefik.http.routers.traefik-secure.tls=true" 56 | - "traefik.http.routers.traefik-secure.tls.options=default" 57 | - "traefik.http.routers.traefik-secure.tls.certresolver=http" 58 | - "traefik.http.routers.traefik-secure.service=api@internal" 59 | 60 | volumes: 61 | - /var/run/docker.sock:/var/run/docker.sock:ro 62 | - ${USERDIR}/docker/traefik:/etc/traefik 63 | - ${USERDIR}/docker/tf/shared:/shared 64 | 65 | # ---------------------------------------- 66 | # PLEX 67 | # Robust Media Server 68 | # ---------------------------------------- 69 | plex: 70 | container_name: plex 71 | image: plexinc/pms-docker 72 | restart: unless-stopped 73 | network_mode: 'host' 74 | ports: 75 | - '${IP_ADDRESS}:32400:32400/tcp' 76 | - '${IP_ADDRESS}:3005:3005/tcp' 77 | - '${IP_ADDRESS}:8324:8324/tcp' 78 | - '${IP_ADDRESS}:32469:32469/tcp' 79 | - '${IP_ADDRESS}:1900:1900/udp' 80 | - '${IP_ADDRESS}:32410:32410/udp' 81 | - '${IP_ADDRESS}:32412:32412/udp' 82 | - '${IP_ADDRESS}:32413:32413/udp' 83 | - '${IP_ADDRESS}:32414:32414/udp' 84 | environment: 85 | - PLEX_CLAIM=${PMSTOKEN} 86 | - ADVERTISE_IP=http://${IP_ADDRESS}:32400/ 87 | - ALLOWED_NETWORKS=${CIDR_ADDRESS} 88 | - PLEX_UID=${PUID} 89 | - PLEX_GID=${PGID} 90 | hostname: ${HOSTNAME} 91 | volumes: 92 | - '${USERDIR}/plex:/config' 93 | - '${USERDIR}/plex/transcode:/transcode' 94 | - '${DATADIR}/video/Movies:/data/movies' 95 | - '${DATADIR}/video/TV:/data/tv' 96 | - '${DATADIR}/music:/data/music' 97 | - '${DATADIR}/photo/:/data/photo' 98 | - '/etc/localtime:/etc/localtime:ro' 99 | 100 | tautulli: 101 | container_name: tautulli 102 | restart: always 103 | image: linuxserver/tautulli 104 | volumes: 105 | - ${USERDIR}/docker/tautulli/config:/config 106 | - ${USERDIR}/docker/tautulli/logs:/logs:ro 107 | - ${USERDIR}/docker/shared:/shared 108 | # ports: 109 | # - "XXXX:8181" 110 | environment: 111 | - PUID=${PUID} 112 | - PGID=${PGID} 113 | - TZ=${TZ} 114 | networks: 115 | - traefik_proxy 116 | labels: 117 | - "traefik.enable=true" 118 | - "traefik.backend=tautulli" 119 | - "traefik.http.routers.tautulli.rule=Host(`tautulli.${DOMAIN}`)" 120 | - "traefik.port=8181" 121 | - "traefik.docker.network=traefik_proxy" 122 | 123 | ombi: 124 | container_name: ombi 125 | restart: always 126 | image: linuxserver/ombi 127 | volumes: 128 | - ${USERDIR}/docker/ombi:/config 129 | - ${USERDIR}/docker/shared:/shared 130 | # ports: 131 | # - "XXXX:3579" 132 | environment: 133 | - PUID=${PUID} 134 | - PGID=${PGID} 135 | - TZ=${TZ} 136 | networks: 137 | - traefik_proxy 138 | labels: 139 | - "traefik.enable=true" 140 | - "traefik.http.routers.ombi.rule=Host(`ombi.${DOMAIN}`)" 141 | - "traefik.port=3579" 142 | - "traefik.docker.network=traefik_proxy" 143 | - "traefik.http.middlewares.ombi-https-redirect.redirectscheme.scheme=https" 144 | - "traefik.http.routers.ombi.middlewares=ombi-https-redirect" 145 | - "traefik.http.middlewares.harden.headers.stsPreload=true" 146 | - "traefik.http.middlewares.harden.headers.stsSeconds=31536000" 147 | - "traefik.http.middlewares.harden.headers.stsIncludeSubdomains=true" 148 | - "traefik.http.routers.ombi-secure.middlewares=harden" 149 | - "traefik.http.routers.ombi-secure.entrypoints=web-secure" 150 | - "traefik.http.routers.ombi-secure.rule=Host(`ombi.${DOMAINNAME}`)" 151 | - "traefik.http.routers.ombi-secure.tls=true" 152 | - "traefik.http.routers.ombi-secure.tls.certresolver=http" 153 | - "traefik.http.routers.ombi-secure.tls.options=default" 154 | - "traefik.http.routers.ombi-secure.service=ombi" 155 | - "traefik.http.services.ombi.loadbalancer.server.port=3579" 156 | 157 | organizr: 158 | container_name: organizr 159 | restart: always 160 | image: lsiocommunity/organizr 161 | volumes: 162 | - ${USERDIR}/docker/organizr:/config 163 | - ${USERDIR}/docker/shared:/shared 164 | # ports: 165 | # - "XXXX:80" 166 | environment: 167 | - PUID=${PUID} 168 | - PGID=${PGID} 169 | - TZ=${TZ} 170 | networks: 171 | - traefik_proxy 172 | labels: 173 | - "traefik.enable=true" 174 | - "traefik.backend=organizr" 175 | - "traefik.http.routers.organizr.rule=Host(`organizr.${DOMAIN}`)" 176 | # - "traefik.frontend.rule=Host:${DOMAINNAME}; PathPrefixStrip: /organizr" 177 | - "traefik.port=80" 178 | - "traefik.docker.network=traefik_proxy" 179 | 180 | # ---------------------------------------- 181 | # SONARR 182 | # TV Series Management 183 | # ---------------------------------------- 184 | sonarr: 185 | image: linuxserver/sonarr 186 | container_name: sonarr 187 | restart: unless-stopped 188 | network_mode: 'traefik_proxy' 189 | ports: 190 | - '${IP_ADDRESS}:8989:8989' 191 | environment: 192 | - PUID=${PUID} 193 | - PGID=${PGID} 194 | - VIRTUAL_HOST=sonarr.${DOMAIN} 195 | - LETSENCRYPT_HOST=sonarr.${DOMAIN} 196 | - LETSENCRYPT_EMAIL=${EMAIL} 197 | volumes: 198 | - '${USERDIR}/sonarr:/config' 199 | - '${DATADIR}/video/completed:/completed' 200 | - '${USERDIR}/data/downloads:/downloads' 201 | - '${USERDIR}/data/downloads/unprocessed:/unprocessed' 202 | - '${DATADIR}/video/watch:/watch' 203 | - '${DATADIR}/video/TV:/data/tv' 204 | - '/etc/localtime:/etc/localtime:ro' 205 | labels: 206 | - "traefik.enable=true" 207 | - "traefik.backend=sonarr" 208 | - "traefik.http.routers.sonarr.rule=Host(`sonarr.${DOMAIN}`)" 209 | - "traefik.port=8989" 210 | - "traefik.docker.network=traefik_proxy" 211 | 212 | # ---------------------------------------- 213 | # SONARR 214 | # TV Series Management 215 | # ---------------------------------------- 216 | lidarr: 217 | image: linuxserver/lidarr 218 | container_name: lidarr 219 | restart: unless-stopped 220 | network_mode: 'traefik_proxy' 221 | ports: 222 | - '${IP_ADDRESS}:8686:8686' 223 | environment: 224 | - PUID=${PUID} 225 | - PGID=${PGID} 226 | - VIRTUAL_HOST=sonarr.${DOMAIN} 227 | - LETSENCRYPT_HOST=sonarr.${DOMAIN} 228 | - LETSENCRYPT_EMAIL=${EMAIL} 229 | volumes: 230 | - '${USERDIR}/lidarr:/config' 231 | - '${DATADIR}/video/completed:/completed' 232 | - '${USERDIR}/data/downloads:/downloads' 233 | - '${DATADIR}/video/unprocessed:/unprocessed' 234 | - '${DATADIR}/video/watch:/watch' 235 | - '${DATADIR}/music:/music:rw' 236 | - '/etc/localtime:/etc/localtime:ro' 237 | labels: 238 | - "traefik.enable=true" 239 | - "traefik.backend=lidarr" 240 | - "traefik.port=8686" 241 | - "traefik.docker.network=traefik_proxy" 242 | - "traefik.http.routers.lidarr.rule=Host(`lidarr.${DOMAIN}`)" 243 | 244 | 245 | 246 | # ---------------------------------------- 247 | # RADARR 248 | # Movie Management 249 | # ---------------------------------------- 250 | radarr: 251 | image: linuxserver/radarr 252 | container_name: radarr 253 | restart: unless-stopped 254 | network_mode: "traefik_proxy" 255 | ports: 256 | - '${IP_ADDRESS}:7878:7878' 257 | environment: 258 | - PUID=${PUID} 259 | - PGID=${PGID} 260 | - VIRTUAL_HOST=radarr.${DOMAIN} 261 | - LETSENCRYPT_HOST=radarr.${DOMAIN} 262 | - LETSENCRYPT_EMAIL=${EMAIL} 263 | volumes: 264 | - '${USERDIR}/radarr:/config' 265 | - '/data/video/completed:/completed' 266 | - '${USERDIR}/data/downloads:/downloads' 267 | - '${DATADIR}/video/unprocessed:/unprocessed' 268 | - '${DATADIR}/video/Movies/Movies:/movies:rw' 269 | - '/etc/localtime:/etc/localtime:ro' 270 | labels: 271 | - "traefik.enable=true" 272 | - "traefik.backend=radarr" 273 | - "traefik.http.routers.radarr.rule=Host(`radarr.${DOMAIN}`)" 274 | 275 | - "traefik.port=7878" 276 | - "traefik.docker.network=traefik_proxy" 277 | 278 | mylar: 279 | image: linuxserver/mylar 280 | container_name: mylar 281 | environment: 282 | - PUID=${PUID} 283 | - PGID=${PGID} 284 | network_mode: "traefik_proxy" 285 | volumes: 286 | - '${USERDIR}/mylar:/config' 287 | - '${USERDIR}/data/downloads/books:/downloads' 288 | - 'books_nas:/comics' 289 | labels: 290 | - "traefik.enable=true" 291 | - "traefik.backend=mylar" 292 | - "traefik.http.routers.mylar.rule=Host(`mylar.${DOMAIN}`)" 293 | - "traefik.port=8090" 294 | - "traefik.docker.network=traefik_proxy" 295 | 296 | 297 | pihole: 298 | image: pihole/pihole 299 | container_name: pihole 300 | restart: unless-stopped 301 | networks: 302 | - default 303 | - traefik_proxy 304 | ports: 305 | - '${IP_ADDRESS}:53:53/tcp' 306 | - '${IP_ADDRESS}:53:53/udp' 307 | - '${IP_ADDRESS}:8090:80/tcp' 308 | environment: 309 | - ServerIP=${IP_ADDRESS} 310 | - PUID=${PUID} 311 | - PGID=${PGID} 312 | - WEBPASSWORD="admin" 313 | - VIRTUAL_HOST=pi.${DOMAIN} 314 | - DNS1="9.9.9.9" 315 | - DNS2="149.112.112.112" 316 | 317 | volumes: 318 | - '${USERDIR}/pihole:/etc/pihole/' 319 | - '${USERDIR}/pihole/dnsmasq:/etc/dnsmasq.d/' 320 | 321 | 322 | # ------------------------------------------ 323 | # SABNZBD 324 | # 325 | # ------------------------------------------ 326 | sabnzbd: 327 | image: linuxserver/sabnzbd 328 | container_name: sabnzbd 329 | restart: unless-stopped 330 | network_mode: 'traefik_proxy' 331 | ports: 332 | - '${IP_ADDRESS}:9090:8080' 333 | environment: 334 | - PUID=${PUID} 335 | - PGID=${PGID} 336 | - VIRTUAL_HOST=sab.${DOMAIN} 337 | volumes: 338 | - '${USERDIR}/sabnzbd:/config' 339 | - '${USERDIR}/data/downloads:/downloads' 340 | - '${DATADIR}/TV:/data/tv:rw' 341 | - '${DATADIR}/unprocessed:/unprocessed:rw' 342 | - '${DATADIR}/completed:/completed:rw' 343 | - '${DATADIR}/watch:/watch' 344 | - '${DATADIR}/Movies:/data/movies:rw' 345 | - '${USERDIR}/data/downloads/unprocessed:/incomplete-downloads' 346 | - '/etc/localtime:/etc/localtime:ro' 347 | labels: 348 | - "traefik.enable=true" 349 | - "traefik.backend=sabnzbd" 350 | - "traefik.http.routers.sab.rule=Host(`sab.${DOMAIN}`)" 351 | - "traefik.port=8080" 352 | - "traefik.docker.network=traefik_proxy" 353 | 354 | 355 | hydra2: 356 | image: "linuxserver/hydra2" 357 | container_name: "hydra2" 358 | volumes: 359 | - ./hydra2:/config 360 | - '${DATADIR}/downloads:/downloads' 361 | - '${USERDIR}/hydra/completed/docker/certs:/certs' 362 | ports: 363 | - "${IP_ADDRESS}:5076:5076" 364 | restart: always 365 | environment: 366 | - PUID=${PUID} 367 | - PGID=${PGID} 368 | - TZ=${TZ} 369 | 370 | 371 | deluge: 372 | image: "linuxserver/deluge" 373 | container_name: "deluge" 374 | network_mode: 'bridge' 375 | volumes: 376 | - ./docker/deluge:/config 377 | - '${DATADIR}/downloads:/downloads:rw' 378 | - '${DATADIR}/TV:/data/tv:rw' 379 | - '${DATADIR}/completed:/completed:rw' 380 | - '${DATADIR}/watch:/watch:rw' 381 | - '/etc/localtime:/etc/localtime:ro' 382 | ports: 383 | - '${IP_ADDRESS}:8112:8112' 384 | - '${IP_ADDRESS}:8118:8118' 385 | - '${IP_ADDRESS}:58846:58846' 386 | - '${IP_ADDRESS}:58946:58946' 387 | restart: unless-stopped 388 | environment: 389 | - PUID=${PUID} 390 | - PGID=${PGID} 391 | - TZ=${TZ} 392 | - LAN_NETWORK=${CIDR_ADDRESS} 393 | 394 | 395 | # ---------------------------------------------------- 396 | # 397 | # Management Section 398 | # 399 | # 400 | # ---------------------------------------------------- 401 | 402 | # ---------------------------------------- 403 | # PORTAINER 404 | # Docker Container Management 405 | # ---------------------------------------- 406 | portainer: 407 | image: portainer/portainer:latest 408 | container_name: portainer 409 | restart: unless-stopped 410 | network_mode: 'traefik_proxy' 411 | depends_on: 412 | - traefik 413 | ports: 414 | - '${IP_ADDRESS}:9000:9000' 415 | environment: 416 | - PUID=${PUID} 417 | - PGID=${PGID} 418 | - VIRTUAL_HOST=portainer.${DOMAIN} 419 | - LETSENCRYPT_HOST=portainer.${DOMAIN} 420 | - LETSENCRYPT_EMAIL=${EMAIL} 421 | volumes: 422 | - './portainer:/data' 423 | - '/var/run/docker.sock:/var/run/docker.sock' 424 | - '/etc/localtime:/etc/localtime:ro' 425 | command: --no-auth 426 | labels: 427 | - "traefik.enable=true" 428 | - "traefik.backend=portainer" 429 | - "traefik.frontend.rule=Host:portainer.${DOMAIN}" 430 | # - "traefik.frontend.rule=Host:${DOMAINNAME}; PathPrefixStrip: /organizr" 431 | - "traefik.port=9000" 432 | - "traefik.docker.network=traefik_proxy" 433 | - "traefik.http.routers.portainer.rule=Host(`portainer.${DOMAIN}`)" 434 | 435 | # ---------------------------------------- 436 | # WATCHTOWER 437 | # Automatic Update Service for Docker VMs 438 | # ---------------------------------------- 439 | watchtower: 440 | image: containrrr/watchtower 441 | container_name: tower 442 | restart: unless-stopped 443 | environment: 444 | - TZ=${TZ} 445 | - WATCHTOWER_NOTIFICATIONS=email 446 | - WATCHTOWER_NOTIFICATION_EMAIL_FROM=${SMTP_FROM} 447 | - WATCHTOWER_NOTIFICATION_EMAIL_TO=${WATCHTOWER_EMAIL} 448 | - WATCHTOWER_NOTIFICATION_EMAIL_SERVER=${SMTP_SERVER} 449 | - WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PORT=${SMTP_PORT} 450 | - WATCHTOWER_NOTIFICATION_EMAIL_SERVER_USER=${SMTP_USER} 451 | - WATCHTOWER_NOTIFICATION_EMAIL_SERVER_PASSWORD=${SMTP_PASS} 452 | network_mode: 'bridge' 453 | volumes: 454 | - '/var/run/docker.sock:/var/run/docker.sock' 455 | - '/etc/ssl/certs:/etc/ssl/certs' 456 | command: portainer --schedule @midnight --cleanup 457 | 458 | # ---------------------------------------- 459 | # NETDATA 460 | # System Resource Monitoring Service 461 | # ---------------------------------------- 462 | netdata: 463 | image: titpetric/netdata 464 | container_name: netdata 465 | restart: unless-stopped 466 | network_mode: 'traefik_proxy' 467 | ports: 468 | - '${IP_ADDRESS}:19999:19999' 469 | environment: 470 | - PUID=${PUID} 471 | - PGID=${PGID} 472 | - VIRTUAL_HOST=netdata.${DOMAIN} 473 | - LETSENCRYPT_HOST=netdata.${DOMAIN} 474 | - LETSENCRYPT_EMAIL=${EMAIL} 475 | cap_add: 476 | - SYS_PTRACE 477 | volumes: 478 | - '/proc:/host/proc:ro' 479 | - '/sys:/host/sys:ro' 480 | - '/etc/localtime:/etc/localtime:ro' 481 | - '/var/run/docker.sock:/var/run/docker.sock' 482 | labels: 483 | - "traefik.enable=true" 484 | - "traefik.backend=netdata" 485 | - "traefik.port=19999" 486 | - "traefik.docker.network=traefik_proxy" 487 | - "traefik.http.routers.netdata.rule=Host(`netdata.${DOMAIN}`)" 488 | 489 | 490 | mariadb: 491 | image: linuxserver/mariadb 492 | container_name: mariadb 493 | networks: 494 | - traefik_proxy 495 | environment: 496 | - PUID=${PUID} 497 | - PGID=${PGID} 498 | - MYSQL_ROOT_PASSWORD=${MARIADB_ROOT_PASSWORD} 499 | - MYSQL_DATABASE=${NEXTCLOUD_DB} 500 | - MYSQL_PASSWORD=${NEXTCLOUD_DB_PASSWORD} 501 | - MYSQL_USER=${NEXTCLOUD_DB_USER} 502 | - ${MARIADB_ENTRYPOINT_INITDB}:/docker-entrypoint-initdb.d 503 | - TZ=${TZ} 504 | 505 | volumes: 506 | - './mariadb:/config' 507 | ports: 508 | - "3306:3306" 509 | restart: always 510 | 511 | openvpn-as: 512 | image: linuxserver/openvpn-as 513 | container_name: openvpn-as 514 | cap_add: 515 | - NET_ADMIN 516 | environment: 517 | - PUID=${PUID} 518 | - PGID=${PGID} 519 | - TZ=${TZ} 520 | - INTERFACE=eth0 #optional 521 | volumes: 522 | - './openvpn:/config' 523 | ports: 524 | - 943:943 525 | - 9443:9443 526 | - 1194:1194/udp 527 | labels: 528 | - "traefik.enable=true" 529 | - "traefik.backend=openvpn" 530 | - "traefik.docker.network=traefik_proxy" 531 | - "traefik.http.routers.openvpn.rule=Host(`openvpn.${DOMAIN}`)" 532 | - "traefik.http.middlewares.openvpn-https-redirect.redirectscheme.scheme=https" 533 | - "traefik.http.routers.openvpn.middlewares=openvpn-https-redirect" 534 | - "traefik.http.routers.openvpn-secure.entrypoints=web-secure" 535 | - "traefik.http.routers.openvpn-secure.rule=Host(`openvpn.${DOMAINNAME}`)" 536 | - "traefik.http.routers.openvpn-secure.tls=true" 537 | - "traefik.http.routers.openvpn-secure.tls.certresolver=http" 538 | - "traefik.http.routers.openvpn-secure.service=openvpn" 539 | - "traefik.http.services.openvpn.loadbalancer.server.port=943" 540 | 541 | restart: unless-stopped 542 | 543 | bitwarden: 544 | image: bitwardenrs/server:latest 545 | networks: 546 | - traefik_proxy 547 | environment: 548 | - SIGNUPS_ALLOWED=false 549 | - SMTP_HOST=${BW_SMTP} 550 | - SMTP_FROM=${BW_SMTP_FROM} 551 | - SMTP_PORT=${BW_SMTP_PORT} 552 | - SMTP_SSL=true 553 | - SMTP_USERNAME=${BW_SMTP_USERNAME} 554 | - SMTP_PASSWORD=${BW_SMTP_PASSWORD} 555 | - ADMIN_TOKEN=${BW_ADMIN_TOKEN} 556 | 557 | volumes: 558 | - './bw/data:/data/' 559 | labels: 560 | - "traefik.enable=true" 561 | - "traefik.backend=bitwarden" 562 | - "traefik.docker.network=traefik_proxy" 563 | - "traefik.http.routers.bitwarden.rule=Host(`bw.${DOMAIN}`)" 564 | - "traefik.http.middlewares.bitwarden-https-redirect.redirectscheme.scheme=https" 565 | - "traefik.http.routers.bitwarden.middlewares=bitwarden-https-redirect" 566 | - "traefik.http.routers.bitwarden-secure.entrypoints=web-secure" 567 | - "traefik.http.routers.bitwarden-secure.rule=Host(`bw.${DOMAINNAME}`)" 568 | - "traefik.http.routers.bitwarden-secure.tls=true" 569 | - "traefik.http.routers.bitwarden-secure.tls.certresolver=http" 570 | - "traefik.http.routers.bitwarden-secure.service=bitwarden" 571 | - "traefik.http.services.bitwarden.loadbalancer.server.port=80" 572 | 573 | nextcloud: 574 | image: nextcloud:latest 575 | networks: 576 | - traefik_proxy 577 | depends_on: 578 | - traefik 579 | - mariadb 580 | volumes: 581 | - './nextcloud/app:/var/www/html' 582 | - '/etc/localtime:/etc/localtime:ro' 583 | - 'nextcloud_htpc:/var/www/html/data' 584 | - './nextcloud/app/config:/var/www/html/config' 585 | - './nextcloud/app/custom_apps:/var/www/html/custom_apps' 586 | - './nextcloud/app/themes:/var/www/html/themes' 587 | 588 | environment: 589 | - VIRTUAL_HOST=nextcloud.${DOMAINNAME} 590 | - NEXTCLOUD_ADMIN_USER=${NEXTCLOUD_ADMIN_USER} 591 | - NEXTCLOUD_ADMIN_PASSWORD=${NEXTCLOUD_ADMIN_PASSWORD} 592 | - NEXTCLOUD_TRUSTED_DOMAINS=$NEXTCLOUD_TRUSTED_DOMAINS} 593 | labels: 594 | - "traefik.enable=true" 595 | - "traefik.backend=nextcloud" 596 | - "traefik.docker.network=traefik_proxy" 597 | - "traefik.http.routers.nextcloud.rule=Host(`nextcloud.${DOMAINNAME}`)" 598 | - "traefik.http.middlewares.nextcloud-https-redirect.redirectscheme.scheme=https" 599 | - "traefik.http.routers.nextcloud.middlewares=nextcloud-https-redirect" 600 | - "traefik.http.routers.nextcloud-secure.entrypoints=web-secure" 601 | - "traefik.http.routers.nextcloud-secure.rule=Host(`nextcloud.${DOMAINNAME}`)" 602 | - "traefik.http.routers.nextcloud-secure.tls=true" 603 | - "traefik.http.routers.nextcloud-secure.tls.certresolver=http" 604 | - "traefik.http.routers.nextcloud-secure.service=nextcloud" 605 | - "traefik.http.services.nextcloud.loadbalancer.server.port=80" 606 | restart: always 607 | 608 | 609 | networks: 610 | traefik_proxy: 611 | external: 612 | name: traefik_proxy 613 | default: 614 | driver: bridge 615 | 616 | volumes: 617 | nextcloud_htpc: 618 | driver: local 619 | driver_opts: 620 | type: nfs 621 | o: addr=diskstation.local,nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,rw,user,uid=33 622 | device: ":/volume1/nextcloud" 623 | music_nas: 624 | driver: local 625 | driver_opts: 626 | type: nfs 627 | o: addr=diskstation.local,nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,rw,user,uid=33 628 | device: ":/volume1/music" 629 | books_nas: 630 | driver: local 631 | driver_opts: 632 | type: nfs 633 | o: addr=diskstation.local,nfsvers=4.1,rsize=1048576,wsize=1048576,hard,timeo=600,retrans=2,rw 634 | device: ":/volume1/books" 635 | 636 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------