CruiseAppy Environment & Configuration Variables
This document lists and describes the key environment and configuration variables used by the CruiseAppy platform and its automation scripts. These variables are typically set in the environment, configuration files, or retrieved from the WordPress database.
Common Variables
| Variable Name | Description |
|---|---|
| DB_NAME | The name of the WordPress database. |
| DB_USER | The database user for WordPress. |
| DB_PASSWORD | The password for the database user. |
| DB_HOST | The database host (e.g., localhost). |
| TABLE_PREFIX | The prefix for WordPress tables (default: wp_). |
| WP_PATH / wordpress_path | The absolute path to the WordPress installation. |
| SITE_URL / ca_website_url | The main URL of the WordPress site. |
| FTP_HOST | FTP server hostname for TravelTek data import. |
| FTP_USER | FTP username for TravelTek data import. |
| FTP_PASSWORD | FTP password for TravelTek data import. |
| LOG_DIR | Directory for storing log files. |
| CSV_DIR | Directory for storing CSV files. |
| JSON_DIR | Directory for storing JSON files. |
| XML_DIR | Directory for storing XML files. |
| TRAVELTEK_DIR | Directory for TravelTek data. |
| VOLUME_DIR | Directory for persistent storage (e.g., Docker volume). |
| SCRIPT_PATH | The path to the current script. |
| HTACCESS_USER | Username for .htaccess/.htpasswd protection. |
| HTACCESS_PASSWORD | Password for .htaccess/.htpasswd protection. |
| WPML_ENABLED | Whether WPML (WordPress Multilingual Plugin) is enabled (1 = yes, 0 = no). |
| PAYMENT_GATEWAY | Payment gateway configuration (e.g., Stripe, PayPal). |
| CURRENCY | Default currency for bookings. |
| MARKET_ID | Market identifier for TravelTek integration. |
| SMART_PACKAGE | Enable/disable smart package feature. |
| AT_SEA_MODE | Enable/disable at sea mode. |
| CABIN_SELECTION | Enable/disable cabin selection feature. |
| BOOKING_ENDPOINT | API endpoint for booking requests. |
| SEARCH_ENDPOINT | API endpoint for cruise search. |
| STATUS | Application status (e.g., production, staging, development). |
| USERNAME | Application or API username. |
| LANGUAGE / ca_tt_language | Default language code (e.g., en, fr, de). |
| PACKAGES | List of enabled packages or package configuration. |
| ENDPOINTS | List of API endpoints for integration. |
| CA_TT_USERNAME | TravelTek API username. |
| CA_TT_PASSWORD | TravelTek API password. |
| CA_TT_SITENAME | TravelTek API site name. |
| CA_TT_SID | Session ID for TravelTek holiday searches. |
| CA_TT_FLIGHT_SID | Session ID for TravelTek flight searches. |
| CA_TT_HOTEL_SID | Session ID for TravelTek hotel searches. |
| CA_TT_FLIGHT_AND_HOTEL_SID | Session ID for TravelTek flight+hotel searches. |
| CA_PRICES_FALLBACK | Flag indicating whether to use fallback prices. |
| CA_CABIN_SELECT_HOLDING_IMAGE | ID of the holding image for cabins. |
| CA_CRUISELINE_* | Various credentials and settings for cruise lines. |
| CA_TT_MMB_ENDPOINT | Endpoint for the TravelTek MMB API. |
Note: Some variables are set in the WordPress database and retrieved by scripts at runtime. Others are set in environment files or as shell variables.
Usage
- These variables are used by CruiseAppy scripts (e.g., config.sh, control-import.sh) and the main application for configuration, data import, and integration tasks.
- Default values may be used if a variable is not set.
For more details on how these variables are used, see the documentation for each script in the Bash Automation Scripts section.