Skip to content

Commit 0d83961

Browse files
katarzyna-koltun-mxkatarzyna-koltun-mx
committed
fixes
1 parent 7c6fb5b commit 0d83961

2 files changed

Lines changed: 218 additions & 1 deletion

File tree

‎content/en/docs/deployment/general/pad/_index.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ You must also ensure that you have the supported version of [Java Runtime Enviro
3636

3737
## Creating a Portable App Distribution File
3838

39+
40+
3941
## Deploying Your App
4042

4143
After you create the Portable App Distribution file, deploy it to your environment.

‎content/en/docs/deployment/general/pad/pad-reference.md‎

Lines changed: 216 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,4 +68,219 @@ If a setting occurs multiple times across different files, the definition from t
6868
The following options are supported:
6969

7070
* `-h` or `--help` - Print the command line usage.
71-
* `-J $JvmOption` - Pass `$JvmOption` to the JVM.
71+
* `-J $JvmOption` - Pass `$JvmOption` to the JVM.
72+
73+
## Database Settings
74+
75+
The [database settings](/refguide/custom-settings/#database-settings) have the following parameters:
76+
77+
```text
78+
# Database configuration
79+
runtime.params {
80+
DatabaseType = Type of Database (*)
81+
DatabaseHost=host:port
82+
DatabaseName = MyMendixDB
83+
DatabaseUserName = mymendixusername
84+
DatabasePassword=mymendixusernamepassword
85+
}
86+
```
87+
88+
### Example Settings for PostgreSQL
89+
90+
```text
91+
# Database configuration
92+
runtime.params {
93+
DatabaseType = POSTGRESQL
94+
DatabaseHost = "localhost:5432"
95+
DatabaseName = MyMendixDB
96+
DatabaseUserName = mymendixusername
97+
DatabasePassword=mymendixusernamepassword
98+
}
99+
```
100+
101+
### Example Settings for AzureSQL
102+
103+
```text
104+
# Database configuration
105+
runtime.params {
106+
DatabaseType = SQLSERVER
107+
DatabaseHost = ""your-database-host.database.windows.net:1433""
108+
DatabaseName = MyMendixDB
109+
DatabaseUserName = mymendixusername
110+
DatabasePassword=mymendixusernamepassword
111+
}
112+
```
113+
114+
### Example Settings for JDBC
115+
116+
```text
117+
# Database configuration
118+
runtime.params {
119+
DatabaseType = MYSQL
120+
DatabaseJdbcUrl=mysql://db:3306/mendix
121+
DatabaseName = MyMendixDB
122+
DatabaseUserName = mymendixusername
123+
DatabasePassword=mymendixusernamepassword
124+
}
125+
```
126+
127+
## File Storage
128+
129+
The *example.conf* file in the Portable App Distribution .zip file contains example file storage settings for AWS S3 and Azure Blob Storage.
130+
131+
### AWS S3
132+
133+
```text
134+
runtime.params {
135+
# Acts as the username to authenticate with the S3 service.
136+
# Type: String
137+
# com.mendix.storage.s3.AccessKeyId = ""
138+
# Name of the bucket where the files are stored on S3.
139+
# Type: String
140+
# com.mendix.storage.s3.BucketName = ""
141+
# Overrides the default maximum connections limit in the S3 service.
142+
# The default value is enough for most applications, so we do not recommend explicitly setting this to a custom value unless a larger maximum connections limit is absolutely necessary.
143+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
144+
# com.mendix.storage.s3.ClientExecutionTimeout =
145+
# Sets the amount of time to wait (in milliseconds) when initially establishing a connection before giving up and timing out.
146+
# A value of 0 means infinity and is not recommended.
147+
# For more information, see the AWS Java SDK.
148+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
149+
# com.mendix.storage.s3.ConnectionTimeout =
150+
# List of keys which can be used to encrypt and decrypt data at rest in S3.
151+
# The right key to decrypt the data with is automatically selected depending on with which key it was encrypted.
152+
# Each encryption key consists of a key id, the encryption algorithm and the actual key (Base64 encoded).
153+
# Type: Array of objects
154+
# com.mendix.storage.s3.EncryptionKeys = []
155+
# Overrides the default endpoint.
156+
# This setting is required when the storage is on a non-AWS location (for example, IBM Cloud Object Storage).
157+
# Both the endpoint (for example, s3.example.com) or the full URL (including the protocol) are supported (for example, https://s3.example.com).
158+
# Note that when setting a custom endpoint, path style access will be enabled.
159+
# For more information, see Class S3ClientOptions.
160+
# Type: String
161+
# com.mendix.storage.s3.EndPoint = ""
162+
# The value true allows the server to route requests to a different region than specified in these settings (false disallows it).
163+
# Type: Boolean
164+
# com.mendix.storage.s3.ForceGlobalBucketAccessEnabled = true
165+
# Overrides the default maximum connections limit in the S3 service.
166+
# The default value is enough for most applications, so we do not recommend explicitly setting this to a custom value unless a larger maximum connections limit is absolutely necessary.
167+
# Type: Integer
168+
# com.mendix.storage.s3.MaxConnections =
169+
# Sets the region in which the S3 bucket is located.
170+
# This will be used to determine the service endpoint, unless overridden in com.mendix.storage.s3.EndPoint.
171+
# This setting will also be used as the signing region for requests.
172+
# Type: String
173+
# com.mendix.storage.s3.Region = ""
174+
# Sets the amount of time to wait (in milliseconds) for the request to complete before giving up and timing out.
175+
# A value of 0 means no timeout.
176+
# For more information, see the AWS Java SDK.
177+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
178+
# com.mendix.storage.s3.RequestTimeout =
179+
# Prefix for the keys under which objects are stored.
180+
# Separators are not added automatically to keys.
181+
# For keys like prefix/key1, com.mendix.storage.s3.ResourceNamePrefix should have value prefix/.
182+
# Type: String
183+
# com.mendix.storage.s3.ResourceNamePrefix = ""
184+
# Suffix for the keys under which objects are stored.
185+
# This can be used when S3 buckets are divided into different segments for different users with different credentials (for example, store objects as [key].customer1 for customer1 and as [key].customer2 for customer2).
186+
# Separators are not added automatically to keys.
187+
# For keys like key1.customer1, com.mendix.storage.s3.ResourceNameSuffix should have value .customer1.
188+
# Type: String
189+
# com.mendix.storage.s3.ResourceNameSuffix = ""
190+
# Acts as the password to authenticate with the S3 service.
191+
# Type: String
192+
# com.mendix.storage.s3.SecretAccessKey = ""
193+
# Sets the amount of time to wait (in milliseconds) for data to be transferred over an established, open connection before the connection times out and is closed.
194+
# A value of 0 means infinity and is not recommended.
195+
# For more information, see the AWS Java SDK.
196+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
197+
# com.mendix.storage.s3.SocketTimeout =
198+
# Set this value to true to use the configured CACertificates for the connection to the S3 service.
199+
# Type: Boolean
200+
# com.mendix.storage.s3.UseCACertificates = false
201+
# Lets the authentication policy use Signature Version 2 instead of the default Signature Version 4.
202+
# Set this setting to true when the endpoint does not support Signature Version 4.
203+
# Type: Boolean
204+
# com.mendix.storage.s3.UseV2Auth = false
205+
}
206+
```
207+
208+
### Azure Blob Storage
209+
210+
```text
211+
runtime.params {
212+
# Account key to authenticate with the Azure blob storage service.
213+
# Type: String
214+
# com.mendix.storage.azure.AccountKey = ""
215+
# Account name to authenticate with the Azure blob storage service.
216+
# Type: String
217+
# com.mendix.storage.azure.AccountName = ""
218+
# Set the blob endpoint.
219+
# This setting is required when authentication by SharedAccessSignature or UseDefaultAzureCredential is used.
220+
# Type: String
221+
# com.mendix.storage.azure.BlobEndpoint =
222+
# Name of the container containing the blob.
223+
# Type: String
224+
# com.mendix.storage.azure.Container = ""
225+
# Indicates whether to check if the container exists, and creates it if it does not exist.
226+
# Type: Boolean
227+
# com.mendix.storage.azure.CreateContainerIfNotExists = true
228+
# Maximum number of parallel multi-part file uploads/downloads.
229+
# We advise not changing this setting unless you experience slow file transfers for large files.
230+
# Choosing larger values will lead to higher memory usage.
231+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
232+
# com.mendix.storage.azure.MaximumExecutionTimeInMs =
233+
# Sets the maximum execution time (in milliseconds) to use when making this request.
234+
# For more information, see the Azure libraries.
235+
# Type: Int
236+
# com.mendix.storage.azure.ParallelismFactor = 5
237+
# Provides delegated access to resources in your storage account.
238+
# For more information, see Shared Access Signature on docs.microsoft.com.
239+
# Type: String
240+
# com.mendix.storage.azure.SharedAccessSignature =
241+
# Sets the amount of time (in milliseconds) to allow a call to the storage service to complete.
242+
# For more information, see the Azure libraries.
243+
# Type: Duration (use suffixes like s(econds), m(inutes) or h(ours); without suffix the value is taken as milliseconds)
244+
# com.mendix.storage.azure.TimeoutIntervalInMs =
245+
# Enables the use of the credential information present in the running environment.
246+
# For more information, see DefaultAzureCredential on Microsoft Learn.
247+
# Type: Boolean
248+
# com.mendix.storage.azure.UseDefaultAzureCredential = false
249+
# For enabling or disabling secure connections using HTTPS.
250+
# Can be true or false.
251+
# Type: Boolean
252+
# com.mendix.storage.azure.UseHttps = true
253+
}
254+
```
255+
256+
## Certificates
257+
258+
The *example.conf* file in the Portable App Distribution .zip file contains example runtime settings for certificates.
259+
260+
```text
261+
runtime.params {
262+
# A comma-separated list of paths to CA certificates.
263+
# Example: D:\App\CA1.pem, D:\App\CA2.pem, D:\App\CA3.pem, D:\App\CA4.pem
264+
# Type: String
265+
# CACertificates = ""
266+
# Comma-separated list of passwords for Client Certificates (should match the ClientCertificates order).
267+
# Example: pwd1, pwd2, pwd3, pwd4
268+
# Type: String
269+
# ClientCertificatePasswords = ""
270+
# Only use this when you have multiple client certificates and you want to configure specific certificates for specific servers.
271+
# This setting defines which service must use which client certificate.
272+
# See NoClientCertificateUsages if you want to make sure that no client certificate is used for a certain host or web service.
273+
# The value of ClientCertificateUsages must be a comma-separated list of key/value items.
274+
# A key/value item must be specified as "identifier": "path to certificate".
275+
# For web services, use the imported web service name as the identifier.
276+
# For REST services, use the host name of the remote server as the identifier.
277+
# Please note that any backslash in the path must be doubled.
278+
# The whole value must be enclosed by braces ({ }).
279+
# Type: Object
280+
# ClientCertificateUsages = {}
281+
# Comma-separated list of paths to Client Certificates.
282+
# Example: D:\App\Mx1.pfx, D:\App\Mx2.pfx, D:\App\Mx3.pfx, D:\App\Mx4.pfx
283+
# Type: String
284+
# ClientCertificates = ""
285+
}
286+
```

0 commit comments

Comments
 (0)