From d226b285e6a417c34a8255d5429b53427169a467 Mon Sep 17 00:00:00 2001 From: yunohost-bot Date: Sun, 13 Mar 2022 15:50:59 +0000 Subject: [PATCH] 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