Skip to content

update script defaults for v24.11.0 #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
labkey-jony merged 1 commit into from
Dec 13, 2024
Merged

update script defaults for v24.11.0 #74

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 32 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ A repository for shell scripts that aid in the installation of LabKey products a
- AlmaLinux 9
- Amazon Linux v2
- RedHat Enterprise Linux 9
- Ubuntu 20.04 & 22.04
- Ubuntu 20.04, 22.04 & 24.04

## LabKey Install Script Usage Examples

Expand All @@ -19,13 +19,13 @@ Environment variable inputs can be provided as part of the command line when inv

```bash
sudo su -
LABKEY_COMPANY_NAME='Megadodo Publications' LABKEY_DEFAULT_DOMAIN='megadodo.com' LABKEY_BASE_SERVER_URL='https://megadodo.com' LABKEY_VERSION='21.7.1' ./install-labkey.bash
LABKEY_COMPANY_NAME='Megadodo Publications' LABKEY_DEFAULT_DOMAIN='megadodo.com' LABKEY_BASE_SERVER_URL='https://megadodo.com' LABKEY_VERSION='24.11.0' LABKEY_APP_HOME='/labkey' LABKEY_FILES_ROOT='/labkey/labkey/files' LABKEY_SYSTEM_DESCRIPTION='Megadodo demo deployment' POSTGRES_SVR_LOCAL='TRUE' ./install-labkey.bash
```

Another option for achieving super-user privileges while maintaining environment variables is `sudo`'s "-E" flag. Which passes the current environment through to the command you're using `sudo` to run:

```bash
export LABKEY_COMPANY_NAME='Megadodo Publications' LABKEY_DEFAULT_DOMAIN='megadodo.com' LABKEY_BASE_SERVER_URL='https://megadodo.com' LABKEY_VERSION='21.7.1'
export LABKEY_COMPANY_NAME='Megadodo Publications' LABKEY_DEFAULT_DOMAIN='megadodo.com' LABKEY_BASE_SERVER_URL='https://megadodo.com' LABKEY_VERSION='24.11.0' LABKEY_APP_HOME='/labkey' LABKEY_FILES_ROOT='/labkey/labkey/files' LABKEY_SYSTEM_DESCRIPTION='Megadodo demo deployment' POSTGRES_SVR_LOCAL='TRUE'
sudo -E ./install-labkey.bash
```

Expand Down Expand Up @@ -63,35 +63,35 @@ The following tables list the available input variables and default values. In t

### General Install Inputs

| Name | Description | Default value | Required |
|-----------------------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| JAVA_HEAP_SIZE | Java heap size | Input value or calculated >8GB = 75% of RAM, <8GB = 50% of RAM | no |
| LABKEY_COMPANY_NAME | Company name used in application settings | LabKey | no |
| LABKEY_SYSTEM_DESCRIPTION | System description | labkey demo deployment | no |
| LABKEY_SYSTEM_SHORT_NAME | Short name used in application settings | demo | no |
| LABKEY_DEFAULT_DOMAIN | Default domain used in application settings | labkey.com | yes |
| LABKEY_SYSTEM_EMAIL_ADDRESS | Default email used for system notifications | donotreply@${LABKEY_DEFAULT_DOMAIN} | no |
| LABKEY_BASE_SERVER_URL | System URL | <http://localhost> | yes |
| LABKEY_APP_HOME | Base path for LabKey installation | /labkey | yes |
| LABKEY_INSTALL_HOME | Path for LabKey web application files | $LABKEY_APP_HOME/labkey | no |
| LABKEY_SRC_HOME | Path used for downloaded install components | $LABKEY_APP_HOME/src/labkey | no |
| LABKEY_FILES_ROOT | LabKey file root path for LabKey application | ${LABKEY_INSTALL_HOME}/files | no |
| LABKEY_VERSION | Version of LabKey to install | 21.7.0 | yes |
| LABKEY_BUILD | Build number of LabKey version to install | 2 | yes |
| LABKEY_DISTRIBUTION | Name of LabKey distribution to install | community | yes |
| LABKEY_DIST_BUCKET | Bucket name where distributions are located | lk-binaries | no |
| LABKEY_DIST_REGION | Region the LABKEY_DIST_BUCKET resides in | us-west-2 | no |
| LABKEY_DIST_URL | URL for downloading distribution files | https://${LABKEY_DIST_BUCKET}.s3.${LABKEY_DIST_REGION}.amazonaws.com/downloads/release/${LABKEY_DISTRIBUTION}/${LABKEY_VERSION}/LabKey${LABKEY_VERSION}-${LABKEY_BUILD}-${LABKEY_DISTRIBUTION}-embedded.tar.gz | no |
| LABKEY_DIST_FILENAME | Filename of distribution | LabKey${LABKEY_VERSION}-${LABKEY_BUILD}-${LABKEY_DISTRIBUTION}-embedded.tar.gz | no |
| LABKEY_DIST_DIR | Name of distribution directory (removes embedded from file name) | ${LABKEY_DIST_FILENAME::-16} | no |
| LABKEY_HTTP_PORT | TCP Port for tomcat/LabKey application | 8080 | no |
| LABKEY_HTTPS_PORT | TCP Port for tomcat/LabKey application | 8443 | no |
| LABKEY_LOG_DIR | Log directory for LabKey application logs | ${LABKEY_INSTALL_HOME}/logs | no |
| LABKEY_CONFIG_DIR | Config directory for tomcat/LabKey applications | ${LABKEY_INSTALL_HOME}/config | no |
| LABKEY_EXT_MODULES_DIR | Path to LabKey external modules directory | ${LABKEY_EXT_MODULES_DIR:-${LABKEY_INSTALL_HOME}/externalModules} | no |
| LABKEY_STARTUP_DIR | Path to LabKey startup directory | ${LABKEY_INSTALL_HOME}/server/startup | no |
| LABKEY_MEK | Arbitrary string used in LabKey application to encrypt data | Randomly generated if none is provided | yes |
| LABKEY_GUID | LabKey application GUID used to uniquely identify an installation | Randomly generated if none is providing using `uuidgen` | no |
| Name | Description | Default value | Required |
|-----------------------------|-------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------|
| JAVA_HEAP_SIZE | Java heap size | Input value or calculated >8GB = 75% of RAM, <8GB = 50% of RAM | no |
| LABKEY_COMPANY_NAME | Company name used in application settings | LabKey | no |
| LABKEY_SYSTEM_DESCRIPTION | System description | labkey demo deployment | no |
| LABKEY_SYSTEM_SHORT_NAME | Short name used in application settings | demo | no |
| LABKEY_DEFAULT_DOMAIN | Default domain used in application settings | labkey.com | yes |
| LABKEY_SYSTEM_EMAIL_ADDRESS | Default email used for system notifications | donotreply@${LABKEY_DEFAULT_DOMAIN} | no |
| LABKEY_BASE_SERVER_URL | System URL | <http://localhost> | yes |
| LABKEY_APP_HOME | Base path for LabKey installation | /labkey | yes |
| LABKEY_INSTALL_HOME | Path for LabKey web application files | $LABKEY_APP_HOME/labkey | no |
| LABKEY_SRC_HOME | Path used for downloaded install components | $LABKEY_APP_HOME/src/labkey | no |
| LABKEY_FILES_ROOT | LabKey file root path for LabKey application | ${LABKEY_INSTALL_HOME}/files | no |
| LABKEY_VERSION | Version of LabKey to install | 24.11.0 | yes |
| LABKEY_BUILD | Build number of LabKey version to install | 2 | yes |
| LABKEY_DISTRIBUTION | Name of LabKey distribution to install | community | yes |
| LABKEY_DIST_BUCKET | Bucket name where distributions are located | lk-binaries | no |
| LABKEY_DIST_REGION | Region the LABKEY_DIST_BUCKET resides in | us-west-2 | no |
| LABKEY_DIST_URL | URL for downloading distribution files | https://${LABKEY_DIST_BUCKET}.s3.${LABKEY_DIST_REGION}.amazonaws.com/downloads/release/${LABKEY_DISTRIBUTION}/${LABKEY_VERSION}/LabKey${LABKEY_VERSION}-${LABKEY_BUILD}-${LABKEY_DISTRIBUTION}.tar.gz | no |
| LABKEY_DIST_FILENAME | Filename of distribution | LabKey${LABKEY_VERSION}-${LABKEY_BUILD}-${LABKEY_DISTRIBUTION}.tar.gz | no |
| LABKEY_DIST_DIR | Name of distribution directory (removes .tar.gz from file name) | ${LABKEY_DIST_FILENAME::-7} | no |
| LABKEY_HTTP_PORT | TCP Port for tomcat/LabKey application | 8080 | no |
| LABKEY_HTTPS_PORT | TCP Port for tomcat/LabKey application | 8443 | no |
| LABKEY_LOG_DIR | Log directory for LabKey application logs | ${LABKEY_INSTALL_HOME}/logs | no |
| LABKEY_CONFIG_DIR | Config directory for tomcat/LabKey applications | ${LABKEY_INSTALL_HOME}/config | no |
| LABKEY_EXT_MODULES_DIR | Path to LabKey external modules directory | ${LABKEY_EXT_MODULES_DIR:-${LABKEY_INSTALL_HOME}/externalModules} | no |
| LABKEY_STARTUP_DIR | Path to LabKey startup directory | ${LABKEY_INSTALL_HOME}/server/startup | no |
| LABKEY_MEK | Arbitrary string used in LabKey application to encrypt data | Randomly generated if none is provided | yes |
| LABKEY_GUID | LabKey application GUID used to uniquely identify an installation | Randomly generated if none is providing using `uuidgen` | no |

### Both tomcat Install Type Inputs

Expand Down
Loading
Loading