...
Name | |||
|---|---|---|---|
name | Name of your app. Your app needs to be short. App drawers on mobile platforms abbreviate long names. Therefore keep it simple. Examples:
| ||
owner | Name of the app provider - usually your company. | ||
env | since 6.X Optional settings - Default Value is “prod” “dev“: enables additional ErrorMessages on the API | ||
description | Intro, which is shown on the dashboard. | ||
url | Public URL pointing to the app. Used in mails and other situations. | ||
dashboard | See Dashboard | ||
auth.publicAccess | If you activate this flag, no authentication is needed and your app is accessible for everyone without a login.
| ||
banner | This will show a banner on top of the app. The user can hide the banner permanently by clicking on the “x”. If the announcement is changed, it will be reactivated. Markdown formatting is accepted. | ||
termsAndConditions | This is your legal text, that each user that registers needs to accept. | ||
theme | See Theming | ||
sectionsCaption | First menu group name. e.g: “Sections”, “Documents”, … | ||
pageSize | Size of entries per page | ||
matomoUrl | Link to your matomo instance. | ||
matomoSiteId | Site Id in your matomo instance. | ||
matrixDiagram | If you are using the diagram view, you can define if the entries are aligned in a matrix - instead the entries inside the organigram will be aligned horizontally. | ||
csvDelimiter | The delimiter, used in the CSV exports, is by default “;”. You can overwrite it according to your needs. Some customers prefer a comma, since this is better accepted by Microsoft Excel. | ||
polling | Polling is by default turned off. By defining this value in seconds, you can activate a regular polling for new data. |
Treskon Self-Service App
TreskonMapbox
If you want to use the Map view or use https://portrait.atlassian.net/wiki/spaces/PA/pages/122224641/Field+Processors#Geo-Coding, you need to have a Mapbox account and a token that is accessible for your portrait site URL. (e.g. https://portrait.customer.xyz)
| Code Block |
|---|
mapbox:
token: 'pk.xxxxxxxxxxxxxxxxxxx'
url: 'https://api.mapbox.com/geocoding/v5/mapbox.places/' |
Users
When Portrait is initialized, a user is created for administration. This user is defined here:
...
These settings are internal, and usually you shouldn’t need to change them.
...
Custom Logging Configuration (Since 6.x)
Portait Portrait uses the Logback Library for Logging and comes with a default logging configuration.
...
The path of the logfile needs to be accessable accessible within the docker container. Therefore, it should be in the config folder, which is mapped as a volume inside the container.
...
| Code Block |
|---|
<configuration>
<property name="HOME_LOG" value="logs/portrait_backend.log"/>
<appender name="FILE-ROLLING" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${HOME_LOG}</file>
<rollingPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedRollingPolicy">
<fileNamePattern>logs/archived/portrait_backend.%d{yyyy-MM-dd}.%i.log.gz</fileNamePattern>
<!-- each archived file, size max 10MB -->
<maxFileSize>10MB</maxFileSize>
<!-- total size of all archive files, if total size > 20GB, it will delete old archived file -->
<totalSizeCap>20GB</totalSizeCap>
<!-- 60 days to keep -->
<maxHistory>60</maxHistory>
</rollingPolicy>
<encoder>
<pattern>%d [%thread] %-5level %logger{36}:%method - %msg%n</pattern>
</encoder>
</appender>
<appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
<layout class="ch.qos.logback.classic.PatternLayout">
<Pattern>
%d [%thread] %highlight(%-5level) %cyan(%logger{36}):%green(%method) - %msg%n
</Pattern>
</layout>
</appender>
<logger name="at.treskon" level="WARN" additivity="false">
<appender-ref ref="FILE-ROLLING"/>
<appender-ref ref="CONSOLE"/>
</logger>
<root level="error">
<appender-ref ref="FILE-ROLLING"/>
<appender-ref ref="CONSOLE"/>
</root>
</configuration> |
The Logfiles Log files should be written to logs/. Then the files will be mapped on the host via docker-compose.
...