jupyterlab_ynh/scripts/install

#!/bin/bash

#=================================================
# GENERIC START
#=================================================
# IMPORT GENERIC HELPERS
#=================================================

source /usr/share/yunohost/helpers
source ./experimental_helper.sh

# Exit if an error occurs during the execution of the script
ynh_abort_if_errors

# Load common variables and helpers
source ./_common.sh

#=================================================
# RETRIEVE ARGUMENTS
#=================================================

# Retrieve arguments
domain=$YNH_APP_ARG_DOMAIN
path_url=$YNH_APP_ARG_PATH
is_public=$YNH_APP_ARG_IS_PUBLIC
admin=$YNH_APP_ARG_ADMIN
enable_terminal=$YNH_APP_ARG_ENABLE_TERMINAL

#=================================================
# REGISTER DOMAIN
#=================================================

# Normalize the url path syntax
test -n "$path_url" || path_url="/"
path_url=$(ynh_normalize_url_path $path_url)

# This function check also the availability of this one
ynh_webpath_register $app $domain $path_url

#=================================================
# REGISTER DOMAIN
#=================================================

# Check user parameter
ynh_user_exists "$admin" \
  || ynh_die "The chosen admin user does not exist."

#=================================================
# STORE SETTINGS FROM MANIFEST
#=================================================

ynh_app_setting_set $app admin $admin
ynh_app_setting_set $app domain $domain
ynh_app_setting_set $app path_url $path_url
ynh_app_setting_set $app is_public $is_public
ynh_app_setting_set $app enable_terminal $enable_terminal

#=================================================
# STANDARD MODIFICATIONS
#=================================================
# FIND AND OPEN PORTS
#=================================================

ynh_print_info "Getting ports..."

# Find free ports
port=$(ynh_find_port 8080)
port_hub=$(ynh_find_port $(($port + 1)))
port_http_proxy=$(ynh_find_port $(($port_hub + 1)))

yunohost firewall allow --no-upnp TCP $port 2>&1
yunohost firewall allow --no-upnp TCP $port_hub 2>&1
yunohost firewall allow --no-upnp TCP $port_http_proxy 2>&1
ynh_app_setting_set $app port $port
ynh_app_setting_set $app port_hub $port_hub
ynh_app_setting_set $app port_http_proxy $port_http_proxy

#=================================================
# NGINX CONFIGURATION
#=================================================

# Create a dedicated nginx config
ynh_add_nginx_config

#=================================================
# CONFIGURE JUPYTERLAB
#=================================================

# Configure jupyterlab with jupyterhub_config.py file
config_jupyterlab

#=================================================
# DOWNLOAD, CHECK AND INSTALL JUPYTERLAB
#=================================================

setup_source $miniconda_architecture

#=================================================
# SPECIFIC SETUP
#=================================================
# ADD HUB EXTENSION
#=================================================

jupyter labextension install @jupyterlab/hub-extension
jupyter lab build

chown $admin -R $final_path/share/jupyter

#=================================================
# CONFIGURE JUPYTER NOTEBOOK
#=================================================
config_jupyter_notebook

#=================================================
# SETUP SYSTEMD
#=================================================

# Create a dedicated systemd config
add_systemd_config

#=================================================
# SETUP SSOWAT
#=================================================

# If app is public, add url to SSOWat conf as skipped_uris
if [[ $is_public -eq 1 ]]; then
  # unprotected_uris allows SSO credentials to be passed anyway.
  ynh_app_setting_set "$app" unprotected_uris "/"
fi

#=================================================
# GENERIC FINALISATION
#=================================================
# RELOAD NGINX
#=================================================

systemctl reload nginx

#=================================================
# ADVERTISE SERVICE IN ADMIN PANEL
#=================================================

yunohost service add $app --log "systemd"

#=================================================
# START SERVICE
#=================================================

ynh_systemd_action -n $app -a start -l "JupyterHub is now running at" -p "systemd"