Now to configure it.
You can modify this page via the /etc/kiwiirc/client.json file.
Add your IRC network details to /etc/kiwiirc/config.conf
Have a quick read through the config file - there are plenty of comments explaining each feature.
" + } } diff --git a/conf/config.conf.example b/conf/config.conf.example index 81f760a..f721721 100644 --- a/conf/config.conf.example +++ b/conf/config.conf.example @@ -38,8 +38,8 @@ realname = "I am a webchat user" # The websocket / http server [server.1] -bind = "0.0.0.0" -port = 80 +bind = "127.0.0.1" +port = __PORT__ # Example TLS server #[server.2] @@ -55,14 +55,14 @@ port = 80 # Example unix socket server #[server.3] -bind = unix:/tmp/webircgateway.sock -bind_mode = 0777 +#bind = unix:/tmp/webircgateway.sock +#bind_mode = 0777 # Serve static files from a web root folder. # Optional, but handy for serving the Kiwi IRC client if no other webserver is available [fileserving] enabled = true -webroot = www/ +webroot = /usr/share/kiwiirc/ [transports] websocket @@ -89,8 +89,8 @@ kiwiirc # Connections will be sent to a random upstream [upstream.1] hostname = "irc.libera.chat" -port = 6697 -tls = true +port = 6667 +tls = false # Connection timeout in seconds timeout = 5 # Throttle the lines being written by X per second diff --git a/conf/nginx.conf b/conf/nginx.conf index 052c370..3512ed3 100644 --- a/conf/nginx.conf +++ b/conf/nginx.conf @@ -1,14 +1,21 @@ -#sub_path_only rewrite ^__PATH__$ __PATH__/ permanent; -location __PATH__/ { - - # Path to source - alias __FINALPATH__/ ; - - # Force usage of https - if ($scheme = http) { - rewrite ^ https://$server_name$request_uri? permanent; - } - - # Include SSOWAT user panel. - include conf.d/yunohost_panel.conf.inc; +location / { + index index.html; + root /usr/share/kiwiirc/; +} + +location /webirc/ { + # Forward incoming requests to local webircgateway socket + proxy_pass http://127.0.0.1:__PORT__/webirc/; + + # Set http version and headers + proxy_http_version 1.1; + + # Add X-Forwarded-* headers + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-For $remote_addr; + + # Allow upgrades to websockets + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; } diff --git a/conf/systemd.service b/conf/systemd.service deleted file mode 100644 index defb1a1..0000000 --- a/conf/systemd.service +++ /dev/null @@ -1,14 +0,0 @@ -[Unit] -Description=Websocket gateway to IRC networks -Documentation=https://github.com/kiwiirc/webircgateway -After=network.target - -[Service] -User=__APP__ -Group=__APP__ -ExecStart=/var/www/webircgateway/kiwiirc --config=/var/www/webircgateway/config.conf -ExecReload=/usr/bin/kill -USR1 $MAINPID -LimitNOFILE=1048576 - -[Install] -WantedBy=multi-user.target diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md index c6e5fe0..f4092b7 100644 --- a/doc/DESCRIPTION.md +++ b/doc/DESCRIPTION.md @@ -1,6 +1,6 @@ A versatile web based messenger using IRC -###Features: +### Features: - For single networks, bouncer hosts, or a personal generic IRC client that remembers your networks - Works out of the box with a default IRC network - or use your own diff --git a/manifest.json b/manifest.json index 836a938..2a285be 100644 --- a/manifest.json +++ b/manifest.json @@ -3,17 +3,16 @@ "id": "kiwiirc", "packaging_format": 1, "description": { - "en": "A versatile web based messenger using IRC", - "fr": "Une messagerie Web polyvalente utilisant IRC" + "en": "Versatile web based messenger using IRC", + "fr": "Messagerie Web polyvalente utilisant IRC" }, - "version": "1.5.0~ynh1", + "version": "20.05.24.1~ynh1", "url": "https://github.com/kiwiirc/kiwiirc", "upstream": { "license": "AGPL-3.0-only", "website": "https://kiwiirc.com/", "demo": "https://kiwiirc.com/nextclient", "admindoc": "https://github.com/kiwiirc/kiwiirc/wiki", - "userdoc": "https://yunohost.org/apps", "code": "https://github.com/kiwiirc/kiwiirc" }, "license": "AGPL-3.0-only", @@ -21,7 +20,7 @@ "name": "" }, "requirements": { - "yunohost": ">= 4.2.4" + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [ @@ -31,23 +30,7 @@ "install" : [ { "name": "domain", - "type": "domain", - "example": "domain.org" - }, - { - "name": "path", - "type": "path", - "example": "/kiwiirc", - "default": "/kiwiirc" - }, - { - "name": "is_public", - "type": "boolean", - "help": { - "en": "If enabled, KiwiIRC will be accessible by people who do not have an account. This can be changed later via the webadmin.", - "fr": "Si cette case est cochée, KiwiIRC sera accessible aux personnes n’ayant pas de compte. Vous pourrez changer ceci plus tard via la webadmin." - }, - "default": true + "type": "domain" } ] } diff --git a/scripts/_common.sh b/scripts/_common.sh index d8b7bd0..944a65e 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -4,11 +4,6 @@ # COMMON VARIABLES #================================================= -# dependencies used by the app -#pkg_dependencies="postgresql apt-transport-https" - -#nodejs_version=12 - #================================================= # PERSONAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index 248181b..e3ef7e8 100644 --- a/scripts/backup +++ b/scripts/backup @@ -13,9 +13,6 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ynh_clean_check_starting -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -34,12 +31,6 @@ domain=$(ynh_app_setting_get --app=$app --key=domain) #================================================= ynh_print_info --message="Declaring files to be backed up..." -#================================================= -# BACKUP THE APP MAIN DIR -#================================================= - -ynh_backup --src_path="$final_path" - #================================================= # BACKUP THE NGINX CONFIGURATION #================================================= @@ -47,13 +38,15 @@ ynh_backup --src_path="$final_path" ynh_backup --src_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# BACKUP SYSTEMD +# BACKUP THE CONFIGURATION FILE #================================================= -ynh_backup --src_path="/etc/systemd/system/$app.service" +ynh_backup --src_path="/etc/kiwiirc" + +ynh_backup --file="/var/log/$app.log" #================================================= # END OF SCRIPT #================================================= -ynh_print_info --message="Backup script completed for KiwiIRC. (YunoHost will then actually copy those files to the archive)." +ynh_print_info --message="Backup script completed for $app. (YunoHost will then actually copy those files to the archive)." diff --git a/scripts/change_url b/scripts/change_url index f1f2183..6834cfe 100644 --- a/scripts/change_url +++ b/scripts/change_url @@ -26,14 +26,12 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_script_progression --message="Loading installation settings..." --weight=1 -# Needed for helper "ynh_add_nginx_config" -final_path=$(ynh_app_setting_get --app=$app --key=final_path) port=$(ynh_app_setting_get --app=$app --key=port) #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP #================================================= -ynh_script_progression --message="Backing up KiwiIRC before changing its URL (may take a while)..." --weight=1 +ynh_script_progression --message="Backing up the app before changing its URL (may take a while)..." --weight=1 # Backup the current version of the app ynh_backup_before_upgrade @@ -103,4 +101,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Change of URL completed for KiwiIRC" --last +ynh_script_progression --message="Change of URL completed for $app" --last diff --git a/scripts/install b/scripts/install index b454e28..489f595 100644 --- a/scripts/install +++ b/scripts/install @@ -21,8 +21,7 @@ ynh_abort_if_errors #================================================= domain=$YNH_APP_ARG_DOMAIN -path_url=$YNH_APP_ARG_PATH -is_public=$YNH_APP_ARG_IS_PUBLIC +path_url="/" app=$YNH_APP_INSTANCE_NAME @@ -31,9 +30,6 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_script_progression --message="Validating installation parameters..." --weight=1 -final_path=/var/www/$app -test ! -e "$final_path" || ynh_die --message="This path already contains a folder" - # Register (book) web path ynh_webpath_register --app=$app --domain=$domain --path_url=$path_url @@ -54,42 +50,27 @@ ynh_script_progression --message="Finding an available port..." --weight=1 port=$(ynh_find_port --port=7778) ynh_app_setting_set --app=$app --key=port --value=$port -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Configuring system user..." --weight=3 - -# Create a system user -ynh_system_user_create --username=$app --home_dir=$final_path - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= ynh_script_progression --message="Setting up source files..." --weight=2 -ynh_app_setting_set --app=$app --key=final_path --value=$final_path -# Download, check integrity, uncompress and patch the source from app.src -ynh_setup_source --dest_dir="$final_path" - -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" +tempdir="$(mktemp -d)" +ynh_setup_source --dest_dir=$tempdir --source_id=app +ynh_exec_warn_less dpkg -i $tempdir/kiwiirc.deb #================================================= -#CREAT GATEWAYPATH +# ADD A CONFIGURATION #================================================= -ynh_script_progression --message="Setting up gatheway path..." --weight=2 +ynh_script_progression --message="Adding a configuration file..." --weight=1 -webircgateway_path=/var/www/webircgateway -mkdir -p $webircgateway_path +ynh_add_config --template="../conf/client.json.example" --destination="/etc/kiwiirc/client.json" +ynh_add_config --template="../conf/config.conf.example" --destination="/etc/kiwiirc/config.conf" -ynh_app_setting_set --app=$app --key=webircgateway_path --value=$webircgateway_path - -mv ../sources/webircgateway/* $webircgateway_path - -chmod 750 "$webircgateway_path" -chmod -R o-rwx "$webircgateway_path" -chown -R $app:www-data "$webircgateway_path" +chmod 744 "/etc/kiwiirc/config.conf" +chown root: "/etc/kiwiirc/config.conf" +chmod 744 "/etc/kiwiirc/client.json" +chown root: "/etc/kiwiirc/client.json" #================================================= # NGINX CONFIGURATION @@ -99,28 +80,12 @@ ynh_script_progression --message="Configuring NGINX web server..." --weight=2 # Create a dedicated NGINX config ynh_add_nginx_config -#================================================= -# SETUP SYSTEMD -#================================================= -ynh_script_progression --message="Configuring a systemd service..." --weight=1 - -# Create a dedicated systemd config -ynh_add_systemd_config - -#================================================= -# MODIFY A CONFIG FILE -#================================================= -ynh_script_progression --message="Modifying a config file..." - -ynh_add_config --template="../conf/config.json.example" --destination="$final_path/static/config.json" -ynh_add_config --template="../conf/config.conf.example" --destination="$webircgateway_path/config.conf" - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." --weight=1 -yunohost service add $app --description="Versatile web based messenger using IRC" --log="/var/log/$app/$app.log" +yunohost service add $app --description="Versatile web based messenger using IRC" --log="/var/log/$app.log" #================================================= # START SYSTEMD SERVICE @@ -128,18 +93,7 @@ yunohost service add $app --description="Versatile web based messenger using IRC ynh_script_progression --message="Starting a systemd service..." --weight=1 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" - -#================================================= -# SETUP SSOWAT -#================================================= -ynh_script_progression --message="Configuring SSOwat..." --weight=1 - -# Make app public if necessary or protect it -if [ $is_public -eq 1 ] -then - ynh_permission_update --permission="main" --add="visitors" -fi +ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" #================================================= # RELOAD NGINX @@ -152,4 +106,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Installation of KiwiIRC completed" --last +ynh_script_progression --message="Installation of $app completed" --last diff --git a/scripts/remove b/scripts/remove index 65fc0d6..873bdbf 100644 --- a/scripts/remove +++ b/scripts/remove @@ -18,7 +18,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) port=$(ynh_app_setting_get --app=$app --key=port) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) #================================================= # STANDARD REMOVE @@ -43,12 +42,20 @@ ynh_remove_systemd_config #================================================= # REMOVE APP MAIN DIR #================================================= -ynh_script_progression --message="Removing KiwiIRC main directory..." --weight=6 +ynh_script_progression --message="Removing Kiwiirc..." --weight=6 -# Remove the app directory securely -ynh_secure_remove --file="$final_path" +dpkg --purge kiwiirc -ynh_secure_remove --file="/var/www/webircgateway" +#================================================= +# REMOVE VARIOUS FILES +#================================================= +ynh_script_progression --message="Removing various files..." --weight=1 + +# Remove a cron file +ynh_secure_remove --file="/etc/$app" + +# Remove the log files +ynh_secure_remove --file="/var/log/$app.log" #================================================= # REMOVE NGINX CONFIGURATION @@ -58,18 +65,8 @@ ynh_script_progression --message="Removing NGINX web server configuration..." -- # Remove the dedicated nginx config ynh_remove_nginx_config -#================================================= -# GENERIC FINALIZATION -#================================================= -# REMOVE DEDICATED USER -#================================================= -ynh_script_progression --message="Removing the dedicated system user..." --weight=1 - -# Delete a system user -ynh_system_user_delete --username=$app - #================================================= # END OF SCRIPT #================================================= -ynh_script_progression --message="Removal of KiwiIRC completed" --last +ynh_script_progression --message="Removal of $app completed" --last diff --git a/scripts/restore b/scripts/restore index 14fa6db..270af5a 100644 --- a/scripts/restore +++ b/scripts/restore @@ -13,9 +13,6 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ynh_clean_check_starting -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -28,15 +25,6 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) - -#================================================= -# CHECK IF THE APP CAN BE RESTORED -#================================================= -ynh_script_progression --message="Validating restoration parameters..." --weight=2 - -test ! -d $final_path \ - || ynh_die --message="There is already a directory: $final_path " #================================================= # RESTORE THE NGINX CONFIGURATION @@ -46,31 +34,22 @@ ynh_script_progression --message="Restoring the NGINX configuration..." ynh_restore_file --origin_path="/etc/nginx/conf.d/$domain.d/$app.conf" #================================================= -# RECREATE THE DEDICATED USER +# DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= -ynh_script_progression --message="Recreating the dedicated system user..." --weight=1 +ynh_script_progression --message="Setting up source files..." --weight=2 -# Create the dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" +tempdir="$(mktemp -d)" +ynh_setup_source --dest_dir=$tempdir --source_id=app +ynh_exec_warn_less dpkg -i $tempdir/kiwiirc.deb #================================================= -# RESTORE THE APP MAIN DIR +# RESTORE THE NGINX CONFIGURATION #================================================= -ynh_script_progression --message="Restoring KiwiIRC main directory..." --weight=60 +ynh_script_progression --message="Restoring various file..." --weight=1 -ynh_restore_file --origin_path="$final_path" +ynh_restore_file --origin_path="/etc/kiwiirc" -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - -#================================================= -# RESTORE SYSTEMD -#================================================= -ynh_script_progression --message="Restoring the systemd configuration..." --weight=1 - -ynh_restore_file --origin_path="/etc/systemd/system/$app.service" -systemctl enable $app.service --quiet +ynh_restore_file --origin_path="/var/log/$app.log" #================================================= # INTEGRATE SERVICE IN YUNOHOST @@ -84,7 +63,7 @@ yunohost service add $app --description="Versatile web based messenger using IRC #================================================= ynh_script_progression --message="Starting a systemd service..." --weight=1 -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" #================================================= # RELOAD NGINX @@ -97,4 +76,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for KiwiIRC" --last +ynh_script_progression --message="Restoration completed for $app" --last diff --git a/scripts/upgrade b/scripts/upgrade index cf1817a..da0df06 100644 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -18,13 +18,11 @@ app=$YNH_APP_INSTANCE_NAME domain=$(ynh_app_setting_get --app=$app --key=domain) path_url=$(ynh_app_setting_get --app=$app --key=path) -final_path=$(ynh_app_setting_get --app=$app --key=final_path) port=$(ynh_app_setting_get --app=$app --key=port) #================================================= # CHECK VERSION #================================================= -ynh_script_progression --message="Checking version..." upgrade_type=$(ynh_check_app_version_changed) @@ -42,57 +40,17 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors -#================================================= -# ENSURE DOWNWARD COMPATIBILITY -#================================================= -ynh_script_progression --message="Ensuring downward compatibility..." --weight=1 - -# Cleaning legacy permissions -if ynh_legacy_permissions_exists; then - ynh_legacy_permissions_delete_all - - ynh_app_setting_delete --app=$app --key=is_public -fi - -#================================================= -# CREATE DEDICATED USER -#================================================= -ynh_script_progression --message="Making sure dedicated system user exists..." --weight=1 - -# Create a dedicated user (if not existing) -ynh_system_user_create --username=$app --home_dir="$final_path" - #================================================= # DOWNLOAD, CHECK AND UNPACK SOURCE #================================================= if [ "$upgrade_type" == "UPGRADE_APP" ] then - ynh_script_progression --message="Upgrading source files..." --weight=3 - - # Create a temporary directory - tmpdir="$(mktemp -d)" - - # Backup the config file in the temp dir - cp -a "$final_path/static/config.json" "$tmpdir/config.json" - - # Remove the app directory securely - ynh_secure_remove --file=$final_path - - # Download, check integrity, uncompress and patch the source from app.src - ynh_setup_source --dest_dir=$final_path - - #Copy the admin saved settings from tmp directory to final path - cp -a "$tmpdir/config.json" "$final_path/static/config.json" - - # Remove the tmp directory securely - ynh_secure_remove --file="$tmpdir" + tempdir="$(mktemp -d)" + ynh_setup_source --dest_dir=$tempdir --source_id=app + ynh_exec_warn_less dpkg -i $tempdir/kiwiirc.deb fi -chmod 750 "$final_path" -chmod -R o-rwx "$final_path" -chown -R $app:www-data "$final_path" - #================================================= # NGINX CONFIGURATION #================================================= @@ -114,7 +72,7 @@ yunohost service add $app --description="Versatile web based messenger using IRC ynh_script_progression --message="Starting a systemd service..." --weight=1 # Start a systemd service -ynh_systemd_action --service_name=$app --action="start" --log_path="systemd" +ynh_systemd_action --service_name=$app --action="restart" --log_path="systemd" #================================================= # RELOAD NGINX @@ -127,4 +85,4 @@ ynh_systemd_action --service_name=nginx --action=reload # END OF SCRIPT #================================================= -ynh_script_progression --message="Upgrade of KiwiIRC completed" --last +ynh_script_progression --message="Upgrade of $app completed" --last