From e0d278186ae532a54ee9df87e9abdde6ff75bdd7 Mon Sep 17 00:00:00 2001 From: Attila Kovacs Date: Sun, 15 Sep 2024 10:17:06 +0200 Subject: [PATCH] README edits --- .github/workflows/test.yml | 2 +- README.md | 15 +++++++++++++-- 2 files changed, 14 insertions(+), 3 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 7b4dd8d..d1b5f70 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -1,4 +1,4 @@ -name: Test installer +name: Installer status on: push: diff --git a/README.md b/README.md index 5c7d2e2..011afe8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Test installer](https://github.com/Smithsonian/smax-server/actions/workflows/test.yml/badge.svg) +![Installer Status](https://github.com/Smithsonian/smax-server/actions/workflows/test.yml/badge.svg) @@ -42,7 +42,18 @@ After you have installed and configured Redis (or equivalent), you can configure sudo ./install.sh ``` -It will ask you some questions on how exactly you want SMA-X to be installed and deployed. +It will ask you some questions on how exactly you want SMA-X to be installed and deployed. Optionally, you may define +an alternative installation mode as an argument to `install.sh`. The following modes are supported: + + - `auto`: Automatic installation and startup + - `sma` : Automatic installation and startup at the SMA + - `help`: Provides a simple help screen only. + +Additionally, you may define a couple of shell variables prior to invoking `install.sh` to guide its behavior: + + - `DESTDIR` : Set the deployment root directory (default is `/usr`) + - `PREFIX` : Set a staging prefix. If `PREFIX` is defined and not empty, `install.sh` will stage only, without + starting up services (which are not yet in their final location). After a successful installation you may use `systemctl` to manage `redis` and the `smax-scripts` services.