install_re2o.sh 30.1 KB
Newer Older
1
#!/bin/bash
2

3 4
SETTINGS_LOCAL_FILE='re2o/settings_local.py'
SETTINGS_EXAMPLE_FILE='re2o/settings_local.example.py'
5

6

7 8 9 10 11 12 13 14 15 16 17 18 19
VALUE= # global value used to return values by some functions

_ask_value() {
    ### Usage _ask_value <text> [<option1> [<option2> ... ] ]
    #
    #   This function is a utility function to force a user to enter a value
    #   available in a set of options.
    #
    #   Parameters:
    #     * text: The text to display
    #     * option#: A possible option for the user. If no option is specifed,
    #       all inputs are considered valid
    #
20
    #   Echo: The value entered by the user. Should be one of the choices if
21 22 23 24 25 26 27 28 29 30
    #     not ommited
    ###

    shopt -s extglob

    input_text="$1"
    shift
    if [ "$#" -ne 0 ]; then
        choices="("
        while [ "$#" -ne 1 ]; do
31
            choices+="$1|"
32 33
            shift
        done
34 35 36
        choices+="$1)"
        input_text+=" $choices: "
        choices="@$choices"
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
    else
        input_text+=": "
        choices="@(*)"
    fi

    while true; do
        read -p "$input_text" choice
        case "$choice" in
            $choices ) break;;
            * ) echo "Invalid option";;
        esac
    done

    VALUE="$choice"
}


54

55 56 57 58
install_requirements() {
    ### Usage: install_requirements 
    #
    #   This function will install the required packages from APT repository
59
    #   and Pypi repository. Those packages are all required for Re2o to work
60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
    #   properly.
    ###

    echo "Setting up the required packages ..."
    apt-get -y install \
        python3-django \
        python3-dateutil \
        texlive-latex-base \
        texlive-fonts-recommended \
        python3-djangorestframework \
        python3-django-reversion \
        python3-pip \
        libsasl2-dev libldap2-dev \
        libssl-dev \
        python3-crypto \
        python3-git \
        javascript-common \
        libjs-jquery \
        libjs-jquery-ui \
        libjs-jquery-timepicker \
        libjs-bootstrap
    pip3 install django-bootstrap3 django-ldapdb==0.9.0 django-macaddress
    echo "Setting up the required packages: Done"
}



install_database() {
    ### Usage: install_database <engine_type> <local_setup> <db_name> <username> <password>
    #
    #   This function will install the database by downloading the correct APT packages
    #   and initiating the database schema.
    #
    #   Parameters:
    #     * engine_type: The DB engine to use.
    #       1 = mysql
    #       2 = postgresql
    #     * local_setup: Should the database be installed locally
    #       1 = yes
    #       2 = no
    #     * db_name: The name of the database itself
    #     * username: The username to access the database
    #     * password: The password of the user to access the database
    ###

    echo "Setting up the database ..."

107 108 109 110 111
    engine_type="$1"
    local_setup="$2"
    db_name="$3"
    username="$4"
    password="$5"
112

113
    if [ "$engine_type" == 1 ]; then
114 115 116 117 118 119 120 121 122 123

        echo "Installing MySQL client ..."
        apt-get -y install python3-mysqldb mysql-client
        echo "Installing MySQL client: Done"

        mysql_command="CREATE DATABASE $db_name collate='utf8_general_ci';
            CREATE USER '$username'@'localhost' IDENTIFIED BY '$password';
            GRANT ALL PRIVILEGES ON $db_name.* TO '$username'@'localhost';
            FLUSH PRIVILEGES;"

124
        if [ "$local_setup" == 1 ]; then
125 126 127 128 129 130 131
            echo "Setting up local MySQL server ..."
            apt-get -y install mysql-server
            mysql -u root --execute="$mysql_command"
            echo "Setting up local MySQL server: Done"
        else
            echo "Please execute the following command on the remote SQL server and then continue"
            echo "$mysql_command"
132
            _ask_value "Continue" "yes" "no"; if [ "$VALUE" == "no" ]; then exit; fi
133 134 135 136 137 138 139 140 141 142 143 144
        fi

    else

        echo "Installing PostgreSQL client ..."
        apt-get -y install postgresql-client python3-psycopg2
        echo "Installing PostgreSQL client: Done"

        pgsql_command1="CREATE DATABASE $db_name ENCODING 'UTF8' LC_COLLATE='fr_FR.UTF-8' LC_CTYPE='fr_FR.UTF-8';"
        pgsql_command2="CREATE USER $username with password '$password';"
        pgsql_command3="ALTER DATABASE $db_name owner to $username;"

145
        if [ "$local_setup" == 1 ]; then
146 147 148 149 150 151 152 153 154 155 156
            echo "Setting up local PostgreSQL server ..."
            apt-get -y install postgresql
            sudo -u postgres psql --command="$pgsql_command1"
            sudo -u postgres psql --command="$pgsql_command2"
            sudo -u postgres psql --command="$pgsql_command3"
            echo "Setting up local PostgreSQL server: Done"
        else
            echo "Please execute the following commands on the remote SQL server and then continue"
            echo "sudo -u postgres psql $pgsql_command1"
            echo "sudo -u postgres psql $pgsql_command2"
            echo "sudo -u postgres psql $pgsql_command3"
157
            _ask_value "Continue" "yes" "no"; if [ "$VALUE" == "no" ]; then exit; fi
158 159 160 161 162 163 164 165 166
        fi

    fi

    echo "Setting up the database: Done"
}



167 168
install_ldap() {
    ### Usage: install_ldap <local_setup> <password> <domain>
169
    #
170
    #   This function will install the LDAP
171 172
    #
    #   Parameters:
173
    #     * local_setup: Should the LDAP be installed locally ?
174 175 176 177 178 179
    #       1 = yes
    #       2 = no
    #     * password: the clear password for the admin user of the LDAP
    #     * domain: the domain extension to use for the LDAP structure in LDAP notation
    ###

180
    echo "Setting up the LDAP ..."
181

182 183 184
    local_setup="$1"
    password="$2"
    domain="$3"
185

186
    if [ "$local_setup" == 1 ]; then
187

188 189 190 191 192
        echo "Installing slapd package ..."
        apt-get -y install slapd
        echo "Installing slapd package: Done"

        echo "Hashing the LDAP password ..."
Maël Kervella's avatar
Maël Kervella committed
193
        hashed_ldap_passwd="$(slappasswd -s $password)"
194 195 196
        echo "Hash of the password: $hashed_ldap_passwd"

        echo "Building the LDAP config files ..."
Maël Kervella's avatar
Maël Kervella committed
197 198
        sed 's|dc=example,dc=net|'"$domain"'|g' install_utils/db.ldiff | sed 's|FILL_IT|'"$hashed_ldap_passwd"'|g' > /tmp/db
        sed 's|dc=example,dc=net|'"$domain"'|g' install_utils/schema.ldiff | sed 's|FILL_IT|'"$hashed_ldap_passwd"'|g' > /tmp/schema
199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
        echo "Building the LDAP config files: Done"

        echo "Stopping slapd service ..."
        service slapd stop
        echo "Stopping slapd service: Done"

        echo "Deleting exisitng LDAP configuration ..."
        rm -rf /etc/ldap/slapd.d/*
        rm -rf /var/lib/ldap/*
        echo "Deleting existing LDAP configuration: Done"

        echo "Setting up the new LDAP configuration ..."
        slapadd -n 0 -l /tmp/schema -F /etc/ldap/slapd.d/
        slapadd -n 1 -l /tmp/db
        echo "Setting up the new LDAP configuration: Done"

        echo "Fixing the LDAP files permissions ..."
        chown -R openldap:openldap /etc/ldap/slapd.d
        chown -R openldap:openldap /var/lib/ldap
        echo "Fixing the LDAP files permissions: Done"

        echo "Starting slapd service ..."
        service slapd start
        echo "Starting slapd service: Done"
223 224 225 226

    else

        echo "Please execute the following command on the remote LDAP server and then continue"
227
        echo "./install_re2o.sh setup-ldap $password $domain"
228
        _ask_value "Continue" "yes" "no"; if [ "$VALUE" == "no" ]; then exit; fi
229 230 231

    fi

232
    echo "Setting up the LDAP: Done"
233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
}



write_settings_file() {
    ### Usage: write_settings_file <db_engine_type> <sql_hostname> <sql_db_name> <sql_username> <sql_password>
    #                              <ldap_cn> <ldap_tls> <ldap_password> <ldap_hostname> <ldap_domain>
    #                              <email_hostname> <email_port> <extension> <url>
    #
    #   This function will write a clean local settings file based on the example.
    #
    #   Parameters:
    #     * db_engine_type: The engine for the database
    #       1 = MySQL
    #       2 = PostgreSQL
    #     * sql_hostname: The hostname for contacting the database
    #     * sql_db_name: The name of the database itself
    #     * sql_username: The user to use to access the database
    #     * sql_password: The password to use to access the database
252 253
    #     * ldap_cn: The CN entry for the LDAP admin in LDAP notation
    #     * ldap_tls: Should the TLS be activated to contact the LDAP
254 255
    #       1 = yes
    #       2 = no
256 257 258
    #     * ldap_password: The password to use to connect to the LDAP
    #     * ldap_hostname: The hostname for contacting the LDAP
    #     * ldap_domain: The local domain for the LDAP in LDAP notation
259 260 261 262 263 264 265 266
    #     * email_hostname: The hostname for contacting the mail server
    #     * email_port: The port for contacting the mail server
    #     * extension: The extension to use
    #     * url: The main URL to use for Re2o
    ###

    echo "Writing of the settings_local.py file ..."

267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
    db_engine_type="$1"
    sql_hostname="$2"
    sql_db_name="$3"
    sql_username="$4"
    sql_password="$5"
    ldap_cn="$6"
    ldap_tls="$7"
    ldap_password="$8"
    ldap_hostname="$9"
    ldap_domain="${10}"
    email_hostname="${11}"
    email_port="${12}"
    extension="${13}"
    url="${14}"

    cp "$SETTINGS_EXAMPLE_FILE" "$SETTINGS_LOCAL_FILE"

    django_secret_key="$(python -c "import random; print(''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789%=+') for i in range(50)]))")"
    aes_key="$(python -c "import random; print(''.join([random.SystemRandom().choice('abcdefghijklmnopqrstuvwxyz0123456789%=+') for i in range(32)]))")"
286
    
287 288
    if [ "$db_engine_type" == 1 ]; then
        sed -i 's/db_engine/django.db.backends.mysql/g' "$SETTINGS_LOCAL_FILE"
289
    else
290
        sed -i 's/db_engine/django.db.backends.postgresql_psycopg2/g' "$SETTINGS_LOCAL_FILE"
291
    fi
292 293 294 295 296 297 298
    sed -i 's/SUPER_SECRET_KEY/'"$django_secret_key"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/SUPER_SECRET_DB/'"$sql_password"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/A_SECRET_AES_KEY/'"$aes_key"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/db_name_value/'"$sql_db_name"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/db_user_value/'"$sql_username"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/db_host_value/'"$sql_hostname"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/ldap_dn/'"$ldap_cn"'/g' "$SETTINGS_LOCAL_FILE"
299
    if [ $ldap_tls == 2 ]; then
300
        sed -i "s/'TLS': True,/# 'TLS': True,/g" "$SETTINGS_LOCAL_FILE"
301
    fi
302 303 304 305 306 307 308
    sed -i 's/SUPER_SECRET_LDAP/'"$ldap_password"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/ldap_host_ip/'"$ldap_hostname"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/dc=example,dc=net/'"$ldap_domain"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/example.net/'"$extension"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/MY_EMAIL_HOST/'"$email_hostname"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/MY_EMAIL_PORT/'"$email_port"'/g' "$SETTINGS_LOCAL_FILE"
    sed -i 's/URL_SERVER/'"$url"'/g' "$SETTINGS_LOCAL_FILE"
309 310 311 312 313 314

    echo "Writing of the settings_local.py file: Done"
}



315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
update_django() {
    ### Usage: update_django
    #
    #   This function will update the Django project by applying the migrations
    #   and collecting the statics
    ###

    echo "Applying Django migrations ..."
    python3 manage.py migrate
    echo "Applying Django migrations: Done"

    echo "Collecting web frontend statics ..."
    python3 manage.py collectstatic --noinput
    echo "Collecting web frontend statics: Done"
}



create_superuser() {
    ### Usage: create_superuser
    #
    #   This will create a user with the superuser rights for the project.

    echo "Creating a superuser ..."
    python3 manage.py createsuperuser
    echo "Creating a superuser: Done"
}



345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363
install_webserver() {
    ### Usage: install_webserver <engine_type> <tls> <url>
    #
    #   This function will install the web server by installing the correct APT packages
    #   and configure it
    #
    #   Parameters:
    #     * engine_type: The engine to use as a web server
    #       1 = Apache2
    #       2 = NginX
    #     * tls: Should the TLS (with LE) be generated and activated
    #       1 = yes
    #       2 = no
    #     * url: The url to access Re2o. This parameter is only used if TLS is activated
    #       for generating the certifcate with the right domain name
    ###

    echo "Setting up web server ..."

364 365 366
    engine_type="$1"
    tls="$2"
    url="$3"
367

368
    if [ "$engine_type" == 1 ]; then
369 370 371 372 373 374 375 376

        echo "Setting up Apache2 web server ..."

        apt-get -y install apache2 libapache2-mod-wsgi-py3
        a2enmod ssl
        a2enmod wsgi
        a2enconf javascript-common

377
        if [ "$tls" == 1 ]; then
378 379 380 381
            echo "Setting up TLS with LE for Apache2 web server ..."
            cp install_utils/apache2/re2o-tls.conf /etc/apache2/sites-available/re2o.conf
            apt-get -y install certbot
            apt-get -y install python-certbot-apache
382
            certbot certonly --rsa-key-size 4096 --apache -d "$url"
383 384 385 386 387 388 389 390
            sed -i 's/LE_PATH/'"$url"'/g' /etc/apache2/sites-available/re2o.conf
            echo "Setting up TLS with LE for Apache2 web server: Done"
        else
            cp install_utils/apache2/re2o.conf /etc/apache2/sites-available/re2o.conf
        fi

        rm /etc/apache2/sites-enabled/000-default.conf
        sed -i 's|URL_SERVER|'"$url"'|g' /etc/apache2/sites-available/re2o.conf
391
        sed -i 's|PATH|'"$(pwd)"'|g' /etc/apache2/sites-available/re2o.conf
392 393 394 395 396 397 398 399 400 401 402
        a2ensite re2o

        echo "Setting up Apache2 web server: Done"

        echo "Reloading Apache2 service ..."
        service apache2 reload
        echo "Reloading Apache2 service: Done"

    else

        echo "Nginx automatic setup is not supported. Please configure it manually."
403 404
        echo "Please confirm you have acknowledged this message."
        _ask_value "Acknowledged" "yes"
405 406 407 408 409 410 411 412 413 414

    fi

    echo "Setting up web server: Done"
}



interactive_guide() {
    ### Usage: interactive_guide
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    #
    #   This function will guide through the automated setup of Re2o by asking
    #   the user for some informations and some installation choices. It will
    #   then proceed to setup and configuration of the required tools according
    #   to the user choices.
    ###

    echo "Re2o setup !"
    echo "This tool will help you setup re2o. It is highly recommended to use a Debian clean server for this operation."

    echo "Installing basic packages required for this script to work  ..."
    apt-get -y install sudo dialog
    echo "Installing basic packages required for this script to work: Done"

    # Common setup for the dialog prompts
    export DEBIAN_FRONTEND=noninteractive
431 432
    HEIGHT=20
    WIDTH=60
433 434 435 436 437 438 439 440 441 442 443 444 445
    CHOICE_HEIGHT=4



    #############
    ## Welcome ##
    #############

    BACKTITLE="Re2o setup"

    # Welcome prompt
    TITLE="Welcome"
    MSGBOX="This tool will help you setup re2o. It is highly recommended to use a Debian clean server for this operation."
446
    init="$(dialog --clear --backtitle "$BACKTITLE" \
447
        --title "$TITLE" --msgbox "$MSGBOX" \
448
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
449 450 451 452 453 454 455 456 457 458 459 460 461 462



    ######################
    ## Database options ##
    ######################

    BACKTITLE="Re2o setup - configuration of the database"

    # Prompt for choosing the database engine
    TITLE="Database engine"
    MENU="Which engine should be used as the database ?"
    OPTIONS=(1 "mysql"
             2 "postgresql")
463
    sql_bdd_type="$(dialog --clear --backtitle "$BACKTITLE" \
464
        --title "$TITLE" --menu "$MENU" \
465
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
466 467 468 469 470

    # Prompt for choosing the database location
    TITLE="SQL location"
    MENU="Where to install the SQL database ?
    * 'Local' will setup everything automatically but is not recommended for production
471
    * 'Remote' will ask you to manually perform some setup commands on the remote server"
472 473
    OPTIONS=(1 "Local"
             2 "Remote")
474
    sql_is_local="$(dialog --clear --backtitle "$BACKTITLE" \
475
        --title "$TITLE" --menu "$MENU" \
476
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
477 478 479 480 481

    if [ $sql_is_local == 2 ]; then
        # Prompt to enter the remote database hostname
        TITLE="SQL hostname"
        INPUTBOX="The hostname of the remote SQL database"
482
        sql_host="$(dialog --clear --backtitle "$BACKTITLE" \
483
            --title "$TITLE" --inputbox "$INPUTBOX" \
484
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
485 486 487 488
        
        # Prompt to enter the remote database name
        TITLE="SQL database name"
        INPUTBOX="The name of the remote SQL database"
489
        sql_name="$(dialog --clear --backtitle "$BACKTITLE" \
490
            --title "$TITLE" --inputbox "$INPUTBOX" \
491
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
492 493 494 495

        # Prompt to enter the remote database username
        TITLE="SQL username"
        INPUTBOX="The username to access the remote SQL database"
496
        sql_login="$(dialog --clear --backtitle "$BACKTITLE" \
497
            --title "$TITLE" --inputbox "$INPUTBOX" \
498
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
499 500 501 502 503 504 505
        clear
    else
        # Use of default values for local setup
        sql_name="re2o"
        sql_login="re2o"
        sql_host="localhost"
    fi
506

507 508 509
    # Prompt to enter the database password
    TITLE="SQL password"
    INPUTBOX="The password to access the SQL database"
510
    sql_password="$(dialog --clear --backtitle "$BACKTITLE" \
511
        --title "$TITLE" --inputbox "$INPUTBOX" \
512
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
513 514 515



516 517 518
    ##################
    ## LDAP options ##
    ##################
519

520
    BACKTITLE="Re2o setup - configuration of the LDAP"
521 522 523 524 525

    # Prompt to choose the LDAP location
    TITLE="LDAP location"
    MENU="Where would you like to install the LDAP ?
    * 'Local' will setup everything automatically but is not recommended for production
526
    * 'Remote' will ask you to manually perform some setup commands on the remote server"
527 528
    OPTIONS=(1 "Local"
             2 "Remote")
529
    ldap_is_local="$(dialog --clear --backtitle "$BACKTITLE" \
530
        --title "$TITLE" --menu "$MENU" \
531
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
532 533 534 535
    
    # Prompt to enter the LDAP domain extension
    TITLE="Domain extension"
    INPUTBOX="The local domain extension to use (e.g. 'example.net'). This is used in the LDAP configuration."
536
    extension_locale="$(dialog --clear --backtitle "$BACKTITLE" \
537
        --title "$TITLE" --inputbox "$INPUTBOX" \
538
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
539 540 541 542 543 544 545
    
    # Building the DN of the LDAP from the extension
    IFS='.' read -a extension_locale_array <<< $extension_locale
    for i in "${extension_locale_array[@]}"
    do
        ldap_dn+="dc=$i,"
    done
546
    ldap_dn="${ldap_dn::-1}"
547

548
    if [ "$ldap_is_local" == 2 ]; then
549 550 551
        # Prompt to enter the remote LDAP hostname
        TITLE="LDAP hostname"
        INPUTBOX="The hostname of the remote LDAP"
552
        ldap_host="$(dialog --clear --backtitle "$BACKTITLE" \
553
            --title "$TITLE" --inputbox "$INPUTBOX" \
554
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
555 556 557 558 559 560
        
        # Prompt to choose if TLS should be activated or not for the LDAP
        TITLE="TLS on LDAP"
        MENU="Would you like to activate TLS for communicating with the remote LDAP ?"
        OPTIONS=(1 "Yes"
                 2 "No")
561
        ldap_tls="$(dialog --clear --backtitle "$BACKTITLE" \
562
            --title "$TITLE" --MENU "$MENU" \
563
            $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
564 565 566 567

        # Prompt to enter the admin's CN of the remote LDAP
        TITLE="CN of amdin user"
        INPUTBOX="The CN entry for the admin user of the remote LDAP"
568
        ldap_cn="$(dialog --clear --backtitle "$BACKTITLE" \
569
            --title "$TITLE" --inputbox "$INPUTBOX" \
570
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
571 572
    else
        ldap_cn="cn=admin,"
573
        ldap_cn+="$ldap_dn"
574 575 576
        ldap_host="localhost"
        ldap_tls=2
    fi
577

578 579 580
    # Prompt to enter the LDAP password
    TITLE="LDAP password"
    INPUTBOX="The password to access the LDAP"
581
    ldap_password="$(dialog --clear --backtitle "$BACKTITLE" \
582
        --title "$TITLE" --inputbox "$INPUTBOX" \
583
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
584 585 586 587 588 589 590 591 592 593 594 595



    #########################
    ## Mail server options ##
    #########################

    BACKTITLE="Re2o setup - configuration of the mail server"
    
    # Prompt to enter the hostname of the mail server
    TITLE="Mail server hostname"
    INPUTBOX="The hostname of the mail server to use"
596
    email_host="$(dialog --clear --backtitle "$BACKTITLE" \
597
        --title "$TITLE" --inputbox "$TITLE" \
598
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
599 600 601 602 603 604 605

    # Prompt to choose the port of the mail server    
    TITLE="Mail server port"
    MENU="Which port (thus which protocol) to use to contact the mail server"
    OPTIONS=(25 "SMTP"
             465 "SMTPS"
             587 "Submission")
606
    email_port="$(dialog --clear --backtitle "$BACKTITLE" \
607
        --title "$TITLE" --menu "$MENU" \
608
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
609 610 611 612 613 614 615 616 617 618 619 620 621 622



    ########################
    ## Web server options ##
    ########################

    BACKTITLE="Re2o setup - configuration of the web server"
    
    # Prompt to choose the web server
    TITLE="Web server to use"
    MENU="Which web server to install for accessing Re2o web frontend (automatic setup of nginx is not supported) ?"
    OPTIONS=(1 "apache2"
             2 "nginx")
623
    web_serveur="$(dialog --clear --backtitle "$BACKTITLE" \
624
        --title "$TITLE" --menu "$MENU" \
625
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
626 627 628 629
    
    # Prompt to enter the requested URL for the web frontend
    TITLE="Web URL"
    INPUTBOX="URL for accessing the web server (e.g. re2o.example.net). Be sure that this URL is accessible and correspond to a DNS entry (if applicable)."
630
    url_server="$(dialog --clear --backtitle "$BACKTITLE" \
631
        --title "$TITLE" --inputbox "$INPUTBOX" \
632
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
633 634 635 636 637 638
    
    # Prompt to choose if the TLS should be setup or not for the web server
    TITLE="TLS on web server"
    MENU="Would you like to activate the TLS (with Let'Encrypt) on the web server ?"
    OPTIONS=(1 "Yes"
             2 "No")
639
    is_tls="$(dialog --clear --backtitle "$BACKTITLE" \
640
        --title "$TITLE" --menu "$MENU" \
641
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
642 643


644

645 646 647
    ###############################
    ## End of configuration step ##
    ###############################
648

649
    BACKTITLE="Re2o setup"
650

651 652 653 654 655 656 657 658 659 660 661
    # Prompt to inform the config setup is over
    TITLE="End of configuration step"
    MSGBOX="The configuration step is now finished. The script will now perform the following actions:
    * Install the required packages
    * Install and setup the requested database if 'local' has been selected
    * Install and setup the ldap if 'local' has been selected
    * Write a local version of 'settings_local.py' file with the previously given informations
    * Apply the Django migrations for the project
    * Collect the statics for the web interface
    * Install and setup the requested web server
    * Install and setup a TLS certificate for the web server if requested"
662
    end_config="$(dialog --clear --backtitle "$BACKTITLE" \
663
        --title "$TITLE" --msgbox "$MSGBOX" \
664
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
665

666
    clear
667

668

669

670 671 672
    ################################
    ## Perform the actual actions ##
    ################################
673

674
    install_requirements
675

676
    install_database "$sql_bdd_type" "$sql_is_local" "$sql_name" "$sql_login" "$sql_password"
677

678
    install_ldap "$ldap_is_local" "$ldap_password" "$ldap_dn"
679 680


681 682 683
    write_settings_file "$sql_bdd_type" "$sql_host" "$sql_name" "$sql_login" "$sql_password" \
                        "$ldap_cn" "$ldap_tls" "$ldap_password" "$ldap_host" "$ldap_dn" \
                        "$email_host" "$email_port" "$extension_locale" "$url_server"
684

685 686 687
    update_django

    create_superuser
688
    
689
    install_webserver "$web_serveur" "$is_tls" "$url_server"
690

691 692 693 694 695 696 697 698 699 700


    ###########################
    ## End of the setup step ##
    ###########################

    BACKTITLE="Re2o setup"

    # Prompt to inform the installation process is over
    TITLE="End of the setup"
701
    MSGBOX="You can now visit $url_server and connect with the credentials you just entered. This user has the superuser rights, meaning he can access and do everything."
702
    end="$(dialog --clear --backtitle "$BACKTITLE" \
Maël Kervella's avatar
Maël Kervella committed
703
        --title "$TITLE" --msgbox "$MSGBOX" \
704
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
705 706
}

707

708 709 710 711 712 713 714 715


interactive_update_settings() {
    ### Usage: interactvie_update_settings
    #
    #   This function will take the parameters in the example settings file, retrieve the
    #   existing parameters from the local settings file and ask the user for the missing parameters
    ###
716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732
    _ask_value "Database engine" "mysql" "postgresql"; if [ "$VALUE" == "mysql" ]; then db_engine_type=1; else db_engine_type=2; fi
    _ask_value "Database hostname"; sql_hostname="$VALUE"
    _ask_value "Database name"; sql_db_name="$VALUE"
    _ask_value "Database username"; sql_username="$VALUE"
    _ask_value "Database password"; sql_password="$VALUE"
    _ask_value "LDAP hostname"; ldap_hostname="$VALUE"
    _ask_value "Activate TLS on LDAP" "yes" "no"; if [ "$VALUE" == "mysql" ]; then ldap_tls=1; else ldap_tls=2; fi
    _ask_value "LDAP domain (e.g. 'dc=example,dc=net')"; ldap_domain="$VALUE"
    _ask_value "LDAP admin CN entry (e.g. 'cn=admin,dc=example,dc=net')"; ldap_cn="$VALUE"
    _ask_value "LDAP password"; ldap_password="$VALUE"
    _ask_value "Mail server hostname"; email_hostname="$VALUE"
    _ask_value "Mail server port" "25" "465" "587"; email_port="$VALUE"
    _ask_value "Extension de domain (e.g. 'example.net')"; extension="$VALUE"
    _ask_value "Main URL"; url="$VALUE"
    write_settings_file "$db_engine_type" "$sql_hostname" "$sql_db_name" "$sql_username" "$sql_password" \
                        "$ldap_cn" "$ldap_tls" "$ldap_password" "$ldap_hostname" "$ldap_domain" \
                        "$email_hostname" "$email_port" "$extension" "$url"
733 734 735 736 737

}



738
main_function() {
739
    ### Usage: main_function [subcommand [options]]
740 741
    #
    #   This function will parse the arguments to determine which part of the tool to start.
742
    #   Refer to the help message below for the details of the parameters
743 744
    ###

745 746 747 748 749 750 751 752 753 754 755 756
    if [ -z "$1" ] || [ "$1" == "help" ]; then
        echo ""
        echo "Usage: install_re2o [subcommand [options]]"
        echo ""
        echo "The 'install_re2o' script is a utility script to setup, configure, reset and update"
        echo "some components of re2o. Please refer to the following details for more."
        echo ""
        echo "Sub-commands:"
        echo "  * [no subcommand] - Display this quick usage documentation"
        echo "  * {help} ---------- Display this quick usage documentation"
        echo "  * {setup} --------- Launch the full interactive guide to setup entirely"
        echo "                      re2o from scratch"
757 758 759
        echo "  * {update} -------- Collect frontend statics, install the missing APT"
        echo "                      and pip packages and apply the migrations to the DB"
        echo "  * {update-django} - Apply Django migration and collect frontend statics"
760 761 762
        echo "  * {update-packages} Install the missing APT and pip packages"
        echo "  * {update-settings} Interactively rewrite the settings file"
        echo "  * {reset-db} ------ Erase the previous local database, setup a new empty"
763 764
        echo "                      one and apply the Django migrations on it and collect"
        echo "                      Django statics."
765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
        echo "      Parameters:"
        echo "        * <db_password> -- the clear-text password to connect to the database"
        echo "        * [db_engine_type] the SQL engine to use ('mysql' or 'postgresql')."
        echo "                           Default is 'mysql'."
        echo "        * [db_name] ------ the name of the database itself."
        echo "                           Default is 're2o'."
        echo "        * [db_username] -- the username to connect to the database."
        echo "                           Default is 're2o'."
        echo "  * {reset-ldap} ---- Erase the previous local LDAP and setup a new empty one"
        echo "      Parameters:"
        echo "        * <ldap_password> the clear-text password for the admin user of the"
        echo "                          LDAP"
        echo "        * <local_domain>  the domain extension to use for the LDAP structure"
        echo "                          in LDAP notation"
        echo ""
    else
781
        subcmd="$1"
782 783 784

        case "$subcmd" in

785 786 787 788
        setup )
           interactive_guide
           ;;

789 790 791
        update )
            install_requirements
            update_django
792
            ;;
793 794 795

        update-django )
            update_django
796
            ;;
797 798 799

        update-packages )
            install_requirements
800
            ;;
801 802 803

        update-settings )
            interactive_update_settings
804
            ;;
805 806

        reset-db )
807
            if [ ! -z "$2" ]; then
808
                db_password="$2"
809
                case "$3" in 
810 811
                mysql )
                    db_engine_type=1;;
812
                postresql )
813
                    db_engine_type=2;;
814
                * )
815
                    db_engine_type=1;;
816
                esac
817 818 819 820 821 822 823 824 825 826 827
                if [ ! -z "$4" ]; then
                    db_name="$4"
                else
                    db_name="re2o"
                fi
                if [ ! -z "$5" ]; then
                    db_username="$5"
                else
                    db_username="re2o"
                fi
                install_database "$db_engine_type" 1 "$db_name" "$db_username" "$db_password"
828
		update-django
829
            else
830
                echo "Invalid arguments !"
831 832
                echo "Usage: install_re2o setup-db <db_password> [<db_engine_type>] [<db_name>] [<db_username>]"
		echo "See 'install_re2o help' for further help"
833
            fi
834
            ;;
835 836 837

        reset-ldap )
            if [ ! -z "$2" ] && [ ! -z "$3" ]; then
838 839 840
                ldap_password="$2"
                local_domain="$3"
                install_ldap 1 "$ldap_password" "$local_domain"
841 842
            else
                echo "Invalid arguments !"
843 844
                echo "Usage: install_re2o setup-ldap <ldap_password> <local_domain>"
		echo "See 'install_re2o help' for further help"
845
            fi
846
            ;;
847 848

        * )
849 850
            echo "Unknown subcommand: $subcmd"
            echo "Use 'install_re2o help' to display some help"
851
            ;;
852 853

        esac
854
    fi
855 856
}

857
main_function "$@"