Deprecate CLI parameters for configuration

Author: m-mohr

README.md

@@ -60,27 +60,32 @@ npm install
 
 By default, STAC Browser will let you browse all catalogs on STAC Index.
 
-To browse only your own static STAC catalog or STAC API, set the `catalogUrl` CLI parameter when running the dev server.
+To browse only your own static STAC catalog or STAC API, set the [`catalogUrl`](docs/options.md#catalogurl) config parameter when running the dev server.
 In this example we point to EarthSearch (`https://earth-search.aws.element84.com/v1/`):
 
 ```bash
-npm start -- --open --catalogUrl="https://earth-search.aws.element84.com/v1/"
+# Linux / MacOS
+SB_catalogUrl="https://earth-search.aws.element84.com/v1/" npm start
+# Windows (PowerShell)
+$env:SB_catalogUrl="https://earth-search.aws.element84.com/v1/"; npm start
 ```
 
+This will start the development server on <http://localhost:8080>, which you can then open in your preferred browser.
+
 To open a local file on your system, see the chapter [Using Local Files](docs/local_files.md).
 
 If you'd like to publish the STAC Browser instance use the following command:
 
 ```bash
-npm run build -- --catalogUrl="https://earth-search.aws.element84.com/v1/"
+# Linux / MacOS
+SB_catalogUrl="https://earth-search.aws.element84.com/v1/" npm run build
+# Windows (PowerShell)
+$env:SB_catalogUrl="https://earth-search.aws.element84.com/v1/"; npm run build
 ```
 
 This will only work on the root path of your domain though. If you'd like to publish in a sub-folder,
 you can use the [`pathPrefix`](docs/options.md#pathprefix) option.
 
-> [!NOTE]  
-> If you are using a recent version of node/npm on Windows, you may need to use `npm run build -- -- ...` instead of `npm run build -- ...`, see <https://github.com/npm/cli/issues/7375> for details.
-
 After building, `dist/` will contain all assets necessary
 host the browser. These can be manually copied to your web host of choice.
 **Important:** If `historyMode` is set to `history` (which is the default value), you'll need to add

docs/options.md

@@ -6,14 +6,17 @@ The following options can be provided in various ways to STAC Browser, either wh
 The following ways to set config options are possible:
 
 - Customize the **[config file](../config.js)** (recommended)
-- Additionally, some options can be [provided through the **root catalog**](../README.md#customize-through-root-catalog) for consistency across multiple deployments (recommended)
-- Append them to the **CLI** command as parameter (see [Get Started](../README.md#get-started) for an example)
+- Additionally, some options can be [provided through the **root catalog**](../README.md#customize-through-root-catalog) for consistency across multiple deployments
 - Set **environment variables**, all options need a `SB_` prefix.
   So you could for example set the catalog URL via the environment variable `SB_catalogUrl`.
 - Optionally, you can also set options after the build, basically **at "runtime"**.
   Enable this by removing the `<!--` and `-->` around the `<script defer="defer" src="./config.js"></script>` in the [`public/index.html`](../public/index.html).
   Then run the build procedure and after completion, you can fill the `dist/config.js` with any options that you want to customize.
 
+> [!WARNING]  
+> Appending configuration options as CLI parameters to the CLI command (e.g. `npm run build -- --catalogUrl="https://example.com"`) is DEPRECATED and will be removed in STAC Browser v5.
+> Reason is that such parameters are [not suppored by Vite](https://github.com/vitejs/vite/issues/7065), which will be used in v5 instead of vue-cli.
+
 ## Table of Contents <!-- omit in toc -->
 
 - [Basic configuration](#basic-configuration)
@@ -129,19 +132,17 @@ This also excludes hosting your STAC catalog in the STAC Browser (sub-)folders.
 #### `hash`
 
 If your host/server doesn't support URL rewriting or you experience other related problems, you can enable *hash mode*.
-Either set this option to `hash` in the config file or append `--historyMode=hash` when running or building.
+Either set this option to `hash` in the config file or as environment variable (`SB_historyMode`) when running or building.
 Known hosts that require hash mode are Amazon S3 and GitHub Pages.
 
 ### pathPrefix
 
 ***build-only option***
 
 If you don't deploy the STAC Browser instance at the root path of your (sub) domain, then you need to set the path prefix
-when building (or running) STAC Browser.
+when building (or running) STAC Browser. Known hosts that require hash mode are Amazon S3 and GitHub Pages.
 
-```bash
-npm run build -- --pathPrefix="/browser/"
-```
+Either set this option to the respective path (e.g. `/browser/`) in the config file or as environment variable (`SB_pathPrefix`) when running or building.
 
 This will build STAC Browser in a way that it can be hosted at `https://example.com/browser` for example.
 Using this parameter for the dev server will make STAC Browser available at `http://localhost:8080/browser`.