Rjm/remoteuser

README.md

@@ -25,6 +25,12 @@ A Cornell University CIT Custom Development starter kit package for Laravel.
    ```
    This will publish a `README.md` and `.lando.yml` file to the base directory, configured on the project settings. It will also publish HTML/CSS/JS assets from [cwd_framework_lite](https://github.com/CU-CommunityApps/cwd_framework_lite) and a set of [view components](https://laravel.com/docs/9.x/blade#layouts-using-components) that can be used to begin a layout (see `views/cwd-framework-index.blade.php` for example usage).
 
+Optional:
+   To publish the configuration file for the Starter Kit
+   ```shell
+   php artisan vendor:publish --tag="starterkit-config"
+   ```
+
 ## Contributing
 
 Anyone on the Custom Development team should be welcome and able to contribute. See [CONTRIBUTING](CONTRIBUTING.md) for details on how be involved and provide quality contributions.

config/starterkit.php

@@ -0,0 +1,24 @@
+<?php
+
+return [
+
+    /* 
+     * The users' netid may be retrieved from an environment variable
+     * populated by the Apache shibboleth module.  
+     * 
+     * The default env variable is REMOTE USER, but this may be e.g, 
+     * REDIRECT_REMOTE_USER on some servers, depending on how PHP is installed.
+     * 
+     * This configuration allows configuration of the remote_user_variable so it
+     * is not hardcoded in the application. 
+     * 
+     * In project code, use env(config('starterkit.remote_user_variable')) to retrieve the netid
+     *
+     * For local development without shibboleth, you can add
+     * REMOTE_USER=<netid>
+     * to your project .env file to set the user netid. 
+     *
+     */
+    'remote_user_variable' => env("REMOTE_USER_VARIABLE", "REMOTE_USER"),
+
+];

src/StarterKitServiceProvider.php

@@ -58,6 +58,7 @@ public function configurePackage(Package $package): void
     {
         $package
             ->name(self::PACKAGE_NAME)
+            ->hasConfigFile()
             ->hasInstallCommand(function (InstallCommand $command) {
                 $command->startWith(fn (InstallCommand $c) => $this->install($c));
             });