--- title: Charmhub | Deploy Squid auth helper for local auth using Charmhub - The Open Operator Collection description: Deploy the latest version of Squid auth helper for local auth on any cloud. Htfile Auth for Squid Proxy url: https://charmhub.io/digest-squid-auth-helper --- # Squid auth helper for local auth [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps") * [Canonical IS DevOps](https://charmhub.io/publisher/canonical-is-devops "View all packages from Canonical IS DevOps") Platform: 22.04 20.04 5/stable 15 ``` juju deploy digest-squid-auth-helper --channel 5/stable ``` [Learn to deploy on juju >](https://juju.is/docs/juju/manage-applications) --- #### Relevant links * [Contact](https://launchpad.net/~canonical-is-devops) --- #### Contacts ##### Maintainers + [Launchpad Team](https://launchpad.net/~canonical-is-devops) * [Submit a bug](https://github.com/canonical/digest-squid-auth-helper/issues) --- Share your thoughts on this charm with the community on discourse. [Join the discussion](https://discourse.charmhub.io/) A [Juju](https://juju.is/) subordinate [charm](https://juju.is/docs/olm/charmed-operators) for the [Squid reverse proxy charm](https://charmhub.io/squid-reverseproxy) that enables digest or basic authentication using squid-auth-helper relation. As a subordinate charm this charm requires the [Squid reverse proxy charm](https://charmhub.io/squid-reverseproxy) to be deployed and integrated with it. The charm brings digest or basic authentication support to the Squid reverse proxy using the `squid-auth-helper` charm relation. It allows you to manage user credentials through charm actions (create-user, remove-user, list-users), and configure authentication parameters using charm configuration. While the Squid reverse proxy charm targets a “reverse proxy setup”. This subordinate charm is currently only tested for a “forward proxy” use case and will enable you to control accesses in this context. ## [In this documentation](https://charmhub.io/digest-squid-auth-helper#p-34997-in-this-documentation) | | | | --- | --- | | [Tutorials](https://charmhub.io/digest-squid-auth-helper#tutorial-5) Get started - a hands-on introduction to using the charm for new users | [How-to guides](https://charmhub.io/digest-squid-auth-helper#how-to-8) Step-by-step guides covering key operations and common tasks | ## [Contributing to this documentation](https://charmhub.io/digest-squid-auth-helper#p-34997-contributing-to-this-documentation) Documentation is an important part of this project, and we take the same open-source approach to the documentation as the code. As such, we welcome community contributions, suggestions and constructive feedback on our documentation. Our documentation is hosted on the [Charmhub forum](https://discourse.charmhub.io/t/digest-squid-auth-helper-documentation-overview/) to enable easy collaboration. Please use the “Help us improve this documentation” links on each documentation page to either directly change something you see that’s wrong, ask a question or make a suggestion about a potential change via the comments section. If there’s a particular area of documentation that you’d like to see that’s missing, please [file a bug](https://github.com/canonical/digest-squid-auth-helper/issues). ## [Project and community](https://charmhub.io/digest-squid-auth-helper#p-34997-project-and-community) The *digest-squid-auth-helper* charm is a member of the Ubuntu family. It’s an open-source project that warmly welcomes community projects, contributions, suggestions, fixes, and constructive feedback. * [Code of conduct](https://ubuntu.com/community/code-of-conduct) * [Get support](https://discourse.charmhub.io/) * [Join our online chat](https://matrix.to/#/#charmhub-charmdev:ubuntu.com) Thinking about using the *digest-squid-auth-helper* charm for your next project? [Get in touch](https://matrix.to/#/#charmhub-charmdev:ubuntu.com)! # Documentation ## [Tutorial](https://charmhub.io/digest-squid-auth-helper#p-34997-tutorial) ### [Set up](https://charmhub.io/digest-squid-auth-helper#p-34997-set-up) If you don’t already have a running Juju environment, you can follow the [Get started with Juju](https://juju.is/docs/juju/tutorial) guide to set up an isolated test environment. As this charm is a subordinate charm, you should have a [Squid reverse proxy charm](https://charmhub.io/squid-reverseproxy) running before deploying it. * Create your juju model: `juju add-model test-squid` * Deploy the reverse proxy charm: `juju deploy squid-reverseproxy` * Monitor the deployment with: `juju status --watch 2s` ### [Deploy](https://charmhub.io/digest-squid-auth-helper#p-34997-deploy) Once your Squid instance is running, deploy the auth helper charm with `juju deploy digest-squid-auth-helper` and integrate it with your reverse proxy with `juju integrate squid-reverseproxy digest-squid-auth-helper`. ## [How-to](https://charmhub.io/digest-squid-auth-helper#p-34997-how-to) ### [Configure the authentication type](https://charmhub.io/digest-squid-auth-helper#p-34997-configure-the-authentication-type) The default configuration can be seen using the `juju config digest-squid-auth-helper` command. The default authentication type is “digest”. If you want to switch to Basic authentication, you can issue the `juju config digest-squid-auth-helper authentication-type=basic` command. Warning: changing the authentication type will reset all existing users. ### [Give access to users](https://charmhub.io/digest-squid-auth-helper#p-34997-give-access-to-users) New users can be given access through the `juju run digest-squid-auth-helper/0 create-user username=yourusername`. The command will return you the username, realm and password. ### [List current users](https://charmhub.io/digest-squid-auth-helper#p-34997-list-current-users) The `juju run digest-squid-auth-helper/0 list-users` will return the list of active users. ### [Remove users](https://charmhub.io/digest-squid-auth-helper#p-34997-remove-users) You can remove users with `juju run digest-squid-auth-helper/0 remove-user username=yourusername` Note: Squid caches some authentication look-ups (see [documentation](https://wiki.squid-cache.org/Features/Authentication#does-squid-cache-authentication-lookups)). # Contents --- [Help improve this document in the forum](https://discourse.charmhub.io/t/digest-squid-auth-helper-documentation-overview/16141) ([guidelines](https://discourse.charmhub.io/t/how-to-write-docs-our-documentation-guidelines-for-contributors/1245)). Last updated 1 year, 1 month ago.