OBYX requires a few environment variables to be set to work, here is a list of what they are and what they do.

SetEnv OBYX_ROOT_DIR          /WWW_ROOT

OBYX_ROOT_DIR should be set to the 'root path' of the web server, which contains a directory containing your obyx and web files.

SetEnv OBYX_PUBLIC_DIR        public

OBYX_PUBLIC_DIR should be set to the folder which your obyx files are visible from.

SetEnv OBYX_SCRIPTS_DIR       scripts

OBYX_SCRIPTS_DIR refers to the system path which will use as its working directory.

SetEnv OBYX_SQLSERVICE        mysql

OBYX_SQLSERVICE should be set to either mysql or postgresql, depending on the type of database you wish to use.

SetEnv OBYX_SQLDATABASE       YOUR-DATABASE-NAME

OBYX_SQLDATABASE is the name of the database you wish to use on your database server.

SetEnv OBYX_SQLHOST           YOUR-DATABASE-HOST

OBYX_SQLHOST is the hostname or IP address of your database server. If you're running a database on your local machine, this will be 'localhost'.

SetEnv OBYX_SQLPORT           YOUR-DATABASE-PORT

OBYX_SQLPORT refers to the port that your database is running on. By default in MySQL this is 3306, for PostgreSQL it is 5432.

SetEnv OBYX_SQLUSER           YOUR-DATABASE-USERNAME

OBYX_SQLUSER is your database username which has access to the database specified in OBYX_SQLDATABASE.

SetEnv OBYX_SQLUSERPW         YOUR-DATABASE-USERPASSWORD

OBYX_SQLUSERPW is the password for your user defined in OBYX_SQLUSER.

SetEnv OBYX_DEVELOPMENT       true

OBYX_DEVELOPMENT defines wether or not Obyx should allow breakpoints to be inserted in code, this should not be set on production environments.

If you're using Mac OS X or custom library paths, you need to set the following environment variables:

SetEnv OBYX_LIBCURLSO         /usr/local/lib/libcurl.dylib 

	SetEnv OBYX_LIBPCRESO         /usr/local/lib/libpcre.dylib 

	SetEnv OBYX_LIBZIPSO          /usr/lib/libz.dylib

These refer to the dynamic libraries (.so in other unices) for your libraries.

Finally, you will want to set one of these two variables (dependent on the type of database you wish to use).

For MySQL use:
SetEnv OBYX_LIBMYSQLCRSO      /usr/local/mysql/lib/libmysqlclient_r.dylib
or for PostgreSQL use:
SetEnv OBYX_LIBPQSO           /usr/local/pgsql/lib/libpq.dylib



Last Modified: Thu, 15 Jan 2015