├── certs └── README ├── TestHost.sh ├── StopHost.sh ├── SetupHost.sh ├── env.template ├── SetupInstall-Centos7.sh ├── README.md ├── SetupInstall-Ubuntu.sh ├── docker-compose.yml ├── etc └── common.sh └── LICENSE /certs/README: -------------------------------------------------------------------------------- 1 | The container-based EOS/CERNBox/SWAN package comes with a self-signed certificate for serving the Web traffic over HTTPS. When connecting to the Web page, the browser will raise a warning message (e.g., "Your connection is not secure" or "Your connection is not private"). 2 | 3 | To replace the self-signed certificate with a different one, possibly issued by a trusted certification authority, please put in this folder 4 | 1. boxed.key 5 | 2. boxed.crt 6 | 7 | These two files will be copied into the Docker containers and will be loaded by the HTTP servers. 8 | -------------------------------------------------------------------------------- /TestHost.sh: -------------------------------------------------------------------------------- 1 | #! /bin/bash 2 | 3 | export RUN_FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" # This is the folder from where this scripts runs 4 | export IMAGE_NAME='gitlab-registry.cern.ch/sciencebox/docker-images/selftest:latest' 5 | 6 | echo "" 7 | echo "Setting up the tests..." 8 | 9 | echo "" 10 | echo "Pulling Docker image..." 11 | docker pull gitlab-registry.cern.ch/sciencebox/docker-images/selftest 12 | docker rm -f selftest >/dev/null 2>&1 13 | 14 | echo "" 15 | echo "Starting the container..." 16 | docker rm -f selftest >/dev/null 2>&1 17 | docker run -d -it --name selftest --network demonet --volume /var/run/docker.sock:/var/run/docker.sock:rw $IMAGE_NAME 18 | docker cp .env selftest:/root/selftest.d/.env 19 | 20 | echo "" 21 | echo "Running all tests..." 22 | echo " Logfile: # docker exec -it selftest less /root/selftest.d/test.log" 23 | docker exec -it selftest bash /root/selftest.d/run_all_tests.sh 24 | -------------------------------------------------------------------------------- /StopHost.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | export RUN_FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" # This is the folder from where this scripts runs 4 | 5 | # Import variables and functions 6 | source etc/common.sh 7 | 8 | 9 | # ----- STOP ----- # 10 | echo "" 11 | echo "WARNING: This script will terminate the running services (i.e., EOS, CERNBox, SWAN) and remove Docker containers." 12 | read -r -p "Do you want to continue [y/N] " response 13 | case "$response" in 14 | [yY]) 15 | echo "Ok." 16 | ;; 17 | *) 18 | echo "Nothing left to do. Exiting..." 19 | echo "" 20 | exit 21 | ;; 22 | esac 23 | 24 | 25 | # Preliminary Checks 26 | echo "" 27 | echo "Preliminary checks..." 28 | need_root 29 | check_required_services_are_available 30 | 31 | # Removing Containers 32 | check_single_user_container_running "stop" 33 | stop_and_remove_containers 34 | cleanup_folders_for_fusemount 35 | 36 | # Removing docker network 37 | docker_network_remove 38 | -------------------------------------------------------------------------------- /SetupHost.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | export RUN_FOLDER="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )" # This is the folder from where this scripts runs 4 | 5 | # Import variables and functions 6 | source etc/common.sh 7 | 8 | # Preliminary Checks 9 | echo "" 10 | echo "Preliminary checks..." 11 | need_root 12 | check_required_services_are_available 13 | warn_about_interfence_eos_cvmfs 14 | create_env_file 15 | 16 | # Clean-Up 17 | check_single_user_container_running "start" 18 | stop_and_remove_containers 19 | cleanup_folders_for_fusemount 20 | initialize_folders_for_fusemount 21 | 22 | # Preparation 23 | docker_network 24 | volumes_for_ldap 25 | volumes_for_eos 26 | volumes_for_mysql 27 | fetch_singleuser_notebook_image 28 | fetch_sciencebox_images 29 | check_to_have_all_images 30 | check_ports_availability 31 | set_the_locks 32 | if check_override_certificates; then 33 | copy_override_certificates 34 | fi 35 | 36 | # Run via Docker Compose 37 | echo "" 38 | echo "Run via docker-compose..." 39 | docker-compose -f $DOCKERCOMPOSE_FILE up -d 40 | 41 | # Notify the user with the progression 42 | LDAP_DONE=false 43 | EOS_MGM_DONE=false 44 | EOS_FST_DONE=false 45 | echo 46 | echo "Configuring:" 47 | echo " - Initialization" 48 | while [[ -f "$HOST_FOLDER"/usercontrol-lock ]] 49 | do 50 | if [[ ! -f "$HOST_FOLDER"/eos-mgm-lock && "$LDAP_DONE" == "false" ]]; then 51 | echo " - LDAP" 52 | LDAP_DONE=true 53 | fi 54 | if [[ ! -f "$HOST_FOLDER"/eos-fst-lock && "$EOS_MGM_DONE" == "false" ]]; then 55 | echo " - EOS headnode" 56 | EOS_MGM_DONE=true 57 | fi 58 | if [[ ! -f "$HOST_FOLDER"/eos-fuse-lock && "$EOS_FST_DONE" == "false" ]]; then 59 | echo " - EOS storage servers" 60 | EOS_FST_DONE=true 61 | fi 62 | sleep 3 63 | done 64 | 65 | echo " - CERNBox" 66 | echo " - SWAN" 67 | 68 | echo "" 69 | echo "Configuration complete!" 70 | 71 | echo "" 72 | echo "Access to log files: docker-compose logs -f" 73 | echo "Or get them sorted in time: docker-compose logs -t | sort -t '|' -k +2d" 74 | echo "--> Please source the uboxed/etc/common.sh file first! <--" 75 | 76 | -------------------------------------------------------------------------------- /env.template: -------------------------------------------------------------------------------- 1 | ## Configuration variables for Docker-compose deployment ## 2 | 3 | #--- General ---# 4 | DEPLOYMENT_TYPE=compose 5 | HOSTNAME=${HOSTNAME} 6 | HTTP_PORT=${HTTP_PORT} 7 | HTTPS_PORT=${HTTPS_PORT} 8 | HOST_FOLDER=${HOST_FOLDER} 9 | 10 | 11 | #--- LDAP ---# 12 | # Connection params 13 | LDAP_URI=ldap://ldap 14 | LDAP_PORT=389 15 | LDAP_BASE_DN=dc=sciencebox,dc=net 16 | LDAP_BIND_DN=cn=readuser,dc=sciencebox,dc=net 17 | LDAP_BIND_PASSWORD=readuser 18 | 19 | # Server config 20 | LDAP_LOG_LEVEL=none 21 | LDAP_TLS_VERIFY_CLIENT=try 22 | LDAP_ORGANISATION=ExampleInc. 23 | LDAP_DOMAIN=sciencebox.net 24 | LDAP_ADMIN_PASSWORD=admin 25 | LDAP_READONLY_USER=true 26 | LDAP_READONLY_USER_USERNAME=readuser 27 | LDAP_READONLY_USER_PASSWORD=readuser 28 | 29 | # Env vars for the `/root/adduser.sh` script (needs LDAP admins power) 30 | LDAP_ADMIN_BIND_DN=cn=admin,dc=sciencebox,dc=net 31 | LDAP_ADMIN_BIND_PASSWORD=admin 32 | 33 | 34 | #--- EOS Storage ---# 35 | # Connection params 36 | EOS_MGM_MASTER1=eos-mgm.demonet 37 | EOS_MGM_MASTER2=eos-mgm.demonet 38 | EOS_MGM_ALIAS=eos-mgm.demonet 39 | EOS_MQ_ALIAS=eos-mq.demonet 40 | EOS_MGM_ALIAS_PORT=8000 41 | 42 | # Folder Tree 43 | EOS_BASE=/eos/docker/ 44 | EOS_PREFIX=/eos/docker/user/ 45 | EOS_PROJECTPREFIX=/eos/docker/project/ 46 | EOS_METADATADIR=/eos/docker/user/.sys.dav.hide#.user.metadata/ 47 | EOS_RECYCLEDIR=/eos/docker/proc/recycle/ 48 | 49 | # FST config 50 | FST_MOUNTPOINT=/mnt/fst_userdata 51 | FST_GEOTAG=docker 52 | FST_SCHEDULING_GROUP=default 53 | 54 | 55 | #--- CERNBox ---# 56 | # Web UI 57 | CERNBOXGATEWAY_HOSTNAME=${HOSTNAME} 58 | AUTH_TYPE=local 59 | ADMINS_LIST=dummy_admin 60 | 61 | # DB 62 | DATABASE_BACKEND=mysql 63 | MYSQL_URI=cernboxmysql.demonet 64 | MYSQL_PORT=3306 65 | MYSQL_USER=cernbox_backend 66 | MYSQL_PASSWORD=cernbox_backend_1234567890 67 | MYSQL_DB=cernbox 68 | 69 | 70 | # Nginx Gateway 71 | LDAP_URI_1=ldap://ldap 72 | LDAP_URI_2=ldap://ldap 73 | ESCAPE_LANDING_PAGE=false 74 | OWNCLOUD_BACKEND=cernbox.demonet 75 | OWNCLOUD_BACKEND_PORT=443 76 | SWAN_BACKEND=${HOSTNAME} 77 | SWAN_BACKEND_PORT=${SWAN_HTTPS_PORT} 78 | WEBDAV_CLIENT_CERT_PORT=${WEBDAV_CLIENT_CERT_PORT} 79 | 80 | #webng 81 | INSTANCEID=oc1234 82 | CBOXGROUPD_SECRET=1234 83 | CBOXSWANAPID_SECRET=1234 84 | CBOXSWANAPID_SIGNKEY=1234 85 | JWTKEY=1234 86 | WOPI_SECRET=1234 87 | REVA_USERNAME=1234 88 | REVA_PASSWORD=1234 89 | 90 | #--- SWAN ---# 91 | # JupyterHub 92 | DOCKER_NETWORK_NAME=${DOCKER_NETWORK_NAME} 93 | CONTAINER_IMAGE=${NOTEBOOK_IMAGE} 94 | EOS_FOLDER=${EOS_FOLDER} 95 | CVMFS_FOLDER=${CVMFS_FOLDER} 96 | 97 | # CVMFS 98 | CVMFS_UPSTREAM_CONNECTION=direct 99 | SOFTWARE_STACK=LCG_96 100 | PLATFORM=x86_64-centos7-gcc8-opt 101 | 102 | # EOS Fuse 103 | -------------------------------------------------------------------------------- /SetupInstall-Centos7.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Import variables and functions 4 | source etc/common.sh 5 | 6 | 7 | # ----- Install the required gpu software on the host ----- # 8 | install_gpu_software() 9 | { 10 | echo "Installing nvidia-docker2..." 11 | yum install -y runc 12 | yum install -y https://nvidia.github.io/nvidia-container-runtime/centos7/x86_64/nvidia-container-runtime-"$NVIDIA_CONTAINER_RUNTIME_VERSION"-1.x86_64.rpm \ 13 | https://nvidia.github.io/libnvidia-container/centos7/x86_64/libnvidia-container1-"$LIBNVIDIA_CONTAINER_VERSION"-1.x86_64.rpm \ 14 | https://nvidia.github.io/libnvidia-container/centos7/x86_64/libnvidia-container-tools-"$LIBNVIDIA_CONTAINER_VERSION"-1.x86_64.rpm \ 15 | https://nvidia.github.io/nvidia-container-runtime/centos7/x86_64/nvidia-container-runtime-hook-"$NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION"-2.x86_64.rpm \ 16 | https://nvidia.github.io/nvidia-docker/centos7/x86_64/nvidia-docker2-"$NVIDIA_DOCKER_VERSION"-1.noarch.rpm 17 | 18 | 19 | echo "Restarting docker daemon with NVidia runtime..." 20 | service docker restart 21 | 22 | echo "Checking NVidia driver" 23 | check_nvidia_driver 24 | } 25 | 26 | # ----- Install the required software on the host ----- # 27 | install_software() 28 | { 29 | yum -y install \ 30 | wget \ 31 | git \ 32 | fuse \ 33 | net-tools \ 34 | gettext 35 | 36 | echo "Installing docker..." 37 | yum -y install https://download.docker.com/linux/centos/7/x86_64/stable/Packages/docker-ce-"$DOCKER_VERSION".ce-3.el7.x86_64.rpm 38 | 39 | echo "Installing docker-compose..." 40 | wget https://github.com/docker/compose/releases/download/"$DOCKERCOMPOSE_VERSION"/docker-compose-Linux-x86_64 -O /usr/bin/docker-compose 41 | chmod +x /usr/bin/docker-compose 42 | 43 | echo "Starting docker daemon..." 44 | service docker start 45 | docker --version 46 | docker-compose --version 47 | } 48 | 49 | # Check to be root 50 | need_root 51 | 52 | 53 | # Raise warning about software installation 54 | warn_about_software_requirements 55 | 56 | echo "" 57 | read -r -p "Do you want to proceed with the installation [y/N] " response 58 | case "$response" in 59 | [yY]) 60 | echo "Installing required software..." 61 | install_software 62 | ;; 63 | *) 64 | echo "Exiting..." 65 | exit 0 66 | ;; 67 | esac 68 | 69 | # Raise warning about GPU software installation (docker-ce should be installed) 70 | warn_about_gpu_software_requirements 71 | 72 | echo "" 73 | read -r -p "Do you want to proceed with the gpu software installation [y/N] " response 74 | case "$response" in 75 | [yY]) 76 | echo "Installing required gpu software..." 77 | install_gpu_software 78 | ;; 79 | *) 80 | echo "Continuing without GPU support" 81 | ;; 82 | esac 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Welcome to BOXED 2 | ### *UBoxed -- Single-host Demo Deployment* 3 | 4 | ----- 5 | 6 | https://cernbox.cern.ch/cernbox/doc/boxed 7 | 8 | Self-contained, containerized demo for next-generation cloud storage and computing services for scientific and general-purpose use: 9 | 10 | - CERNBox: https://cernbox.web.cern.ch 11 | - EOS: https://eos.web.cern.ch 12 | - SWAN: https://swan.web.cern.ch 13 | - CVMFS: https://cvmfs.web.cern.ch 14 | 15 | 16 | Packaging by: Enrico Bocchi, Hugo Gonzalez Labrador, Jozsef Makai, Jakub T. Moscicki 17 | 18 | 19 | ----- 20 | 21 | ### Quick setup 22 | 23 | 1. Install required software on the host: 24 | 25 | For CentOS7: `./SetupInstall-Centos7.sh` 26 | 27 | For Ubuntu: `./SetupInstall-Ubuntu.sh` 28 | 29 | Please check [*] for supported OS versions. 30 | 31 | 32 | 2. Setup and initialize all services: 33 | 34 | `./SetupHost.sh` 35 | 36 | 37 | 3. Quick test of the services: 38 | 39 | `./TestHost.sh` 40 | 41 | 42 | 4. Go to: https://yourhost.yourdomain 43 | 44 | 45 | 46 | ### Stop services 47 | 48 | 1. If you executed TestHost.sh at step 3 of the setup procedure, please stop the test container: 49 | 50 | `docker stop selftest` 51 | 52 | `docker rm selftest` 53 | 54 | 55 | 2. Run the dedicated script: 56 | 57 | `./StopHost.sh` 58 | 59 | 60 | 61 | ### Remove Docker images and volumes 62 | 63 | 1. Remove Docker images manually with: 64 | 65 | `docker rmi cernbox cernboxgateway eos-controller eos-storage ldap swan_cvmfs swan_eos-fuse swan_jupyterhub selftest cernphsft/systemuser:v2.10 cern/cc7-base:20170920` 66 | 67 | 68 | 2. Remove Docker volumes 69 | 70 | WARNING: This will delete user's data! 71 | 72 | `docker volume rm cernbox_shares_db ldap_config ldap_database eos-fst1 eos-fst1_userdata eos-fst2 eos-fst2_userdata eos-fst3 eos-fst3_userdata eos-fst4 eos-fst4_userdata eos-fst5 eos-fst5_userdata eos-fst6 eos-fst6_userdata eos-mgm eos-mq` 73 | 74 | 75 | 76 | ----- 77 | 78 | #### *Enjoy and give feedback to CERN/IT and CERN/EP.* 79 | 80 | ----- 81 | 82 | 83 | *\*Host OS Support* 84 | 85 | We test this package on CentOS 7.3 and Ubuntu 17.04 hosts and we recommend to use one of these two OSes. 86 | The deployment on Ubuntu 14.04 and 16.04 requires the modification of the Docker storage driver to devicemapper. 87 | 88 | For other OSes you may need some extra work (and sweat or tears). 89 | We are happy to hear from you and eventually include instructions for other OSes. 90 | 91 | 92 | Required software on the host: 93 | 94 | - install wget, fuse 95 | - install docker (version 17.03.1-ce or greater) 96 | - install docker-compose (version 1.11.2 or greater) 97 | 98 | ----- 99 | 100 | Copyright 2017, CERN. 101 | 102 | AGPL License (http://www.gnu.org/licenses/agpl-3.0.html) 103 | 104 | -------------------------------------------------------------------------------- /SetupInstall-Ubuntu.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Import variables and functions 4 | source etc/common.sh 5 | 6 | # ----- Install the required gpu software on the host ----- # 7 | install_gpu_software() 8 | { 9 | 10 | echo "Installing nvidia-docker2..." 11 | apt-get install -y runc 12 | 13 | distribution=$(. /etc/os-release;echo $ID$VERSION_ID) 14 | wget https://nvidia.github.io/libnvidia-container/"$distribution"/amd64/libnvidia-container1_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb -O /tmp/libnvidia-container1_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb 15 | wget https://nvidia.github.io/libnvidia-container/"$distribution"/amd64/libnvidia-container-tools_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb -O /tmp/libnvidia-container-tools_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb 16 | wget https://nvidia.github.io/nvidia-container-runtime/"$distribution"/amd64/nvidia-container-runtime-hook_"$NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION"-1_amd64.deb -O /tmp/nvidia-container-runtime-hook_"$NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION"-1_amd64.deb 17 | wget https://nvidia.github.io/nvidia-container-runtime/"$distribution"/amd64/nvidia-container-runtime_"$NVIDIA_CONTAINER_RUNTIME_VERSION"-1_amd64.deb -O /tmp/nvidia-container-runtime_"$NVIDIA_CONTAINER_RUNTIME_VERSION"-1_amd64.deb 18 | wget https://nvidia.github.io/nvidia-docker/"$distribution"/amd64/nvidia-docker2_"$NVIDIA_DOCKER_VERSION"-1_all.deb -O /tmp/nvidia-docker2_"$NVIDIA_DOCKER_VERSION"-1_all.deb 19 | 20 | dpkg -i /tmp/libnvidia-container1_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb \ 21 | /tmp/libnvidia-container-tools_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb \ 22 | /tmp/nvidia-container-runtime-hook_"$NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION"-1_amd64.deb \ 23 | /tmp/nvidia-container-runtime_"$NVIDIA_CONTAINER_RUNTIME_VERSION"-1_amd64.deb \ 24 | /tmp/nvidia-docker2_"$NVIDIA_DOCKER_VERSION"-1_all.deb 25 | 26 | rm /tmp/libnvidia-container1_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb \ 27 | /tmp/libnvidia-container-tools_"$LIBNVIDIA_CONTAINER_VERSION"-1_amd64.deb \ 28 | /tmp/nvidia-container-runtime-hook_"$NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION"-1_amd64.deb \ 29 | /tmp/nvidia-container-runtime_"$NVIDIA_CONTAINER_RUNTIME_VERSION"-1_amd64.deb \ 30 | /tmp/nvidia-docker2_"$NVIDIA_DOCKER_VERSION"-1_all.deb 31 | 32 | echo "Restarting docker daemon with NVidia runtime..." 33 | service docker restart 34 | 35 | echo "Checking NVidia driver" 36 | check_nvidia_driver 37 | 38 | } 39 | 40 | # ----- Install the required software on the host ----- # 41 | install_software() 42 | { 43 | apt-get install \ 44 | wget \ 45 | git \ 46 | fuse \ 47 | net-tools \ 48 | gettext 49 | 50 | echo "Installing docker..." 51 | wget https://download.docker.com/linux/ubuntu/dists/`lsb_release -c -s`/pool/stable/amd64/docker-ce_"$DOCKER_VERSION"~ce~3-0~ubuntu_amd64.deb -O /tmp/docker-ce.deb 52 | dpkg -i /tmp/docker-ce.deb 53 | rm -f /tmp/docker-ce.deb 54 | 55 | echo "Installing docker-compose..." 56 | wget https://github.com/docker/compose/releases/download/"$DOCKERCOMPOSE_VERSION"/docker-compose-`uname -s`-`uname -m` -O /usr/bin/docker-compose 57 | chmod +x /usr/bin/docker-compose 58 | 59 | echo "Starting docker daemon..." 60 | service docker start 61 | docker --version 62 | docker-compose --version 63 | } 64 | 65 | # Check to be root 66 | need_root 67 | 68 | 69 | # Raise warning about software installation 70 | warn_about_software_requirements 71 | 72 | echo "" 73 | read -r -p "Do you want to proceed with the installation [y/N] " response 74 | case "$response" in 75 | [yY]) 76 | echo "Installing required software..." 77 | install_software 78 | ;; 79 | *) 80 | echo "Exiting..." 81 | exit 0 82 | ;; 83 | esac 84 | 85 | # Raise warning about GPU software installation (docker-ce should be installed) 86 | warn_about_gpu_software_requirements 87 | 88 | echo "" 89 | read -r -p "Do you want to proceed with the gpu software installation [y/N] " response 90 | case "$response" in 91 | [yY]) 92 | echo "Installing required gpu software..." 93 | install_gpu_software 94 | ;; 95 | *) 96 | echo "Continuing without GPU support" 97 | ;; 98 | esac 99 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | # docker-compose configuration file 2 | version: "2" 3 | 4 | # CONTAINERS 5 | services: 6 | 7 | #--- LDAP ---# 8 | # Local user database. All services have a unified view on user accounts. 9 | ldap: 10 | image: gitlab-registry.cern.ch/cernbox/boxedhub/ldap:v0.3 11 | container_name: ldap 12 | hostname: ldap 13 | #domainname: demonet 14 | volumes: 15 | - ${LDAP_DB}:/var/lib/ldap 16 | - ${LDAP_CF}:/etc/ldap/slapd.d 17 | env_file: 18 | - .env 19 | 20 | # Add demo users on the LDAP server 21 | ldap-ldapadd: 22 | image: gitlab-registry.cern.ch/cernbox/boxedhub/ldap:v0.3 23 | container_name: ldap-add 24 | depends_on: 25 | - ldap 26 | links: 27 | - ldap 28 | volumes: 29 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 30 | env_file: 31 | - .env 32 | entrypoint: bash /root/addusers.sh 33 | 34 | 35 | #--- EOS Storage ---# 36 | # EOS Server: One headnote (MGM - namespace + management), one message queue (MQ), four storage servers (FST) 37 | eos-mgm: 38 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 39 | container_name: eos-mgm 40 | hostname: eos-mgm 41 | domainname: demonet 42 | cap_add: 43 | - SYS_PTRACE 44 | volumes: 45 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 46 | - ${EOS_MGM}:/var/eos 47 | env_file: 48 | - .env 49 | environment: 50 | EOS_ROLE: "mgm" 51 | 52 | eos-mq: 53 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 54 | container_name: eos-mq 55 | hostname: eos-mq 56 | domainname: demonet 57 | cap_add: 58 | - SYS_PTRACE 59 | volumes: 60 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 61 | - ${EOS_MQ}:/var/eos 62 | env_file: 63 | - .env 64 | environment: 65 | EOS_ROLE: "mq" 66 | 67 | eos-fst1: 68 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 69 | container_name: eos-fst1 70 | hostname: eos-fst1 71 | domainname: demonet 72 | cap_add: 73 | - SYS_PTRACE 74 | volumes: 75 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 76 | - ${EOS_FST_1}:/var/eos 77 | - ${EOS_FST_USERDATA_1}:/${FST_MOUNTPOINT} 78 | env_file: 79 | - .env 80 | environment: 81 | EOS_ROLE: "fst" 82 | 83 | eos-fst2: 84 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 85 | container_name: eos-fst2 86 | hostname: eos-fst2 87 | domainname: demonet 88 | cap_add: 89 | - SYS_PTRACE 90 | volumes: 91 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 92 | - ${EOS_FST_2}:/var/eos 93 | - ${EOS_FST_USERDATA_2}:/${FST_MOUNTPOINT} 94 | env_file: 95 | - .env 96 | environment: 97 | EOS_ROLE: "fst" 98 | 99 | eos-fst3: 100 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 101 | container_name: eos-fst3 102 | hostname: eos-fst3 103 | domainname: demonet 104 | cap_add: 105 | - SYS_PTRACE 106 | volumes: 107 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 108 | - ${EOS_FST_3}:/var/eos 109 | - ${EOS_FST_USERDATA_3}:/${FST_MOUNTPOINT} 110 | env_file: 111 | - .env 112 | environment: 113 | EOS_ROLE: "fst" 114 | 115 | eos-fst4: 116 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-storage:v0.9 117 | container_name: eos-fst4 118 | hostname: eos-fst4 119 | domainname: demonet 120 | cap_add: 121 | - SYS_PTRACE 122 | volumes: 123 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 124 | - ${EOS_FST_4}:/var/eos 125 | - ${EOS_FST_USERDATA_4}:/${FST_MOUNTPOINT} 126 | env_file: 127 | - .env 128 | environment: 129 | EOS_ROLE: "fst" 130 | 131 | 132 | #--- CERNBox ---# 133 | # Web User Interface (httpd, php, sqlite) 134 | cernbox: 135 | image: gitlab-registry.cern.ch/cernbox/boxedhub/cernbox:v1.4 136 | container_name: cernbox 137 | hostname: cernbox 138 | domainname: demonet 139 | volumes: 140 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 141 | env_file: 142 | - .env 143 | 144 | cernboxmysql: 145 | image: gitlab-registry.cern.ch/cernbox/boxedhub/cernboxmysql:v1.0 146 | container_name: cernboxmysql 147 | hostname: cernboxmysql 148 | domainname: demonet 149 | volumes: 150 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 151 | - ${CERNBOX_MYSQL}:/var/lib/mysql 152 | env_file: 153 | - .env 154 | 155 | # Nginx gateway 156 | cernboxgateway: 157 | image: gitlab-registry.cern.ch/cernbox/boxedhub/cernboxgateway:v1.1 158 | container_name: cernboxgateway 159 | hostname: cernboxgateway 160 | domainname: demonet 161 | ports: 162 | - ${HTTP_PORT}:80 163 | - ${HTTPS_PORT}:443 164 | volumes: 165 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 166 | env_file: 167 | - .env 168 | 169 | 170 | #--- SWAN ---# 171 | # Jupyterhub: User authentication and session management 172 | jupyterhub: 173 | image: gitlab-registry.cern.ch/swan/docker-images/jupyterhub:v1.9 174 | container_name: jupyterhub 175 | ports: 176 | - ${SWAN_HTTPS_PORT}:443 177 | volumes: 178 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 179 | - /var/run/docker.sock:/var/run/docker.sock:rw 180 | env_file: 181 | - .env 182 | 183 | # Cern VM FileSystem: Access to scientific libraries via the WLCG 184 | cvmfs: 185 | image: gitlab-registry.cern.ch/cernbox/boxedhub/cvmfs:v0.5 186 | container_name: cvmfs 187 | cap_add: 188 | - SYS_ADMIN 189 | devices: 190 | - /dev/fuse 191 | security_opt: 192 | - apparmor=unconfined 193 | volumes: 194 | - ${CVMFS_FOLDER}:/cvmfs:shared 195 | env_file: 196 | - .env 197 | 198 | # EOS-Fuse: Access to EOS storage (same as CERNBox) 199 | eos-fuse: 200 | image: gitlab-registry.cern.ch/cernbox/boxedhub/eos-fuse:v0.8 201 | container_name: eos-fuse 202 | hostname: eos-fuse 203 | domainname: demonet 204 | cap_add: 205 | - SYS_ADMIN 206 | devices: 207 | - /dev/fuse 208 | pid: host 209 | security_opt: 210 | - apparmor=unconfined 211 | volumes: 212 | - ${HOST_FOLDER}:${HOST_FOLDER}:z 213 | - /sys/fs/cgroup 214 | - ${EOS_FOLDER}:/eos:shared 215 | env_file: 216 | - .env 217 | 218 | 219 | 220 | # NETWORKS 221 | networks: 222 | default: 223 | external: 224 | name: demonet 225 | 226 | 227 | 228 | # VOLUMES 229 | volumes: 230 | 231 | # LDAP 232 | ldap_database: 233 | external: 234 | name: ${LDAP_DB} 235 | ldap_config: 236 | external: 237 | name: ${LDAP_CF} 238 | 239 | # EOS 240 | eos-fst_1: 241 | external: 242 | name: ${EOS_FST_1} 243 | eos-fst_userdata_1: 244 | external: 245 | name: ${EOS_FST_USERDATA_1} 246 | 247 | eos-fst_2: 248 | external: 249 | name: ${EOS_FST_2} 250 | eos-fst_userdata_2: 251 | external: 252 | name: ${EOS_FST_USERDATA_2} 253 | 254 | eos-fst_3: 255 | external: 256 | name: ${EOS_FST_3} 257 | eos-fst_userdata_3: 258 | external: 259 | name: ${EOS_FST_USERDATA_3} 260 | 261 | eos-fst_4: 262 | external: 263 | name: ${EOS_FST_4} 264 | eos-fst_userdata_4: 265 | external: 266 | name: ${EOS_FST_USERDATA_4} 267 | 268 | eos-mgm: 269 | external: 270 | name: ${EOS_MGM} 271 | 272 | eos-mq: 273 | external: 274 | name: ${EOS_MQ} 275 | 276 | # CERNBox 277 | cernbox_mysql: 278 | external: 279 | name: ${CERNBOX_MYSQL} 280 | 281 | -------------------------------------------------------------------------------- /etc/common.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # Shared variables and functions 3 | 4 | 5 | #--- Global Settings ---# 6 | # Host network parameters 7 | export HOSTNAME=`hostname --fqdn` 8 | export HTTP_PORT=80 9 | export HTTPS_PORT=443 10 | export SWAN_HTTPS_PORT=8443 11 | export WEBDAV_CLIENT_CERT_PORT=4443 12 | 13 | # Temporary work folder on the host 14 | export HOST_FOLDER="/tmp/sciencebox" 15 | export EOS_FOLDER=$HOST_FOLDER"/eos_mount" 16 | export EOS_MOUNT=$EOS_FOLDER"/docker" 17 | export CVMFS_FOLDER=$HOST_FOLDER"/cvmfs_mount" 18 | export CERTS_FOLDER=$HOST_FOLDER"/certs" 19 | WARNING_FILE=$HOST_FOLDER"/DO_NOT_WRITE_ANY_FILE_HERE" 20 | 21 | # Single-user notebook image 22 | export NOTEBOOK_IMAGE="gitlab-registry.cern.ch/swan/docker-images/systemuser:v5.2.0" 23 | 24 | # Docker network 25 | export DOCKER_NETWORK_NAME="demonet" 26 | 27 | # Docker volumes 28 | export LDAP_DB="ldap_database" 29 | export LDAP_CF="ldap_config" 30 | 31 | export EOS_MGM="eos-mgm" 32 | export EOS_MQ="eos-mq" 33 | for i in {1..4} 34 | do 35 | export EOS_FST_$i="eos-fst_"$i 36 | export EOS_FST_USERDATA_$i="eos-fst_userdata_"$i 37 | done 38 | 39 | export CERNBOX_MYSQL="cernbox_mysql" 40 | 41 | # Template file 42 | ENV_TEMPLATE="env.template" 43 | 44 | # Docker-compose file 45 | DOCKERCOMPOSE_FILE="docker-compose.yml" 46 | 47 | # Software version 48 | export DOCKER_VERSION="18.06.3" # Since 2019-02-19 (Required for GPU support) 49 | export DOCKERCOMPOSE_VERSION="1.20.0" # Since 2018-08-13 50 | export NVIDIA_DOCKER_VERSION="2.1.0" 51 | export LIBNVIDIA_CONTAINER_VERSION="1.0.2" 52 | export NVIDIA_CONTAINER_RUNTIME_VERSION="3.0.0" 53 | export NVIDIA_CONTAINER_RUNTIME_HOOK_VERSION="1.4.0" 54 | 55 | 56 | # Lock files 57 | LOCK_FILES="eos-mgm-lock eos-fst-lock eos-fuse-lock cernbox-lock cernboxgateway-lock usercontrol-lock" 58 | 59 | 60 | 61 | # ----- Functions ----- # 62 | 63 | ### Preliminary Checks 64 | 65 | # Check to be root 66 | function need_root { 67 | if [ "$EUID" -ne 0 ]; then 68 | echo "Please run as root" 69 | exit 1 70 | fi 71 | } 72 | 73 | # Check we have required services and tools 74 | function check_required_services_are_available { 75 | # Check docker daemon in running state 76 | if [ "`pgrep docker`" == "" ]; then 77 | echo "Docker daemon is not running. Cannot continue." 78 | exit 1 79 | fi 80 | 81 | # Check docker-compose is available and returns something when asking for version 82 | if [ ! -f /usr/bin/docker-compose ] || [ "`docker-compose --version`" == "" ]; then 83 | echo "Docker-compose is not available. Cannot continue." 84 | exit 1 85 | fi 86 | 87 | echo "All required services are available." 88 | } 89 | 90 | # Print a warning about the required software on the host 91 | function warn_about_software_requirements { 92 | echo "" 93 | echo "The following software will be installed or updated:" 94 | echo -e "\t- wget" 95 | echo -e "\t- git" 96 | echo -e "\t- fuse" 97 | echo -e "\t- netstat" 98 | echo -e "\t- envsubst" 99 | echo -e "\t- docker (version $DOCKER_VERSION)" 100 | echo -e "\t- docker-compose (version $DOCKERCOMPOSE_VERSION)" 101 | } 102 | 103 | # Print a warning about the required software on the host for GPU 104 | function warn_about_gpu_software_requirements { 105 | echo "" 106 | echo "The following software will be installed or updated for GPU support:" 107 | echo -e "\t- runc" 108 | echo -e "\t- nvidia-docker2" 109 | echo -e "\t- nvidia-container-runtime" 110 | echo -e "\t- libnvidia-container1" 111 | echo -e "\t- libnvidia-container-tools" 112 | echo -e "\t- nvidia-container-runtime-hook" 113 | } 114 | 115 | 116 | # Print a warning about potential interference with EOS || CVMFS processes running on the host 117 | function warn_about_interfence_eos_cvmfs { 118 | echo "" 119 | echo "WARNING: The deployment interferes with eventual CVMFS and EOS clients running on the host." 120 | echo "All the running clients will be killed before proceeding." 121 | read -r -p "Do you want to continue [y/N] " response 122 | case "$response" in 123 | [yY]) 124 | echo "Ok." 125 | ;; 126 | *) 127 | echo "Exiting..." 128 | echo "" 129 | exit 1 130 | ;; 131 | esac 132 | } 133 | 134 | # Create Environment file with variables defined above 135 | function create_env_file { 136 | echo "" 137 | echo "Creating environment file..." 138 | envsubst < $ENV_TEMPLATE > .env 139 | } 140 | 141 | 142 | 143 | ### Clean-Up 144 | 145 | # Warn about single-user servers running 146 | function check_single_user_container_running { 147 | RUNNING_CONTAINERS=`docker ps -a | tail -n+2 | awk '{print $NF}' | grep '^jupyter-' | tr '\n' ' '` 148 | 149 | if [[ -z $RUNNING_CONTAINERS ]]; 150 | then 151 | return 0 152 | else 153 | echo "" 154 | echo "WARNING: The following SWAN user's servers are in execution" 155 | for i in $RUNNING_CONTAINERS; do echo " - $i"; done 156 | 157 | echo "" 158 | if [[ "$1" == "start" ]]; then 159 | echo "Please consider that their normal operation might be interrupted or that they might prevent some services to restart." 160 | elif [[ "$1" == "stop" ]]; then 161 | echo "Please consider that their normal operation will be interrupted." 162 | fi 163 | 164 | echo "It is recommended to stop SWAN user's servers before proceeding." 165 | read -r -p "Do you want to continue anyway [y/N] " response 166 | case "$response" in 167 | [yY]) 168 | echo "Ok." 169 | return 0 170 | ;; 171 | *) 172 | echo "Exiting..." 173 | echo "" 174 | exit 175 | ;; 176 | esac 177 | fi 178 | } 179 | 180 | # Remove old containers 181 | function stop_and_remove_containers { 182 | # WARNING: This is not going to work in case a single-user server is still running, e.g., jupyter-userN 183 | # Single-user's servers keep CVMFS and EOS locked due to internal mount 184 | echo "" 185 | echo "Removing existing containers (if any)..." 186 | if [ -z $1 ]; then 187 | docker-compose down -v 188 | else 189 | docker-compose -f $1 down -v 190 | fi 191 | } 192 | 193 | 194 | # Remove folders with EOS || CVMFS fuse mount on the host 195 | function cleanup_folders_for_fusemount { 196 | echo "" 197 | echo "Cleaning up folders..." 198 | #killall cvmfs2 2>/dev/null 199 | #killall eos 2>/dev/null 200 | #sleep 1 201 | 202 | if [[ -d $HOST_FOLDER ]]; 203 | then 204 | # Unmount and remove CVMFS 205 | for i in `ls $CVMFS_FOLDER` 206 | do 207 | fusermount -u $CVMFS_FOLDER/$i 208 | rmdir $CVMFS_FOLDER/$i 209 | done 210 | fusermount -u $CVMFS_FOLDER 211 | rmdir $CVMFS_FOLDER 212 | 213 | # Unmount and remove EOS 214 | while [[ ! -z `mount -l | grep $EOS_FOLDER | head -n 1` ]]; 215 | do 216 | fusermount -u $EOS_MOUNT 217 | fusermount -u $EOS_FOLDER 218 | done 219 | rmdir $EOS_MOUNT 220 | rmdir $EOS_FOLDER 221 | 222 | # Remove certificates (making sure to have the folder first) 223 | if [ -d $CERTS_FOLDER ]; then 224 | rm "$CERTS_FOLDER"/boxed.key 225 | rm "$CERTS_FOLDER"/boxed.crt 226 | rmdir $CERTS_FOLDER 227 | fi 228 | 229 | # Remove the lock files 230 | for i in $LOCK_FILES 231 | do 232 | rm "$HOST_FOLDER/$i" 233 | done 234 | 235 | # Remove the warning file 236 | rm $WARNING_FILE 237 | 238 | # Remove the entire directory 239 | rmdir $HOST_FOLDER 240 | fi 241 | } 242 | 243 | # Re-initialize folders with EOS || CVMFS fuse mount 244 | function initialize_folders_for_fusemount { 245 | echo "" 246 | echo "Initializing folders..." 247 | mkdir -p $HOST_FOLDER 248 | touch $WARNING_FILE 249 | 250 | # Explicitly set CVMFS and EOS folders as shared 251 | for i in $CVMFS_FOLDER $EOS_FOLDER 252 | do 253 | mkdir -p $i 254 | mount --bind $i $i 255 | mount --make-shared $i 256 | done 257 | } 258 | 259 | 260 | 261 | ### Preparation 262 | # Check to have (or create) a Docker network to allow communications among containers 263 | function docker_network { 264 | echo "" 265 | echo "Setting up Docker network..." 266 | docker network inspect $DOCKER_NETWORK_NAME >/dev/null 2>&1 || docker network create $DOCKER_NETWORK_NAME 267 | docker network inspect $DOCKER_NETWORK_NAME 268 | } 269 | 270 | # Initialize volumes for LDAP --> Make user accounts persistent 271 | function volumes_for_ldap { 272 | echo "" 273 | echo "Initialize Docker volume for LDAP..." 274 | docker volume inspect $LDAP_DB >/dev/null 2>&1 || docker volume create --name $LDAP_DB 275 | docker volume inspect $LDAP_CF >/dev/null 2>&1 || docker volume create --name $LDAP_CF 276 | } 277 | 278 | # Initialize volumes for EOS --> Make storage persistent 279 | function volumes_for_eos { 280 | echo "" 281 | echo "Initialize Docker volumes for EOS..." 282 | docker volume inspect $EOS_MQ >/dev/null 2>&1 || docker volume create --name $EOS_MQ 283 | docker volume inspect $EOS_MGM >/dev/null 2>&1 || docker volume create --name $EOS_MGM 284 | for i in {1..4} 285 | do 286 | metadata_volume=EOS_FST_"$i" 287 | docker volume inspect ${!metadata_volume} >/dev/null 2>&1 || docker volume create --name ${!metadata_volume} 288 | userdata_volume=EOS_FST_USERDATA_"$i" 289 | docker volume inspect ${!userdata_volume} >/dev/null 2>&1 || docker volume create --name ${!userdata_volume} 290 | done 291 | } 292 | 293 | # Initialize volumes from CERNBox --> Make sharing settings persistent 294 | function volumes_for_mysql { 295 | echo "" 296 | echo "Initialize Docker volume for CERNBox..." 297 | docker volume inspect $CERNBOX_MYSQL >/dev/null 2>&1 || docker volume create --name $CERNBOX_MYSQL 298 | } 299 | 300 | # Pull single-user notebook image 301 | function fetch_singleuser_notebook_image { 302 | echo "" 303 | echo "Pulling Single-User notebook image..." 304 | docker pull $NOTEBOOK_IMAGE 305 | } 306 | 307 | # Pull ScienceBox images 308 | function fetch_sciencebox_images { 309 | echo "" 310 | echo "Pulling system component images..." 311 | 312 | SCIENCEBOX_IMAGES=`cat $DOCKERCOMPOSE_FILE | grep "image:" | sed -e 's/^[[:space:]]*//' | cut -d ' ' -f 2 | sort | uniq | tr '\n' ' '` 313 | for i in $SCIENCEBOX_IMAGES 314 | do 315 | docker pull $i 316 | done 317 | } 318 | 319 | # Check to have all the needed images 320 | function check_to_have_images { 321 | # Contrast two arrays checking that all elements of the first appear in the second one 322 | # Input: $1==required_images (as array) $2==available_images (as array) 323 | declare -a required=("${!1}") 324 | declare -a available=("${!2}") 325 | 326 | for req in "${required[@]}"; 327 | do 328 | found=0 329 | for ava in "${available[@]}"; 330 | do 331 | if [[ "$req" == "$ava" ]]; 332 | then 333 | found=1 334 | break 335 | fi 336 | done 337 | if [[ "$found" -eq "0" ]]; 338 | then 339 | echo "Unable to find $req image locally. Cannot continue." 340 | exit 1 341 | fi 342 | done 343 | } 344 | 345 | function check_to_have_all_images { 346 | echo "" 347 | echo "Check to have all the required images..." 348 | 349 | read -r -a LOCAL_IMAGES <<< `docker image ls | tail -n+2 | awk '{print $1":"$2}' | tr '\n' ' '` 350 | 351 | read -r -a SCIENCEBOX_LIST <<< "$SCIENCEBOX_IMAGES" 352 | check_to_have_images SCIENCEBOX_LIST[@] LOCAL_IMAGES[@] 353 | 354 | read -r -a NOTEBOOK_LIST <<< "$NOTEBOOK_IMAGE" 355 | check_to_have_images NOTEBOOK_LIST[@] LOCAL_IMAGES[@] 356 | 357 | echo "Ok." 358 | } 359 | 360 | function check_ports_availability { 361 | echo "" 362 | echo "Check availability of ports $HTTP_PORT and $HTTPS_PORT..." 363 | netstat -ltnp | grep "tcp" | grep -v "^tcp6" | while read -r line; 364 | do 365 | port_no=`echo $line | tr -s ' ' | cut -d ' ' -f 4 | cut -d ':' -f 2` 366 | process=`echo $line | tr -s ' ' | cut -d ' ' -f 7-` 367 | 368 | if [[ "$port_no" -eq "$HTTP_PORT" || "$port_no" -eq "$HTTPS_PORT" ]]; 369 | then 370 | echo "Port $port_no is being used by process $process. Cannot continue." 371 | echo "Please stop the process or set another port in etc/common.sh" 372 | exit 1 373 | fi 374 | done 375 | [[ $? != 0 ]] && exit $? 376 | 377 | echo "Ok." 378 | } 379 | 380 | # Set locks to control dependencies and execution order 381 | function set_the_locks { 382 | echo "" 383 | echo "Setting up locks..." 384 | for i in $LOCK_FILES 385 | do 386 | touch "$HOST_FOLDER/$i" 387 | done 388 | } 389 | 390 | # Check if you have certificates for replacing the default ones in Docker images 391 | function check_override_certificates { 392 | echo "" 393 | echo "Checking the availability of new certificates for HTTPS..." 394 | if [[ -f "$RUN_FOLDER"/certs/boxed.crt && -f "$RUN_FOLDER"/certs/boxed.key ]]; then 395 | return 0 396 | fi 397 | return 1 398 | } 399 | 400 | # (If needed) Copy the available certificates for HTTPS in the temporary folder 401 | function copy_override_certificates { 402 | echo "Copying new certificates for HTTPS..." 403 | mkdir -p $CERTS_FOLDER 404 | cp "$RUN_FOLDER"/certs/boxed.crt "$CERTS_FOLDER"/boxed.crt 405 | cp "$RUN_FOLDER"/certs/boxed.key "$CERTS_FOLDER"/boxed.key 406 | } 407 | 408 | 409 | 410 | ### Stop Services 411 | 412 | # Remove docker network 413 | function docker_network_remove { 414 | echo "" 415 | echo "Removing Docker network $DOCKER_NETWORK_NAME" 416 | 417 | # Check the network exists 418 | docker network inspect $DOCKER_NETWORK_NAME > /dev/null 2>&1 419 | if [[ "$?" -gt "0" ]]; then 420 | echo "Docker network $DOCKER_NETWORK_NAME does not exist." 421 | return 0 422 | else 423 | # If exists, check for connected containers 424 | docker network inspect $DOCKER_NETWORK_NAME | grep "\"Containers\": {}" >/dev/null 2>&1 425 | if [[ "$?" -gt 0 ]]; then 426 | echo "Cannot remove Docker network $DOCKER_NETWORK_NAME" 427 | echo "Some containers are still connected to it." 428 | docker network inspect $DOCKER_NETWORK_NAME 429 | return 1 430 | else 431 | # If exists and no connected containers, remove it! 432 | docker network remove $DOCKER_NETWORK_NAME 433 | return 0 434 | fi 435 | fi 436 | } 437 | 438 | ### Check Nvidia kernel driver 439 | check_nvidia_driver() 440 | { 441 | echo "Checking if the kernel driver is loaded " 442 | if lsmod | grep "nvidia" &> /dev/null ; then 443 | echo "===========================================================" 444 | echo "NVidia kernel driver is loaded!" 445 | echo "===========================================================" 446 | else 447 | echo "===========================================================" 448 | echo "WARNING: NVidia kernel driver is not loaded!" 449 | echo "GPU support will not work, configure your GPU driver first." 450 | echo "===========================================================" 451 | fi 452 | } 453 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 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 Affero General Public License is a free, copyleft license for 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------