Difference between revisions of "Script variables"

From Amahi Wiki
Jump to: navigation, search
 
(6 intermediate revisions by one other user not shown)
Line 1: Line 1:
Environment variables needed in scripts:
+
Here are some environment variables that are available to be used in app install scripts:
  
* AMAHI_HDA_IP: HDA IP
+
* HDA_APP_DIR: Directory of the webapp
* AMAHI_APP_DIR: Directory of the webapp (basically, PWD)
+
* HDA_IP: the internal IP of the HDA
* AMAHI_APP_NAME: App name
+
* HDA_APP_NAME: App name
* AMAHI_GW_IP: IP of the router?
+
* HDA_DOMAIN: internal domain of this HDA
* AMAHI_NETMASK: Netmask?
+
* HDA_APP_USERNAME: admin username (if available, otherwise undefined)
* AMAHI_ADMIN_USERNAME: admin username
+
* HDA_APP_PASSWORD: admin password (if available, otherwise undefined)
* AMAHI_ADMIN_PASSWORD: admin password
+
* HDA_1ST_ADMIN: username of the 1st admin user
 +
 
 +
 
 +
Available in Amahi 7.2 and later:
 +
 
 +
These are only defined if the app has a database:
 +
* HDA_DB_DBNAME name of the database for the app
 +
* HDA_DB_USERNAME username of the database for the app
 +
* HDA_DB_PASSWORD password  of the database for the app
 +
* HDA_DB_HOSTNAME hostname of the machine where the database is hosted (typically localhost, but please use this variable anyway)
 +
 
 +
== Examples ==
 +
 
 +
* Suppose the app needs to initialize the DB for an app with an initial admin user and password. The script could use <code>echo "insert .... '$HDA_APP_USERNAME' ..." </code>
 +
* Same thing with the domain name for this HDA.
 +
* Suppose there is a need to create a directory for storing some file with a user name. The app install script could do <code>mkdir -p $HDA_1ST_ADMIN" </code>

Latest revision as of 04:00, 20 July 2014

Here are some environment variables that are available to be used in app install scripts:

  • HDA_APP_DIR: Directory of the webapp
  • HDA_IP: the internal IP of the HDA
  • HDA_APP_NAME: App name
  • HDA_DOMAIN: internal domain of this HDA
  • HDA_APP_USERNAME: admin username (if available, otherwise undefined)
  • HDA_APP_PASSWORD: admin password (if available, otherwise undefined)
  • HDA_1ST_ADMIN: username of the 1st admin user


Available in Amahi 7.2 and later:

These are only defined if the app has a database:

  • HDA_DB_DBNAME name of the database for the app
  • HDA_DB_USERNAME username of the database for the app
  • HDA_DB_PASSWORD password of the database for the app
  • HDA_DB_HOSTNAME hostname of the machine where the database is hosted (typically localhost, but please use this variable anyway)

Examples

  • Suppose the app needs to initialize the DB for an app with an initial admin user and password. The script could use echo "insert .... '$HDA_APP_USERNAME' ..."
  • Same thing with the domain name for this HDA.
  • Suppose there is a need to create a directory for storing some file with a user name. The app install script could do mkdir -p $HDA_1ST_ADMIN"