From 5cb8b26e9666298ecd96add2e42ec76bf12528f3 Mon Sep 17 00:00:00 2001 From: ericgaspar Date: Sun, 8 Nov 2020 11:26:35 +0100 Subject: [PATCH 1/4] Fix restore + cleaning up --- README.md | 16 ++++----- issue_template.md | 4 +-- manifest.json | 4 +-- pull_request_template.md | 2 +- scripts/_common.sh | 18 +++------- scripts/backup | 7 ++-- scripts/install | 76 ---------------------------------------- scripts/remove | 2 ++ scripts/restore | 23 ++++-------- scripts/upgrade | 12 ------- 10 files changed, 27 insertions(+), 137 deletions(-) diff --git a/README.md b/README.md index 5f73ea8..5a70b27 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,8 @@ # Squid3 Proxy for Yunohost with LDAP -[![Integration level](https://dash.yunohost.org/integration/squid3.svg)](https://dash.yunohost.org/appci/app/squid3) ![](https://ci-apps.yunohost.org/ci/badges/squid3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/squid3.maintain.svg) - +[![Integration level](https://dash.yunohost.org/integration/squid3.svg)](https://dash.yunohost.org/appci/app/squid3) ![](https://ci-apps.yunohost.org/ci/badges/squid3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/squid3.maintain.svg) [![Install Squid3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=squid3) -## Interesting links - -- [YunoHost project](https://yunohost.org) -- [Squid website](http://www.squid-cache.org/) - ## Squid: Proxy with Optimising Web Delivery Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. @@ -32,9 +26,15 @@ Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It r If you try Squid 3 in any other way please write the instruction in the issue so that I can add it to the readme ## Special Thanks -Thanks to **Fred** to write the instruction to configure Squid for Yunohost. French: https://memo-linux.com/installer-squid3-sur-un-serveur-yunohost/ +Thanks to **Fred** to write the instruction to configure Squid for YunoHost. French: https://memo-linux.com/installer-squid3-sur-un-serveur-yunohost/ #### Supported architectures * x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/squid3%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/squid3/) * ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/squid3%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/squid3/) + +## Links + + * Report a bug: https://github.com/YunoHost-Apps/squid3_ynh/issues + * App website: http://www.squid-cache.org/ + * YunoHost website: https://yunohost.org/ diff --git a/issue_template.md b/issue_template.md index 87b88d4..a9c1d68 100644 --- a/issue_template.md +++ b/issue_template.md @@ -7,7 +7,7 @@ about: When creating a bug report, please use the following template to provide **How to post a meaningful bug report** 1. *Read this whole template first.* 2. *Make sure you are on the right place:* - - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change url...), you are on the right place!* + - *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!* - *Otherwise, the issue may be due to the app itself. Refer to its documentation or repository for help.* - *In doubt, ask here and we will figure it out together.* 3. *Delete these italic comments as you write over them below, and remove this guide.* @@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide - *If you performed a command from the CLI, the command itself is enough. For example:* ```sh - sudo yunohost app install REPLACEBYYOURAPP + sudo yunohost app install squid3 ``` - *If you used the webadmin, please perform the equivalent command from the CLI first.* - *If the error occurs in your browser, explain what you did:* diff --git a/manifest.json b/manifest.json index 4e81b2f..4220af2 100644 --- a/manifest.json +++ b/manifest.json @@ -8,13 +8,13 @@ }, "version": "1.0~ynh2", "url": "http://www.squid-cache.org/", - "license": "GPL v2", + "license": "GPL-2.0-only", "maintainer": { "name": "Anmol Sharma", "email": "anmol@datamol.org" }, "requirements": { - "yunohost": ">= 3.5.0" + "yunohost": ">= 3.8.1" }, "multi_instance": false, "services": [], diff --git a/pull_request_template.md b/pull_request_template.md index 0287f9f..fcdffbe 100644 --- a/pull_request_template.md +++ b/pull_request_template.md @@ -15,4 +15,4 @@ --- *If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results* -[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/REPLACEBYYOURAPP_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/REPLACEBYYOURAPP_ynh%20PR-NUM-%20(USERNAME)/) +[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/squid3_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/squid3_ynh%20PR-NUM-%20(USERNAME)/) diff --git a/scripts/_common.sh b/scripts/_common.sh index e402047..57f1bda 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,19 +7,9 @@ # dependencies used by the app pkg_dependencies="squid3 mailutils" -# ============= FUTURE YUNOHOST HELPER ============= -# Delete a file checksum from the app settings -# -# $app should be defined when calling this helper -# -# usage: ynh_remove_file_checksum file -# | arg: file - The file for which the checksum will be deleted -ynh_delete_file_checksum () { - local checksum_setting_name=checksum_${1//[\/ ]/_} # Replace all '/' and ' ' by '_' - ynh_app_setting_delete $app $checksum_setting_name -} - -#!/bin/bash +#================================================= +# FUTURE OFFICIAL HELPERS +#================================================= # Send an email to inform the administrator # @@ -154,4 +144,4 @@ __PRE_TAG1__$(yunohost tools diagnosis | grep -B 100 "services:" | sed '/service # Send the email to the recipients cat mail_to_send | $mail_bin -a "Content-Type: $content_type; charset=UTF-8" -s "$mail_subject" "$recipients" -} \ No newline at end of file +} diff --git a/scripts/backup b/scripts/backup index f09fa2a..f1247fe 100755 --- a/scripts/backup +++ b/scripts/backup @@ -6,23 +6,20 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. - true -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= # LOAD SETTINGS #================================================= +ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME squid=$(ynh_app_setting_get $app squid_folder) diff --git a/scripts/install b/scripts/install index 808238c..3f69c80 100755 --- a/scripts/install +++ b/scripts/install @@ -13,10 +13,6 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - ### Remove this function if there's nothing to clean before calling the remove script. - true -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -27,16 +23,6 @@ ynh_abort_if_errors squid_port=$YNH_APP_ARG_SQUID_PORT new_port="" -### If it's a multi-instance app, meaning it can be installed several times independently -### The id of the app as stated in the manifest is available as $YNH_APP_ID -### The instance number is available as $YNH_APP_INSTANCE_NUMBER (equals "1", "2", ...) -### The app instance name is available as $YNH_APP_INSTANCE_NAME -### - the first time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample -### - the second time the app is installed, YNH_APP_INSTANCE_NAME = ynhexample__2 -### - ynhexample__{N} for the subsequent installations, with N=3,4, ... -### The app instance name is probably what interests you most, since this is -### guaranteed to be unique. This is a good unique identifier to define installation path, -### db names, ... app=$YNH_APP_INSTANCE_NAME #================================================= @@ -46,20 +32,11 @@ app=$YNH_APP_INSTANCE_NAME #================================================= ynh_script_progression --message="Configuring firewall..." -### Use these lines if you have to open a port for the application -### `ynh_find_port` will find the first available port starting from the given port. -### If you're not using these lines: -### - Remove the section "CLOSE A PORT" in the remove script - # Find an available port squid_port=$(ynh_find_port --port=$squid_port) ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port ynh_app_setting_set --app=$app --key=new_port --value=$new_port -# Optional: Expose this port publicly -# (N.B. : you only need to do this if the app actually needs to expose the port publicly. -# If you do this and the app doesn't actually need you are CREATING SECURITY HOLES IN THE SERVER !) - # Open the port ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port @@ -68,23 +45,12 @@ ynh_app_setting_set --app=$app --key=new_port --value=$new_port #================================================= ynh_script_progression --message="Installing dependencies..." -### `ynh_install_app_dependencies` allows you to add any "apt" dependencies to the package. -### Those deb packages will be installed as dependencies of this package. -### If you're not using this helper: -### - Remove the section "REMOVE DEPENDENCIES" in the remove script -### - Remove the variable "pkg_dependencies" in _common.sh -### - As well as the section "REINSTALL DEPENDENCIES" in the restore script -### - And the section "UPGRADE DEPENDENCIES" in the upgrade script - ynh_install_app_dependencies $pkg_dependencies #================================================= # MODIFY A CONFIG FILE #================================================= -### `ynh_replace_string` is used to replace a string in a file. -### (It's compatible with sed regular expressions syntax) - # See if squid3 folder exits if [ -d "/etc/squid3" ]; then squid="squid3" @@ -105,66 +71,24 @@ cp -f "../conf/squid.conf" "/etc/$squid/." ynh_app_setting_set --app=$app --key=squid_folder --value=$squid - #================================================= # STORE THE CONFIG FILE CHECKSUM #================================================= -### `ynh_store_file_checksum` is used to store the checksum of a file. -### That way, during the upgrade script, by using `ynh_backup_if_checksum_is_different`, -### you can make a backup of this file before modifying it again if the admin had modified it. - # Calculate and store the config file checksum into the app settings ynh_store_file_checksum --file="/etc/$squid/squid.conf" - -#================================================= -# ADVERTISE SERVICE IN ADMIN PANEL -#================================================= - #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." -### `yunohost service add` integrates a service in YunoHost. It then gets -### displayed in the admin interface and through the others `yunohost service` commands. -### (N.B. : this line only makes sense if the app adds a service to the system!) -### If you're not using these lines: -### - You can remove these files in conf/. -### - Remove the section "REMOVE SERVICE INTEGRATION IN YUNOHOST" in the remove script -### - As well as the section "INTEGRATE SERVICE IN YUNOHOST" in the restore script -### - And the section "INTEGRATE SERVICE IN YUNOHOST" in the upgrade script yunohost service add $app --description "Squid3 a web proxy service" --log "/var/log/$squid/access.log" -### Additional options starting with 3.8: -### -### --needs_exposed_ports "$port" a list of ports that needs to be publicly exposed -### which will then be checked by YunoHost's diagnosis system -### (N.B. DO NOT USE THIS is the port is only internal !!!) -### -### --test_status "some command" a custom command to check the status of the service -### (only relevant if 'systemctl status' doesn't do a good job) -### -### --test_conf "some command" some command similar to "nginx -t" that validates the conf of the service -### -### Re-calling 'yunohost service add' during the upgrade script is the right way -### to proceed if you later realize that you need to enable some flags that -### weren't enabled on old installs (be careful it'll override the existing -### service though so you should re-provide all relevant flags when doing so) -### - #================================================= # START SYSTEMD SERVICE #================================================= ynh_script_progression --message="Starting a systemd service..." -### `ynh_systemd_action` is used to start a systemd service for an app. -### Only needed if you have configure a systemd service -### If you're not using these lines: -### - Remove the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the backup script -### - As well as the section "START SYSTEMD SERVICE" in the restore script -### - As well as the section"STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the upgrade script -### - And the section "STOP SYSTEMD SERVICE" and "START SYSTEMD SERVICE" in the change_url script # Start a systemd service ynh_systemd_action --service_name=$squid --action="restart" --log_path="/var/log/$squid/cache.log" diff --git a/scripts/remove b/scripts/remove index 29c8131..c8335b3 100755 --- a/scripts/remove +++ b/scripts/remove @@ -13,7 +13,9 @@ source /usr/share/yunohost/helpers # LOAD SETTINGS #================================================= ynh_script_progression --message="Loading installation settings..." + app=$YNH_APP_INSTANCE_NAME + squid_port=$(ynh_app_setting_get $app squid_port) squid=$(ynh_app_setting_get $app squid_folder) diff --git a/scripts/restore b/scripts/restore index d56081f..0f05cd2 100755 --- a/scripts/restore +++ b/scripts/restore @@ -6,17 +6,13 @@ # IMPORT GENERIC HELPERS #================================================= -source _common.sh +source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers #================================================= # MANAGE SCRIPT FAILURE #================================================= -ynh_clean_setup () { - #### Remove this function if there's nothing to clean before calling the remove script. - true -} # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -41,22 +37,16 @@ ynh_install_app_dependencies $pkg_dependencies #================================================= # OPEN PORTS #================================================= -# Optional: Expose this port publicly - # (N.B. : you only need to do this if the app actually needs to expose the port publicly. - # If you do this and the app doesn't actually need you are CREATING SECURITY HOLES IN THE SERVER !) - # Find an available port - squid_port=$(ynh_find_port --port=$squid_port) - ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port - ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port +# Find an available port +squid_port=$(ynh_find_port --port=$squid_port) +ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port +ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port #================================================= # MODIFY A CONFIG FILE #================================================= -### `ynh_replace_string` is used to replace a string in a file. -### (It's compatible with sed regular expressions syntax) - # See is squid3 folder is there if [ -d "/etc/squid3" ]; then squid="squid3" @@ -85,7 +75,6 @@ yunohost app ssowatconf yunohost service add squid3 --log "/var/log/$squid/cache.log" - #================================================= # SEND A README FOR THE ADMIN #================================================= @@ -115,4 +104,4 @@ ynh_send_readme_to_admin --app_message="mail_to_send" --type="install" # END OF SCRIPT #================================================= -ynh_script_progression --message="Restoration completed for $app" \ No newline at end of file +ynh_script_progression --message="Restoration completed for $app" diff --git a/scripts/upgrade b/scripts/upgrade index d562fe0..7f45d5d 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -31,7 +31,6 @@ ynh_clean_setup () { # Exit if an error occurs during the execution of the script ynh_abort_if_errors - #================================================= # SPECIFIC RESTORATION #================================================= @@ -65,7 +64,6 @@ else ynh_app_setting_set --app=$app --key=new_port --value="" fi - #================================================= # MODIFY A CONFIG FILE #================================================= @@ -96,8 +94,6 @@ cp -f "../conf/squid.conf" "/etc/$squid/." # Save squid folder ynh_app_setting_set --app=$app --key=squid_folder --value=$squid - - # Recalculate and store the checksum of the file for the next upgrade. ynh_store_file_checksum --file="/etc/$squid/squid.conf" @@ -105,14 +101,6 @@ ynh_store_file_checksum --file="/etc/$squid/squid.conf" # ADVERTISE SERVICE IN ADMIN PANEL #================================================= -### `yunohost service add` is a CLI yunohost command to add a service in the admin panel. -### You'll find the service in the 'services' section of YunoHost admin panel. -### This CLI command would be useless if the app does not have any services (systemd or sysvinit) -### If you're not using these lines: -### - You can remove these files in conf/. -### - Remove the section "REMOVE SERVICE FROM ADMIN PANEL" in the remove script -### - As well as the section ADVERTISE SERVICE IN ADMIN PANEL" in the restore script - yunohost service add squid3 --log "/var/log/$squid/cache.log" #================================================= From 36962f384f6deabbed8c05ab1ba2e5f6abd1abf1 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Sun, 13 Mar 2022 16:50:54 +0100 Subject: [PATCH 2/4] Apply last example_ynh --- check_process | 10 ++--- conf/squid.conf | 2 +- doc/.gitkeep | 0 doc/DESCRIPTION.md | 3 ++ doc/DISCLAIMER.md | 20 +++++++++ doc/screenshots/.gitkeep | 0 manifest.json | 8 +++- scripts/_common.sh | 8 ++++ scripts/backup | 9 +++- scripts/install | 34 ++++++--------- scripts/remove | 10 ++--- scripts/restore | 52 ++++++++++++++--------- scripts/upgrade | 90 +++++++++++++++++----------------------- 13 files changed, 139 insertions(+), 107 deletions(-) create mode 100644 doc/.gitkeep create mode 100644 doc/DESCRIPTION.md create mode 100644 doc/DISCLAIMER.md create mode 100644 doc/screenshots/.gitkeep diff --git a/check_process b/check_process index 8f035db..2d18291 100644 --- a/check_process +++ b/check_process @@ -1,8 +1,3 @@ -# See here for more information -# https://github.com/YunoHost/package_check#syntax-check_process-file - -# Move this file from check_process.default to check_process when you have filled it. - ;; Test complet ; Manifest port="8095" (PORT) @@ -14,7 +9,12 @@ setup_private=0 setup_public=0 upgrade=1 + # 1.0~ynh2 + upgrade=1 from_commit=e1920eb3c212ae8d09a6e2fd8188b2f93aed0707 backup_restore=1 multi_instance=0 port_already_use=0 change_url=0 +;;; Options +Email= +Notification=none diff --git a/conf/squid.conf b/conf/squid.conf index 9398477..f25381d 100644 --- a/conf/squid.conf +++ b/conf/squid.conf @@ -42,7 +42,7 @@ http_access deny all ##cache DNS en local dns_nameservers 127.0.0.1 ##Port d'écoute du Proxy -http_port __PORT__ +http_port __SQUID_PORT__ forwarded_for off ### mode transparant, la vrai IP est cachée cache_dir aufs /var/spool/__SQUID__ 10000 16 256 hierarchy_stoplist cgi-bin ? diff --git a/doc/.gitkeep b/doc/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/doc/DESCRIPTION.md b/doc/DESCRIPTION.md new file mode 100644 index 0000000..c58434f --- /dev/null +++ b/doc/DESCRIPTION.md @@ -0,0 +1,3 @@ +## Squid: Proxy with Optimising Web Delivery + +Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. diff --git a/doc/DISCLAIMER.md b/doc/DISCLAIMER.md new file mode 100644 index 0000000..7d1669a --- /dev/null +++ b/doc/DISCLAIMER.md @@ -0,0 +1,20 @@ +## Instruction + +1. The app can not be **multi-instance**(can't be installed many times on same server). +2. **LDAP** is there(Registered users can use there login username and password to browser internet through the proxy) +3. **Port number** used by the proxy will be sent to the **admin mail** of the Yunohost server. +4. The username and password is **asked twice** first time you start the browser(I have no idea why this happens). + +## Configure Squid3 for Firefox + +1. Go to **Preferences -> General -> network proxy** +1. Select **Manual proxy configuration** +1. In **HTTP Proxy** enter your **domain name or server IP** and in **Port** enter the port sent to your **admin email**. +1. Check **Use this proxy server for all protocols**. +1. Under **No Proxy for** enter this **localhost, 127.0.0.1**. +1. **Save and restart** the Firefox. + +If you try Squid 3 in any other way please write the instruction in the issue so that I can add it to the readme + +## Special Thanks +Thanks to **Fred** to write the instruction to configure Squid for YunoHost. French: https://memo-linux.com/installer-squid3-sur-un-serveur-yunohost/ diff --git a/doc/screenshots/.gitkeep b/doc/screenshots/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/manifest.json b/manifest.json index d27d0eb..048ddd3 100644 --- a/manifest.json +++ b/manifest.json @@ -6,15 +6,19 @@ "en": "Caching proxy for the Web supporting HTTP, HTTPS, FTP and more.", "fr": "Proxy cache pour le web, compatible HTTP, HTTPS, FTP et plus encore." }, - "version": "1.0~ynh2", + "version": "1.0~ynh3", "url": "http://www.squid-cache.org/", + "upstream": { + "license": "GPL-2.0-only", + "website": "http://www.squid-cache.org" + }, "license": "GPL-2.0-only", "maintainer": { "name": "Anmol Sharma", "email": "anmol@datamol.org" }, "requirements": { - "yunohost": ">= 3.8.1" + "yunohost": ">= 4.3.0" }, "multi_instance": false, "services": [], diff --git a/scripts/_common.sh b/scripts/_common.sh index 57f1bda..169efef 100644 --- a/scripts/_common.sh +++ b/scripts/_common.sh @@ -7,6 +7,14 @@ # dependencies used by the app pkg_dependencies="squid3 mailutils" +#================================================= +# PERSONAL HELPERS +#================================================= + +#================================================= +# EXPERIMENTAL HELPERS +#================================================= + #================================================= # FUTURE OFFICIAL HELPERS #================================================= diff --git a/scripts/backup b/scripts/backup index f1247fe..048c0bc 100755 --- a/scripts/backup +++ b/scripts/backup @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -13,6 +14,9 @@ source /usr/share/yunohost/helpers # MANAGE SCRIPT FAILURE #================================================= +ynh_clean_setup () { + true +} # Exit if an error occurs during the execution of the script ynh_abort_if_errors @@ -22,10 +26,11 @@ ynh_abort_if_errors ynh_print_info --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -squid=$(ynh_app_setting_get $app squid_folder) + +squid=$(ynh_app_setting_get --app=$app --key=squid_folder) #================================================= -# BACKUP OF THE CONFIG OF SQUID3 +# BACKUP VARIOUS FILES #================================================= ynh_backup --src_path="/etc/$squid/squid.conf" diff --git a/scripts/install b/scripts/install index 3f69c80..d898bc8 100755 --- a/scripts/install +++ b/scripts/install @@ -21,7 +21,6 @@ ynh_abort_if_errors #================================================= squid_port=$YNH_APP_ARG_SQUID_PORT -new_port="" app=$YNH_APP_INSTANCE_NAME @@ -35,10 +34,10 @@ ynh_script_progression --message="Configuring firewall..." # Find an available port squid_port=$(ynh_find_port --port=$squid_port) ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port -ynh_app_setting_set --app=$app --key=new_port --value=$new_port # Open the port - ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port +ynh_script_progression --message="Configuring firewall..." +ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port #================================================= # INSTALL DEPENDENCIES @@ -48,42 +47,37 @@ ynh_script_progression --message="Installing dependencies..." ynh_install_app_dependencies $pkg_dependencies #================================================= -# MODIFY A CONFIG FILE +# SPECIFIC SETUP #================================================= +# ADD A CONFIGURATION +#================================================= +ynh_script_progression --message="Adding a configuration file..." # See if squid3 folder exits if [ -d "/etc/squid3" ]; then - squid="squid3" + squid="squid3" # If squid3 folder is not found look for squid folder elif [ -d "/etc/squid" ]; then - squid="squid" + squid="squid" # If both folders are not found then call ynh_die else - ynh_die "No squid folder found in /etc. Looks like squid 3 package is not installed. Try installing it manually." + ynh_die --message="No squid folder found in /etc. Looks like squid3 package is not installed. Try installing it manually." fi -ynh_replace_string --match_string="__PORT__" --replace_string="$squid_port" --target_file="../conf/squid.conf" -ynh_replace_string --match_string="__SQUID__" --replace_string="$squid" --target_file="../conf/squid.conf" -cp -f "../conf/squid.conf" "/etc/$squid/." -# Save squid folder in app settings - ynh_app_setting_set --app=$app --key=squid_folder --value=$squid -#================================================= -# STORE THE CONFIG FILE CHECKSUM -#================================================= - -# Calculate and store the config file checksum into the app settings -ynh_store_file_checksum --file="/etc/$squid/squid.conf" +ynh_add_config --template="../conf/squid.conf" --destination="/etc/$squid/squid.conf" +#================================================= +# GENERIC FINALIZATION #================================================= # INTEGRATE SERVICE IN YUNOHOST #================================================= ynh_script_progression --message="Integrating service in YunoHost..." -yunohost service add $app --description "Squid3 a web proxy service" --log "/var/log/$squid/access.log" +yunohost service add $app --description "Squid3 a web proxy service" --log="/var/log/$squid/access.log" --needs_exposed_ports $squid_port #================================================= # START SYSTEMD SERVICE @@ -93,8 +87,6 @@ ynh_script_progression --message="Starting a systemd service..." # Start a systemd service ynh_systemd_action --service_name=$squid --action="restart" --log_path="/var/log/$squid/cache.log" -yunohost app ssowatconf - #================================================= # SEND A README FOR THE ADMIN #================================================= diff --git a/scripts/remove b/scripts/remove index c8335b3..a38a978 100755 --- a/scripts/remove +++ b/scripts/remove @@ -16,8 +16,8 @@ ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -squid_port=$(ynh_app_setting_get $app squid_port) -squid=$(ynh_app_setting_get $app squid_folder) +squid_port=$(ynh_app_setting_get --app=$app --key=squid_port) +squid=$(ynh_app_setting_get --app=$app --key=squid_folder) #================================================= # STANDARD REMOVE @@ -25,10 +25,10 @@ squid=$(ynh_app_setting_get $app squid_folder) # REMOVE SERVICE INTEGRATION IN YUNOHOST #================================================= -# Remove the service from the list of services known by Yunohost (added from `yunohost service add`) +# Remove the service from the list of services known by YunoHost (added from `yunohost service add`) if ynh_exec_warn_less yunohost service status $app >/dev/null then - ynh_script_progression --message="Remove $squid service" + ynh_script_progression --message="Removing $app service integration..." yunohost service remove $app fi @@ -58,7 +58,7 @@ fi ynh_secure_remove --file="/etc/$squid/" # Remove the log files -ynh_secure_remove --file="/var/log/$squid/access.log" +ynh_secure_remove --file="/var/log/$squid" #================================================= # END OF SCRIPT diff --git a/scripts/restore b/scripts/restore index 0f05cd2..12ab984 100755 --- a/scripts/restore +++ b/scripts/restore @@ -6,6 +6,7 @@ # IMPORT GENERIC HELPERS #================================================= +# Keep this path for calling _common.sh inside the execution's context of backup and restore scripts source ../settings/scripts/_common.sh source /usr/share/yunohost/helpers @@ -13,23 +14,29 @@ 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 #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -squid_port=$(ynh_app_setting_get $app squid_port) +squid_port=$(ynh_app_setting_get --app=$app --key=squid_port) #================================================= # SPECIFIC RESTORATION #================================================= # REINSTALL DEPENDENCIES #================================================= +ynh_script_progression --message="Reinstalling dependencies..." +# Define and install dependencies ynh_install_app_dependencies $pkg_dependencies #================================================= @@ -44,36 +51,41 @@ ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port #================================================= -# MODIFY A CONFIG FILE +# ADD A CONFIGURATION #================================================= +ynh_script_progression --message="Adding a configuration file..." -# See is squid3 folder is there +# See if squid3 folder exits if [ -d "/etc/squid3" ]; then - squid="squid3" - # If squid3 folder is not found look for squid folder + squid="squid3" + +# If squid3 folder is not found look for squid folder elif [ -d "/etc/squid" ]; then - squid="squid" + squid="squid" + # If both folders are not found then call ynh_die else - ynh_die "No squid folder found in /etc. Looks like squid 3 package is not installed. Try installing it manually." + ynh_die --message="No squid folder found in /etc. Looks like squid3 package is not installed. Try installing it manually." fi - -# Save squid folder ynh_app_setting_set --app=$app --key=squid_folder --value=$squid -#================================================= -# RESTORE INOTIFY'S CONFIG -#================================================= -ynh_secure_remove "/etc/$squid/squid.conf" -ynh_restore_file "/etc/$squid/squid.conf" -service $squid restart -yunohost app ssowatconf -#================================================= -# ADVERTISE SERVICE IN ADMIN PANEL -#================================================= +ynh_add_config --template="../conf/squid.conf" --destination="/etc/$squid/squid.conf" -yunohost service add squid3 --log "/var/log/$squid/cache.log" +#================================================= +# INTEGRATE SERVICE IN YUNOHOST +#================================================= +ynh_script_progression --message="Integrating service in YunoHost..." + +yunohost service add $app --description "Squid3 a web proxy service" --log="/var/log/$squid/access.log" --needs_exposed_ports $squid_port + +#================================================= +# START SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Starting a systemd service..." + +# Start a systemd service +ynh_systemd_action --service_name=$squid --action="restart" --log_path="/var/log/$squid/cache.log" #================================================= # SEND A README FOR THE ADMIN diff --git a/scripts/upgrade b/scripts/upgrade index 7f45d5d..780a711 100755 --- a/scripts/upgrade +++ b/scripts/upgrade @@ -12,10 +12,19 @@ source /usr/share/yunohost/helpers #================================================= # LOAD SETTINGS #================================================= +ynh_script_progression --message="Loading installation settings..." app=$YNH_APP_INSTANCE_NAME -squid_port=$(ynh_app_setting_get $app squid_port) -new_port=$(ynh_app_setting_get $app new_port) + +squid_port=$(ynh_app_setting_get --app=$app --key=squid_port) +squid=$(ynh_app_setting_get --app=$app --key=squid_folder) + +#================================================= +# CHECK VERSION +#================================================= +ynh_script_progression --message="Checking version..." + +upgrade_type=$(ynh_check_app_version_changed) #================================================= # BACKUP BEFORE UPGRADE THEN ACTIVE TRAP @@ -25,14 +34,27 @@ ynh_script_progression --message="Backing up the app before upgrading (may take # Backup the current version of the app ynh_backup_before_upgrade ynh_clean_setup () { - # restore it if the upgrade fails + ynh_clean_check_starting + # Restore it if the upgrade fails ynh_restore_upgradebackup } # Exit if an error occurs during the execution of the script ynh_abort_if_errors #================================================= -# SPECIFIC RESTORATION +# STANDARD UPGRADE STEPS +#================================================= +# STOP SYSTEMD SERVICE +#================================================= +ynh_script_progression --message="Stopping a systemd service..." + +ynh_systemd_action --service_name=$squid --action="stop" --log_path="/var/log/$squid/cache.log" + +#================================================= +# ENSURE DOWNWARD COMPATIBILITY +#================================================= +ynh_script_progression --message="Ensuring downward compatibility..." + #================================================= # UPGRADE DEPENDENCIES #================================================= @@ -41,74 +63,40 @@ ynh_script_progression --message="Upgrading dependencies..." ynh_install_app_dependencies $pkg_dependencies #================================================= -# CLOSE A PORT +# UPDATE A CONFIG FILE #================================================= -# If #new_port is not defined test the $port and keep it open -if [ -z $new_port ]; then - ynh_exec_warn_less yunohost firewall allow --no-upnp TCP $squid_port - ynh_app_setting_set --app=$app --key=port --value=$squid_port - # If $new_port is define close the $port and open the $new_port -else - #Close $port - if yunohost firewall list | grep -q "\- $squid_port$" - then - ynh_script_progression --message="Closing port $squid_port..." - ynh_exec_warn_less yunohost firewall disallow TCP $squid_port - fi +ynh_script_progression --message="Updating a configuration file..." - # Open $new_port - port=$(ynh_find_port --port=$squid_new_port) - #Add the value of $new_port to $port - ynh_app_setting_set --app=$app --key=squid_port --value=$squid_port - #Remove the value of $new_port - ynh_app_setting_set --app=$app --key=new_port --value="" -fi - -#================================================= -# MODIFY A CONFIG FILE -#================================================= - -### `ynh_replace_string` is used to replace a string in a file. -### (It's compatible with sed regular expressions syntax) - -# See is squid3 folder is there +# See if squid3 folder exits if [ -d "/etc/squid3" ]; then - squid="squid3" + squid="squid3" # If squid3 folder is not found look for squid folder elif [ -d "/etc/squid" ]; then - squid="squid" + squid="squid" # If both folders are not found then call ynh_die else - ynh_die "No squid folder found in /etc. Looks like squid 3 package is not installed. Try installing it manually by apt-get install squid3" + ynh_die --message="No squid folder found in /etc. Looks like squid3 package is not installed. Try installing it manually." fi -### Verify the checksum of a file, stored by `ynh_store_file_checksum` in the install script. -### And create a backup of this file if the checksum is different. So the file will be backed up if the admin had modified it. -ynh_backup_if_checksum_is_different --file="/etc/$squid/squid.conf" - -ynh_replace_string --match_string="__PORT__" --replace_string="$squid_port" --target_file="../conf/squid.conf" -ynh_replace_string --match_string="__SQUID__" --replace_string="$squid" --target_file="../conf/squid.conf" -cp -f "../conf/squid.conf" "/etc/$squid/." -# Save squid folder ynh_app_setting_set --app=$app --key=squid_folder --value=$squid -# Recalculate and store the checksum of the file for the next upgrade. -ynh_store_file_checksum --file="/etc/$squid/squid.conf" +ynh_add_config --template="../conf/squid.conf" --destination="/etc/$squid/squid.conf" #================================================= -# ADVERTISE SERVICE IN ADMIN PANEL +# INTEGRATE SERVICE IN YUNOHOST #================================================= +ynh_script_progression --message="Integrating service in YunoHost..." -yunohost service add squid3 --log "/var/log/$squid/cache.log" +yunohost service add $app --description "Squid3 a web proxy service" --log="/var/log/$squid/access.log" --needs_exposed_ports $squid_port #================================================= -# RESTART SQUID'S SERVICE and SSOWATCONF +# START SYSTEMD SERVICE #================================================= +ynh_script_progression --message="Starting a systemd service..." -service $squid restart -yunohost app ssowatconf +ynh_systemd_action --service_name=$squid --action="restart" --log_path="/var/log/$squid/cache.log" #================================================= # SEND A README FOR THE ADMIN From d226b285e6a417c34a8255d5429b53427169a467 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 13 Mar 2022 15:50:59 +0000 Subject: [PATCH 3/4] Auto-update README --- README.md | 45 +++++++++++++++++++++++++++++-------- README_fr.md | 63 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 99 insertions(+), 9 deletions(-) create mode 100644 README_fr.md diff --git a/README.md b/README.md index 5a70b27..0423923 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,31 @@ -# Squid3 Proxy for Yunohost with LDAP + + +# squid3 for YunoHost [![Integration level](https://dash.yunohost.org/integration/squid3.svg)](https://dash.yunohost.org/appci/app/squid3) ![](https://ci-apps.yunohost.org/ci/badges/squid3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/squid3.maintain.svg) -[![Install Squid3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=squid3) +[![Install squid3 with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=squid3) + +*[Lire ce readme en français.](./README_fr.md)* + +> *This package allows you to install squid3 quickly and simply on a YunoHost server. +If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.* + +## Overview ## Squid: Proxy with Optimising Web Delivery Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. + +**Shipped version:** 1.0~ynh3 + + + +## Disclaimers / important information + ## Instruction 1. The app can not be **multi-instance**(can't be installed many times on same server). @@ -28,13 +47,21 @@ If you try Squid 3 in any other way please write the instruction in the issue so ## Special Thanks Thanks to **Fred** to write the instruction to configure Squid for YunoHost. French: https://memo-linux.com/installer-squid3-sur-un-serveur-yunohost/ -#### Supported architectures +## Documentation and resources -* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/squid3%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/squid3/) -* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/squid3%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/squid3/) +* Official app website: http://www.squid-cache.org +* YunoHost documentation for this app: https://yunohost.org/app_squid3 +* Report a bug: https://github.com/YunoHost-Apps/squid3_ynh/issues -## Links +## Developer info - * Report a bug: https://github.com/YunoHost-Apps/squid3_ynh/issues - * App website: http://www.squid-cache.org/ - * YunoHost website: https://yunohost.org/ +Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/squid3_ynh/tree/testing). + +To try the testing branch, please proceed like that. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/squid3_ynh/tree/testing --debug +or +sudo yunohost app upgrade squid3 -u https://github.com/YunoHost-Apps/squid3_ynh/tree/testing --debug +``` + +**More info regarding app packaging:** https://yunohost.org/packaging_apps \ No newline at end of file diff --git a/README_fr.md b/README_fr.md new file mode 100644 index 0000000..fb77d5b --- /dev/null +++ b/README_fr.md @@ -0,0 +1,63 @@ +# squid3 pour YunoHost + +[![Niveau d'intégration](https://dash.yunohost.org/integration/squid3.svg)](https://dash.yunohost.org/appci/app/squid3) ![](https://ci-apps.yunohost.org/ci/badges/squid3.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/squid3.maintain.svg) +[![Installer squid3 avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=squid3) + +*[Read this readme in english.](./README.md)* +*[Lire ce readme en français.](./README_fr.md)* + +> *Ce package vous permet d'installer squid3 rapidement et simplement sur un serveur YunoHost. +Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* + +## Vue d'ensemble + +## Squid: Proxy with Optimising Web Delivery + +Squid is a caching proxy for the Web supporting HTTP, HTTPS, FTP, and more. It reduces bandwidth and improves response times by caching and reusing frequently-requested web pages. Squid has extensive access controls and makes a great server accelerator. + + +**Version incluse :** 1.0~ynh3 + + + +## Avertissements / informations importantes + +## Instruction + +1. The app can not be **multi-instance**(can't be installed many times on same server). +2. **LDAP** is there(Registered users can use there login username and password to browser internet through the proxy) +3. **Port number** used by the proxy will be sent to the **admin mail** of the Yunohost server. +4. The username and password is **asked twice** first time you start the browser(I have no idea why this happens). + +## Configure Squid3 for Firefox + +1. Go to **Preferences -> General -> network proxy** +1. Select **Manual proxy configuration** +1. In **HTTP Proxy** enter your **domain name or server IP** and in **Port** enter the port sent to your **admin email**. +1. Check **Use this proxy server for all protocols**. +1. Under **No Proxy for** enter this **localhost, 127.0.0.1**. +1. **Save and restart** the Firefox. + +If you try Squid 3 in any other way please write the instruction in the issue so that I can add it to the readme + +## Special Thanks +Thanks to **Fred** to write the instruction to configure Squid for YunoHost. French: https://memo-linux.com/installer-squid3-sur-un-serveur-yunohost/ + +## Documentations et ressources + +* Site officiel de l'app : http://www.squid-cache.org +* Documentation YunoHost pour cette app : https://yunohost.org/app_squid3 +* Signaler un bug : https://github.com/YunoHost-Apps/squid3_ynh/issues + +## Informations pour les développeurs + +Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/squid3_ynh/tree/testing). + +Pour essayer la branche testing, procédez comme suit. +``` +sudo yunohost app install https://github.com/YunoHost-Apps/squid3_ynh/tree/testing --debug +ou +sudo yunohost app upgrade squid3 -u https://github.com/YunoHost-Apps/squid3_ynh/tree/testing --debug +``` + +**Plus d'infos sur le packaging d'applications :** https://yunohost.org/packaging_apps \ No newline at end of file From 9204572d6fb12444002a9e624d20d22db72c4527 Mon Sep 17 00:00:00 2001 From: yalh76 Date: Mon, 14 Mar 2022 22:07:18 +0100 Subject: [PATCH 4/4] Cleanup restore --- scripts/restore | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/restore b/scripts/restore index 12ab984..f4b1c34 100755 --- a/scripts/restore +++ b/scripts/restore @@ -70,6 +70,7 @@ else fi ynh_app_setting_set --app=$app --key=squid_folder --value=$squid +ynh_secure_remove --file="/etc/$squid/squid.conf" ynh_add_config --template="../conf/squid.conf" --destination="/etc/$squid/squid.conf" #=================================================