signalytic/streamline-emr
1
0
Fork 0
mirror of https://gitlab.com/signalytic/client-external/streamline/streamline-emr.git synced 2026-09-11 10:41:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

update readme file to clarify installation, configuration process

Browse Source
This commit is contained in:
alec.turner
2024-03-08 15:32:19 -08:00
parent 41a04e5b2d
commit 5072872bdb
1 changed files with 22 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -1
View File
@@ -7,9 +7,20 @@ Packaging and installation tools for Streamline's "Streamline EMR" application.
2. run `package.sh` to generate a new application package
3. package will be stored to `build-packages/`
### Alternative Builds
Some variables can be overridden to support alternative builds. For example, an option exists to package the application WITHOUT docker images. This can be done by setting the appropriate environment variables (e.g. `VAR=VALUE ./package.sh`).
Options that can be overridden are:
- `PACKAGE_NAME`: base name of the output package. (default: `streamline-emr`)
- `OUTPUT_DIR`: directory where packages will be stored. (default: `$PROJECT_ROOT/build-packages`)
- `PACKAGE_IMAGES`: if set to a value other than 1, do NOT package images. (default: `1`)
## Installing
1. extract the generated archive file in a temporary folder on the target system
2. run `install.sh`
2. run `<package-name>/install.sh`
3. add a `instance.conf` file at the root of the install directory (see notes below)
4. (optional) restart the systemd service if running on a system with systemd installed: `systemctl restart streamline-emr`
5. (optional) configure an `app.conf` file for integration with Signalytic services (e.g. dbsync)
## Running
### Production (systemd)
@@ -27,6 +38,9 @@ systemctl stop streamline-emr
systemctl restart streamline-emr
```
## Monitoring
The script `monitor` can be used at any time to query the current status of all instances. If the `bgsystemlog` program is found, status data will be written to the Signalytic system log under the `streamline_emr` location (json format).
### Docker
In a docker environment, the application must be started manually. This is done by running the `entry` script, for example:
```
@@ -50,6 +64,13 @@ Each instance of the app uses its own `.env` file to specify its configuration.
Important note when using "sibling containers": the sibling container method uses the host docker socket to provide containers with access to docker. As a result, port mappings and volumne mount points all refer to the host system rather than the container from which the docker command originates.
### Example Configuration Files
The following snippet shows an `instances.conf` file with 3 instances defined. Instance `test0001-_default` will use port `3001`, `test0002-_default` will use `3002`, etc.
```
INSTANCES="test0001-_default" "test0002-_default" "test0003-_default"
APP_PORTS=3001 3002 3003
```
### App Configuration
An `app.conf` file is required for integration with other Signalytic services. A template is provided which demonstrates integration with the `dbsync` service.