LogoLogo
  • Introduction
    • 👋Overview
    • 🤷Target Audience
    • ✨Features
  • Getting started
    • 🖥️System Requirements
    • 📦Installation
    • ⚙️Configuration
    • 🔧Setup Routine
  • Fundementals
    • 🎎Roles
    • 🌏Countries and time zones
    • ♻️Scheduletask concept
    • 💰Payment Service Provider
    • ✏️Administration
      • 🔵Sales
        • 👥Customers
        • 📥Invoices
        • 📋Plans
        • 🧊Modules
      • 🟢System
        • 🎛️System settings
        • ⛓️API Settings
        • 🌐Languages
        • 🪙Currencies
        • 🏳️Countries
        • 📂Mappings
        • 💬Translations
        • 🪧Widgets
    • 🖱️User guide
      • 🔐Customer rights
      • 🔗Customer Navigation
      • 📃Edit profile
      • 🔑Reset password
      • 🏨Edit company
      • ⚡Manage users
      • 👔Manage tenants
      • 📨View invoices
      • 💸Add payment method
      • 🪧Manage plans
      • 📦Manage modules
      • 🔔Notifications
  • Development
    • 🛠️Local development
    • 📂Folder structure
      • 🗄️Application.cfc
    • 💡Develop with saaster
      • 🎇General services
        • 💼Mappings and rigths management
        • ↩️Redirects
        • 👤Customer specific sessions
        • 〽️Global variable "getCustomerData"
      • 🌐Global functions
        • ⚙️getTrans()
        • ⚙️getAlert()
        • ⚙️logWrite()
        • ⚙️getTime()
      • 🧊Developing the main application
      • 📦Developing modules
  • API
    • ⚒️API: Get started
    • 📂Resources
      • 📄authenticate
      • 📄getCurrentModules
      • 📄getCurrentPlan
      • 📄getPlanFeatureSetting
Powered by GitBook
On this page
  • CFML Engine
  • Operating Systems
  • Database Engines
  • Web Server
  1. Getting started

System Requirements

Requirements to run saaster

PreviousFeaturesNextInstallation

Last updated 1 year ago

The following list contains all the requirements that your system hast to fulfill to run saaster. For local development we strongly recommend the usage of the docker configuration that is provided by saaster.

CFML Engine

Saaster requires the CFML engine 5.3.9+

Operating Systems

Your Lucee engine can be installed on Linux, Mac or Windows.

Database Engines

Saaster requires

Web Server

Saaster should run on all popular web servers. Saaster got tested with IIS and the . The chosen web server should support URL rewriting.

Example configuration:

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
    <system.webServer>
        <rewrite>
            <rules>
                 <rule name="API" stopProcessing="true">
                    <match url="^/api/(.*)$" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="api/index.cfm/{R:1}" appendQueryString="true" />
                </rule>	
	        <rule name="SEF" stopProcessing="true">
                    <match url="^(.*)$" />
                    <conditions logicalGrouping="MatchAll">
                        <add input="{REQUEST_FILENAME}" matchType="IsFile" ignoreCase="false" negate="true" />
                        <add input="{REQUEST_FILENAME}" matchType="IsDirectory" ignoreCase="false" negate="true" />
                    </conditions>
                    <action type="Rewrite" url="index.cfm/{R:1}" appendQueryString="true" />
                </rule>
            </rules>
        </rewrite>		
    </system.webServer>
</configuration>
<?xml version="1.0" encoding="utf-8"?>
<urlrewrite>
    <rule>
        <name>Rewrite API</name>
	<from>^/api/(.+)$</from>
        <condition type="request-filename" operator="notdir"/>
        <condition type="request-filename" operator="notfile"/>
        <to type="passthrough" qsappend="true" >/api/index.cfm/$1</to>
    </rule>

    <rule>
        <name>Rewrite Main</name>
	<from>^/(.+)$</from>
	<condition type="request-uri" operator="notequal">/lucee/admin/server.cfm</condition>
	<condition type="request-uri" operator="notequal">/lucee/admin/web.cfm</condition>
        <condition type="request-uri" operator="notequal">/api/</condition>
	<condition type="request-uri" operator="notequal">/(index.cfm|robots.txt|osd.xml|flex2gateway|cfide|cfformgateway|railo-context|lucee|admin-context|modules/contentbox-dsncreator|modules/contentbox-installer|modules/contentbox|files|images|js|javascripts|css|styles|config).*</condition>
        <condition type="request-uri" operator="notequal">\.(bmp|gif|jpe?g|png|css|js|txt|xls|ico|swf|woff|ttf|otf)$</condition>
        <condition type="request-filename" operator="notdir"/>
        <condition type="request-filename" operator="notfile"/>
        <to type="passthrough" qsappend="true" >/index.cfm/$1</to>
    </rule>
</urlrewrite>

🖥️
🛠️Local development
Lucee
MySQL 5.7
Tuckey servlet filter