Quick Install - Apple macOS / OS X

Prerequisites

• Apple macOS / OS X as supported by FileMaker Inc., with Apache web server.
• Administrative level access to the operating system.
• A functioning FileMaker Server ( version 11 - 18 supported ) deployed with Web Publishing and PHP enabled.
  • Beginning with FileMaker Server 17, PHP must be enabled using the fmsadmin command line tool:
    fmsadmin set cwpconfig enablephp=true
    
    • Note: the response "Restart the FileMaker Server background processes to apply the change." It would appear this action is insufficient, and the system must now be rebooted to correctly enable PHP.
  • For FileMaker Server earlier than 17, The PHP Custom Web Publishing test available from the FileMaker Server page https://localhost:16000/fmi-test/phptest.php?lang=en must complete successfully.

Note on URL case sensitivity

Apple's HFS filesystem supports case-insensitive file access, but RESTfm is case sensitive. Please ensure the correct case is used in the URL, otherwise RESTfm will not function correctly and the report page will indicate errors.

Automated installation of RESTfm 4.x and above (FileMaker Server 13v5 and above, OS X Mavericks and above)

An install script is provided for quick and easy installation of RESTfm (versions 4.0.0 and above).

1. Using the OS X Finder, double-click to extract the RESTfm zip archive.
   • Note: Unzipping by other methods is not supported, and may result in failure to execute the install script.
2. Go to Folder (Command-Shift-G) /Library/FileMaker Server/HTTPServer/htdocs/
3. Drag-and-drop (or copy-and-paste) the RESTfm folder into the htdocs folder.
   • You may be prompted for an administrator name and password for this step.
   • Note : really important !!!  Copy the RESTfm folder, not the contents of the RESTfm folder.  Inside the RESTfm folder, is a file called .htaccess which has special settings for the apache web server.  Because it starts with a . it's invisible in the macOS finder app.  So it won't be copied and is critical to RESTfm working.
4. From the htdocs folder, double-click RESTfm/contrib/install-RESTfm.OSX/install-RESTfm.OSX.command
5. Browse to http://localhost/RESTfm

Multiple parallel installations of RESTfm are possible (handy for testing or maintaining different configurations).

1. Using the OS X Finder, double-click to extract the RESTfm zip archive.
   • Note: Unzipping by other methods is not supported, and may result in failure to execute the install script.
2. Rename the newly created RESTfm folder to something unique, e.g. RESTfm-test
3. Go to Folder (Command-Shift-G) /Library/FileMaker Server/HTTPServer/htdocs/
4. Drag-and-drop (or copy-and-paste) the RESTfm-test folder into the htdocs folder.
   • You may be prompted for an administrator name and password for this step.
5. From the htdocs folder, double-click RESTfm-test/contrib/install-RESTfm.OSX/install-RESTfm.OSX.command
   • Note: the install script must be executed from within the new RESTfm folder (e.g. RESTfm-test) that you wish to install.
6. Browse to http://localhost/RESTfm-test

An uninstall script is also provided and may be executed from within any RESTfm folder. It will automatically detect multiple RESTfm installations and offer a selection to uninstall.

1. Using the OS X Finder, Go to Folder (Command-Shift-G) /Library/FileMaker Server/HTTPServer/htdocs/RESTfm/contrib/install-RESTfm.OSX/
2. Double-click uninstall-RESTfm.OSX.command

Manual installation of RESTfm 3.x and earlier

1. Unzip RESTfm to the web server document root folder. This should create a sub-folder called RESTfm.
   • Beginning with FileMaker Server 13, the FMS deployment process takes over the webserver. The web server document root folder is now found in this location:
     /Library/FileMaker Server/HTTPServer/htdocs
2. Browse to the RESTfm report page: http://localhost/RESTfm/report.php
   • The report page will provide advice on configuration changes. If any errors are reported, start by correcting the topmost error first, and reloading the page after addressing each.

Uninstall method:

1. Edit /Library/FileMaker Server/HTTPServer/conf/httpd.conf, and comment out (use a # at the beginning of) the RESTfm Include line.
2. Rename or delete the /Library/FileMaker Server/HTTPServer/htdocs/RESTfm folder.
3. Reboot computer.

Browse RESTfm

Once the report page advises that RESTfm is operating, direct browsing of FileMaker databases may begin:
http://localhost/RESTfm

If the RESTfm report page indicates no errors but the http://localhost/RESTfm page continues to state that "RESTfm is not configured", then use <shift> and click the reload icon (before being redirected in 5 seconds) to force the browser to reload the page.