Add wording for "down" versus "stop" to the comment in docker-compose…

….dist.yml.
drgrice1 · Nov 11, 2024 · 0339cc6 · 0339cc6
1 parent 868aafa
commit 0339cc6
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 5 deletions.
diff --git a/conf/authen_saml2.conf.dist b/conf/authen_saml2.conf.dist
@@ -1,7 +1,7 @@
 #!perl
 ################################################################################
 # Configuration for using Saml2 authentication.
-# To enable this Saml2 authentication, copy this file to conf/authen_saml2.conf
+# To enable Saml2 authentication, copy this file to conf/authen_saml2.conf
 # and uncomment the appropriate lines in localOverrides.conf. The Saml2
 # authentication module uses the Net::SAML2 library. The library claims to be
 # compatible with a wide range of SAML2 implementations, including Shibboleth.

diff --git a/docker-config/docker-compose.dist.yml b/docker-config/docker-compose.dist.yml
@@ -252,8 +252,9 @@ services:
     #  - "6311:6311"
 
   # SimpleSAMLphp Saml2 identity provider for development use only. This is a separate profile from the other services
-  # so it doesn't start in normal usage. Use "docker compose --profile saml2dev up" to start, and "docker compose
-  # --profile saml2dev down" to stop.
+  # so it doesn't start in normal usage. Use "docker compose --profile saml2dev up" to start, "docker compose --profile
+  # saml2dev stop" to stop services, and "docker compose --profile saml2dev down" to stop services and remove
+  # containers.
   idp:
     build:
       context: ./docker-config/idp/

diff --git a/lib/WeBWorK/Authen/Saml2.pm b/lib/WeBWorK/Authen/Saml2.pm
@@ -122,7 +122,7 @@ sub do_verify ($self) {
 				$c->param('key',  $self->{session_key});
 				$c->stash->{saml2_redirect} = $c->systemLink($c->url_for($c->stash->{saml2}{relayState}{url}));
 
-				# Save these in the stash for now.  They will be transfered to the session after it has been created.
+				# Save these in the stash for now.  They will be transferred to the session after it has been created.
 				$c->stash->{saml2_nameid}  = $assertion->nameid;
 				$c->stash->{saml2_session} = $assertion->{session};
 
@@ -205,7 +205,7 @@ sub sp ($self) {
 }
 
 # The first time this method is executed for a given identity provider, the metadata file is retrieved from the metadata
-# URL.  It is then saved in the the $ce->{saml2}{active_idp} subdirectory of $ce->{webworkDirs}{DATA}/Saml2IDPs together
+# URL.  It is then saved in the $ce->{saml2}{active_idp} subdirectory of $ce->{webworkDirs}{DATA}/Saml2IDPs together
 # with the identity provider's signing key which is extracted from the retrieved metadata.  On later requests the
 # metadata and certificate are used from the saved files.  This prevents the need to retrieve the metadata on every
 # login request.