Advanced Deploy
Pre-Requirements
NOTE: Verify here the functions that need to be enabled in your PHP for the good functioning from Scriptcase generated applications.
Verify below the requirements for the generated applications by Scriptcase. To guarantee that applications can run in Production Environment.
1 - Web Server to deployment (ex: Apache, IIS).
2 - Correct PHP Version for applications developed in Scriptcase.
Projects developed in Scriptcase with PHP 7.0 or 7.3 are approved to be published in the following versions of PHP:
- PHP 7.0
- PHP 7.1
- PHP 7.2
- PHP 7.3
- PHP 7.4
Projects developed in Scriptcase with PHP 8.1 are approved to be published in the following versions of PHP:
- PHP 7.0
- PHP 7.1
- PHP 7.2
- PHP 7.3
- PHP 7.4
- PHP 8.0
- PHP 8.1
3 - Access to the project database that is going to be used in the production environment.
Different from the typical deploy, where the directories’ setup is done from ScriptCase using the default settings, the advanced deployment allows you to choose the directories is according to the server’s architecture where it is going to be deployed.
Project Deployment
Access your project and choose the option “Project -> Deploy Project”, available on the top menu.
After clicking on the Deploy applications button, you will have the option to deploy all the applications from the project or you can select the applications that you want to deploy.
Select All Applications
When you select this option, all the applications of the project will be deployed.
Selecting the Deployment Template
Create a deployment template to save the defined settings. Or, you can use an existing template to reuse the established settings in your project.
| Template Name | This option is necessary to inform the deployment template name that will be used in the project. This option can be reused in future deployments. |
Setting the Advanced Deploy
We must define which application will be the project initial applçication. In this step we also define if we will send the FusionCharts Maps in the deployment file.
NOTE: It is necessary to select correctly the deployment server operating system, allowing the correct generation of the folders structures for deployment.
| Deploy with the common files | This option is obligatory for a project deployment, for the images, CSS and customized messages be send in the moment of deploy generation. |
| Publish with FusionChart Maps | Checking this option, the referred files to the FusionCharts library will be added in the deployment file. |
| Publishing server operating system | This option is obligatory for a project deployment, when you select the operating system, the Scriptcase will create the correct structure for your deployment. |
| Common Libraries Folder | It is necessary define the main directory where will be deployed the production environment. By default, the Scriptcase recommends to use: /scriptcase/prod. |
| Images Folder | It is necessary define the directory that will be stored the images in the production environment. By default, the Scriptcase recommends to use: /scriptcase/file/img. |
| Temp Folder | It is necessary define the directory that will be stored the temporary files in the production environment. By default, the Scriptcase recommends to use: /scriptcase/tmp. |
| Documents Folder | It is necessary define the directory that will be stored the documents in the production environment. By default, the Scriptcase recommends to use: /home/$user/public_html/scriptcase/file/doc. Is this option is necessary to inform the absolute path to the documents folder. |
| Choose the Initial Application | Defines the system initial application. |
Select the applications individually
This option allow us to select the applications that will be deployed.
List of available applications
During this process, the Scriptcase list all the Applications in the project so you can select the applications that you wish to deploy.
| Per type | Selecting this option, you can see the list of applications grouped by your respective type. |
| Per folder | Selecting this option, you can see the list of applications grouped by your respective folder. |
Choose the type of deploy
Next, we need to choose the type of desired deployment.
Create a deployment template to save the defined settings. Or, you can use an existing template to reuse the established settings in your project.
| Template Name | This option is necessary to inform the deployment template name that will be used in the project. This option can be reused in future deployments. |
Setting the Advanced Deploy
We must define which application will be the project initial applçication. In this step we also define if we will send the FusionCharts Maps in the deployment file.
NOTE: It is necessary to select correctly the deployment server operating system, allowing the correct generation of the folders structures for deployment.
| Deploy with the common files | This option is obligatory for a project deployment, for the images, CSS and customized messages be send in the moment of deploy generation. |
| Publish with FusionChart Maps | Checking this option, the referred files to the FusionCharts library will be added in the deployment file. |
| Publishing server operating system | This option is obligatory for a project deployment, when you select the operating system, the Scriptcase will create the correct structure for your deployment. |
| Common Libraries Folder | It is necessary define the main directory where will be deployed the production environment. By default, the Scriptcase recommends to use: /scriptcase/prod. |
| Images Folder | It is necessary define the directory that will be stored the images in the production environment. By default, the Scriptcase recommends to use: /scriptcase/file/img. |
| Temp Folder | It is necessary define the directory that will be stored the temporary files in the production environment. By default, the Scriptcase recommends to use: /scriptcase/tmp. |
| Documents Folder | It is necessary define the directory that will be stored the documents in the production environment. By default, the Scriptcase recommends to use: /home/$user/public_html/scriptcase/file/doc. Is this option is necessary to inform the absolute path to the documents folder. |
| Choose the Initial Application | Defines the system initial application. |
| Generate link to the Initial application | This resource prevents the creation of a redirect in the production environment and creates an access screen for the initial application defined in the previous attribute. This configuration should prevent the erroneous identification of the system as an insecure page performed by some browsers. |
| Select homepage language | Defines the language of the text that will be displayed on the home page, where the button for accessing the home application will be displayed. |
You will need to define the directories structure according to the structure of common libraries defines in your prodcution server. Below are shown two distinct examples of settings.
Example 1:
NOTE: It is necessary to create the directories in the production server, so that it can store the deployment’s Production environment (Common Libraries), remembering that the absolute path until the folder of the documents directory needs to be informed. On this example, we are using the production folder.
|
|
|
Example 2:
NOTE: On this example, it is necessary to create the image, documents and temporary directories, on your production server, remembering that the documents directory needs to be informed the absolute path. Relating to the Production Environment (Common Libraries), it is necessary to take the “prod” folder generated at the end of the deploy to the server. In this case, we are using different directories form the previous example.
|
|
|
On both examples above, if you wish that after concluding the deployment process will be available to download the production environment files(Common Libraries), please mark the option Deploy with the common files(CSS, buttons, images, messages).
| Common Libraries Folder | Library and service package used by the deployed applications. Inform the relative path to the prod directory. Ex: /production/prod or /prod. |
| Images Folder (used for uploading service) | Folder where will be stored all the images, when an application uses a field of the type “Image (File Name)”. Inform the relative path to the image directory: /production/file/img. |
| Temp Folder | Folder where will be stored the generated temporary files during applications’ runtime. The files of this directory will be removed periodically according to the specific settings, by default it is 120 minutes. Inform here the relative path to the tmp directory. Ex: /production/tmp or /temporay_files/tmp. |
| Documents Folder (used for uploading serviced) | Folder where all the documents will be stored when an application uses a field of the type “Image(File Name)”. Absolute Path (Full Path) to the doc directory. Ex: C:/Apache/htdocs/productions/file/doc or C:/Apache/htdocs/my_documents/doc. |
NOTE: The character
/, which means that is the root server. This character is most used to define relative paths.
Defining the production connection name
Define the connection name that will be used by the project after deploying.
| Connection names | In this option, we will inform the names of the connections existents in your project for deployment. |
Generated Files
Choose the the way method of deploy that is going to be used. ScriptCase offers 4 options:
Generate ZIP or Tar.Gz with applications
The Scriptcase will generate a file Zip or Tar.Gz.
In the end of this process, will be displayed a report of the deployed applications with the download link for download the project.
NOTE: The file ZIP or Tar.Gz generated, must be decompressed only in the deployment server, to avoid that the files be corrupted.
Deploy on a server directory
Deploys the project in the informed directory. This option should be used, in the case that the deploy is going to be in the same sever where ScriptCase is installed, otherwise this option is not valid.
NOTE: This option should be used in the case that the deploy is going to be in the same sever where ScriptCase is installed, otherwise this option is not valid.
Deploy on FTP server
This option generates the files directly in the FTP remote server.
| FTP server | Server where you will deploy your project. Inform the domain or the server’s IP. |
| User | User for the FTP server in the production, remembering that the user need to have permission to write in the server folder, otherwise it will not work. |
| Password | Password for the FTP user. |
| FTP Folder | Server directory where the project will be deployed in. |
NOTE: To use this option is necessary that you have a server that provides the FTP access and an user with write permissions.
Deploy on a SFTP server
Deploys the application automatically on a remote SFTP server.
| SFTP server | Server where you will deploy your project. Inform the domain or the server’s IP. |
| Port | Define the port to establish connection with SFTP server. |
| User | User for the SFTP server in the production, remembering that the user need to have permission to write in the server folder, otherwise it will not work. |
| Password | Password for the SFTP user. |
| SFTP Folder | Server directory where the project will be deployed in. |
| Compress files before sending | This option defines if the files will be compressed before being sent to the server or if they will be sent one by one. We recommend checking the option so that the files are compressed before sending, in this way the publication tends to be much faster, especially when publishing with a large number of files. |
NOTE: To use the SFTP option is necessary that the user have permission to write on the server folder.
Server Directories
At the end of the process you will receive a report with all the applications deployed and a download link of the project, also with the common libraries, that are the necessary routine to run the applications on the production environment, that is why they are required to upload with the deployment.
The advanced deploy requires that you download the “Production Environment”, that is the package that contains the common libraries.
NOTE: If you do not want to download the Production Environment (Common Libraries) from the link generated by the deploy, you can download it by Clicking Here. If you deploy the project again, you do not need to download the common libraries, but this information is not valid if the common libraries were updated in a new ScriptCase release.