install_re2o.sh 30.7 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 20 21 22 23 24 25 26 27 28 29 30
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
    #
    #   Echo: The value entered by the user. Should be one of the choicesN if
    #     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 59 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
install_requirements() {
    ### Usage: install_requirements 
    #
    #   This function will install the required packages from APT repository
    #   and Pypi repository. Those packages are qll required for Re2o to work
    #   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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
            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"
            while true; do
                read -p "Continue (y/n)?" choice
                case "$choice" in
                    y|Y ) break;;
                    n|N ) exit;;
                    * ) echo "Invalid";;
                esac
            done
        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;"

152
        if [ "$local_setup" == 1 ]; then
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
            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"
            while true; do
                read -p "Continue (y/n)?" choice
                case "$choice" in
                    y|Y ) break;;
                    n|N ) exit;;
                    * ) echo "Invalid";;
                esac
            done
        fi

    fi

    echo "Setting up the database: Done"
}



181 182
install_ldap() {
    ### Usage: install_ldap <local_setup> <password> <domain>
183
    #
184
    #   This function will install the LDAP
185 186
    #
    #   Parameters:
187
    #     * local_setup: Should the LDAP be installed locally ?
188 189 190 191 192 193
    #       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
    ###

194
    echo "Setting up the LDAP ..."
195

196 197 198
    local_setup="$1"
    password="$2"
    domain="$3"
199

200
    if [ "$local_setup" == 1 ]; then
201

202 203 204 205 206
        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
207
        hashed_ldap_passwd="$(slappasswd -s $password)"
208 209 210
        echo "Hash of the password: $hashed_ldap_passwd"

        echo "Building the LDAP config files ..."
Maël Kervella's avatar
Maël Kervella committed
211 212
        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
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236
        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"
237 238 239 240

    else

        echo "Please execute the following command on the remote LDAP server and then continue"
241
        echo "./install_re2o.sh setup-ldap $password $domain"
242 243 244 245 246 247 248 249 250 251 252
        while true; do
            read -p "Continue (y/n)?" choice
            case "$choice" in
                y|Y ) break;;
                n|N ) exit;;
                * ) echo "Invalid";;
            esac
        done

    fi

253
    echo "Setting up the LDAP: Done"
254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272
}



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
273 274
    #     * ldap_cn: The CN entry for the LDAP admin in LDAP notation
    #     * ldap_tls: Should the TLS be activated to contact the LDAP
275 276
    #       1 = yes
    #       2 = no
277 278 279
    #     * 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
280 281 282 283 284 285 286 287
    #     * 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 ..."

288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306
    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)]))")"
307
    
308 309
    if [ "$db_engine_type" == 1 ]; then
        sed -i 's/db_engine/django.db.backends.mysql/g' "$SETTINGS_LOCAL_FILE"
310
    else
311
        sed -i 's/db_engine/django.db.backends.postgresql_psycopg2/g' "$SETTINGS_LOCAL_FILE"
312
    fi
313 314 315 316 317 318 319
    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"
320
    if [ $ldap_tls == 2 ]; then
321
        sed -i "s/'TLS': True,/# 'TLS': True,/g" "$SETTINGS_LOCAL_FILE"
322
    fi
323 324 325 326 327 328 329
    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"
330 331 332 333 334 335

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



336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
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"
}



366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
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 ..."

385 386 387
    engine_type="$1"
    tls="$2"
    url="$3"
388

389
    if [ "$engine_type" == 1 ]; then
390 391 392 393 394 395 396 397

        echo "Setting up Apache2 web server ..."

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

398
        if [ "$tls" == 1 ]; then
399 400 401 402
            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
403
            certbot certonly --rsa-key-size 4096 --apache -d "$url"
404 405 406 407 408 409 410 411
            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
412
        sed -i 's|PATH|'"$(pwd)"'|g' /etc/apache2/sites-available/re2o.conf
413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
        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."
        echo "Please onfirm you have acknowledged this message."
        while true; do
            read -p "Acknowledged (y/n)?" choice
            case "$choice" in
                y|Y ) break;;
                n|N ) exit;;
                * ) echo "Invalid";;
            esac
        done

    fi

    echo "Setting up web server: Done"
}



interactive_guide() {
    ### Usage: interactive_guide
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
    #
    #   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
459 460
    HEIGHT=20
    WIDTH=60
461 462 463 464 465 466 467 468 469 470 471 472 473
    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."
474
    init="$(dialog --clear --backtitle "$BACKTITLE" \
475
        --title "$TITLE" --msgbox "$MSGBOX" \
476
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
477 478 479 480 481 482 483 484 485 486 487 488 489 490



    ######################
    ## 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")
491
    sql_bdd_type="$(dialog --clear --backtitle "$BACKTITLE" \
492
        --title "$TITLE" --menu "$MENU" \
493
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
494 495 496 497 498

    # 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
499
    * 'Remote' will ask you to manually perform some setup commands on the remote server"
500 501
    OPTIONS=(1 "Local"
             2 "Remote")
502
    sql_is_local="$(dialog --clear --backtitle "$BACKTITLE" \
503
        --title "$TITLE" --menu "$MENU" \
504
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
505 506 507 508 509

    if [ $sql_is_local == 2 ]; then
        # Prompt to enter the remote database hostname
        TITLE="SQL hostname"
        INPUTBOX="The hostname of the remote SQL database"
510
        sql_host="$(dialog --clear --backtitle "$BACKTITLE" \
511
            --title "$TITLE" --inputbox "$INPUTBOX" \
512
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
513 514 515 516
        
        # Prompt to enter the remote database name
        TITLE="SQL database name"
        INPUTBOX="The name of the remote SQL database"
517
        sql_name="$(dialog --clear --backtitle "$BACKTITLE" \
518
            --title "$TITLE" --inputbox "$INPUTBOX" \
519
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
520 521 522 523

        # Prompt to enter the remote database username
        TITLE="SQL username"
        INPUTBOX="The username to access the remote SQL database"
524
        sql_login="$(dialog --clear --backtitle "$BACKTITLE" \
525
            --title "$TITLE" --inputbox "$INPUTBOX" \
526
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
527 528 529 530 531 532 533
        clear
    else
        # Use of default values for local setup
        sql_name="re2o"
        sql_login="re2o"
        sql_host="localhost"
    fi
534

535 536 537
    # Prompt to enter the database password
    TITLE="SQL password"
    INPUTBOX="The password to access the SQL database"
538
    sql_password="$(dialog --clear --backtitle "$BACKTITLE" \
539
        --title "$TITLE" --inputbox "$INPUTBOX" \
540
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
541 542 543



544 545 546
    ##################
    ## LDAP options ##
    ##################
547

548
    BACKTITLE="Re2o setup - configuration of the LDAP"
549 550 551 552 553

    # 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
554
    * 'Remote' will ask you to manually perform some setup commands on the remote server"
555 556
    OPTIONS=(1 "Local"
             2 "Remote")
557
    ldap_is_local="$(dialog --clear --backtitle "$BACKTITLE" \
558
        --title "$TITLE" --menu "$MENU" \
559
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
560 561 562 563
    
    # 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."
564
    extension_locale="$(dialog --clear --backtitle "$BACKTITLE" \
565
        --title "$TITLE" --inputbox "$INPUTBOX" \
566
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
567 568 569 570 571 572 573
    
    # 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
574
    ldap_dn="${ldap_dn::-1}"
575

576
    if [ "$ldap_is_local" == 2 ]; then
577 578 579
        # Prompt to enter the remote LDAP hostname
        TITLE="LDAP hostname"
        INPUTBOX="The hostname of the remote LDAP"
580
        ldap_host="$(dialog --clear --backtitle "$BACKTITLE" \
581
            --title "$TITLE" --inputbox "$INPUTBOX" \
582
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
583 584 585 586 587 588
        
        # 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")
589
        ldap_tls="$(dialog --clear --backtitle "$BACKTITLE" \
590
            --title "$TITLE" --MENU "$MENU" \
591
            $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
592 593 594 595

        # 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"
596
        ldap_cn="$(dialog --clear --backtitle "$BACKTITLE" \
597
            --title "$TITLE" --inputbox "$INPUTBOX" \
598
            $HEIGHT $WIDTH 2>&1 >/dev/tty)"
599 600
    else
        ldap_cn="cn=admin,"
601
        ldap_cn+="$ldap_dn"
602 603 604
        ldap_host="localhost"
        ldap_tls=2
    fi
605

606 607 608
    # Prompt to enter the LDAP password
    TITLE="LDAP password"
    INPUTBOX="The password to access the LDAP"
609
    ldap_password="$(dialog --clear --backtitle "$BACKTITLE" \
610
        --title "$TITLE" --inputbox "$INPUTBOX" \
611
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
612 613 614 615 616 617 618 619 620 621 622 623



    #########################
    ## 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"
624
    email_host="$(dialog --clear --backtitle "$BACKTITLE" \
625
        --title "$TITLE" --inputbox "$TITLE" \
626
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
627 628 629 630 631 632 633

    # 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")
634
    email_port="$(dialog --clear --backtitle "$BACKTITLE" \
635
        --title "$TITLE" --menu "$MENU" \
636
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
637 638 639 640 641 642 643 644 645 646 647 648 649 650



    ########################
    ## 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")
651
    web_serveur="$(dialog --clear --backtitle "$BACKTITLE" \
652
        --title "$TITLE" --menu "$MENU" \
653
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
654 655 656 657
    
    # 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)."
658
    url_server="$(dialog --clear --backtitle "$BACKTITLE" \
659
        --title "$TITLE" --inputbox "$INPUTBOX" \
660
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
661 662 663 664 665 666
    
    # 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")
667
    is_tls="$(dialog --clear --backtitle "$BACKTITLE" \
668
        --title "$TITLE" --menu "$MENU" \
669
        $HEIGHT $WIDTH $CHOICE_HEIGHT "${OPTIONS[@]}" 2>&1 >/dev/tty)"
670 671


672

673 674 675
    ###############################
    ## End of configuration step ##
    ###############################
676

677
    BACKTITLE="Re2o setup"
678

679 680 681 682 683 684 685 686 687 688 689
    # 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"
690
    end_config="$(dialog --clear --backtitle "$BACKTITLE" \
691
        --title "$TITLE" --msgbox "$MSGBOX" \
692
        $HEIGHT $WIDTH 2>&1 >/dev/tty)"
693

694
    clear
695

696

697

698 699 700
    ################################
    ## Perform the actual actions ##
    ################################
701

702
    install_requirements
703

704
    install_database "$sql_bdd_type" "$sql_is_local" "$sql_name" "$sql_login" "$sql_password"
705

706
    install_ldap "$ldap_is_local" "$ldap_password" "$ldap_dn"
707 708


709 710 711
    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"
712

713 714 715
    update_django

    create_superuser
716
    
717
    install_webserver "$web_serveur" "$is_tls" "$url_server"
718

719 720 721 722 723 724 725 726 727 728 729


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

    BACKTITLE="Re2o setup"

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

735

736 737 738 739 740 741 742 743


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
    ###
744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
    _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"
761 762 763 764 765

}



766
main_function() {
767
    ### Usage: main_function [subcommand [options]]
768 769
    #
    #   This function will parse the arguments to determine which part of the tool to start.
770
    #   Refer to the help message below for the details of the parameters
771 772
    ###

773 774 775 776 777 778 779 780 781 782 783 784
    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"
785 786 787
        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"
788 789 790
        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"
791 792
        echo "                      one and apply the Django migrations on it and collect"
        echo "                      Django statics."
793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
        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
809
        subcmd="$1"
810 811 812

        case "$subcmd" in

813 814 815 816
        setup )
           interactive_guide
           ;;

817 818 819
        update )
            install_requirements
            update_django
820
            ;;
821 822 823

        update-django )
            update_django
824
            ;;
825 826 827

        update-packages )
            install_requirements
828
            ;;
829 830 831

        update-settings )
            interactive_update_settings
832
            ;;
833 834

        reset-db )
835
            if [ ! -z "$2" ]; then
836
                db_password="$2"
837
                case "$3" in 
838 839
                mysql )
                    db_engine_type=1;;
840
                postresql )
841
                    db_engine_type=2;;
842
                * )
843
                    db_engine_type=1;;
844
                esac
845 846 847 848 849 850 851 852 853 854 855
                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"
856
		update-django
857
            else
858
                echo "Invalid arguments !"
859 860
                echo "Usage: install_re2o setup-db <db_password> [<db_engine_type>] [<db_name>] [<db_username>]"
		echo "See 'install_re2o help' for further help"
861
            fi
862
            ;;
863 864 865

        reset-ldap )
            if [ ! -z "$2" ] && [ ! -z "$3" ]; then
866 867 868
                ldap_password="$2"
                local_domain="$3"
                install_ldap 1 "$ldap_password" "$local_domain"
869 870
            else
                echo "Invalid arguments !"
871 872
                echo "Usage: install_re2o setup-ldap <ldap_password> <local_domain>"
		echo "See 'install_re2o help' for further help"
873
            fi
874
            ;;
875 876

        * )
877 878
            echo "Unknown subcommand: $subcmd"
            echo "Use 'install_re2o help' to display some help"
879
            ;;
880 881

        esac
882
    fi
883 884
}

885
main_function "$@"