{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The application.yml file contain settings which are needed for the basic configuration of Portrait.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Application","type":"text"}]},{"type":"paragraph","content":[{"text":"This defines the basic setup of Portrait. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Example:","type":"text"}]},{"type":"codeBlock","content":[{"text":"application:\n name: Portrait App\n owner: Treskon GmbH\n env: prod\n description: |\n Build a branded and secure portal with a modern tech-stack. Portrait will provide you with an online portal, branded with your logo for mobile, tablet and desktop. This can be integrated with your enterprise software in minutes, making your customer journey perfect.\n url: https://portrait.customer.xyz\n dashboard:\n showLatest: true\n showFavorites: true\n caption: Start\n auth:\n publicAccess: false\n banner: |\n Important announcement!\n termsAndConditions: |\n This is some legal text with _markdown_.\n theme:\n logoUrl: /icons/logo-full.svg\n heroUrl: /icons/logo-hero.svg\n rasterLogoUrl: /icons/logo-raster.png\n highlightColor: '#f890e7'\n backgroundColor: '#f0f0f0'\n alternateBackgroundColor: '#ffffff'\n textColor: '#3d3d3d'\n labelColor: '#0bd3d3'\n dividerColor: '#eaeaea'\n sectionsCaption: Sections \n pageSize: 20\n matomoUrl: https://matomo.customer.xyz\n matomoSiteId: 1\n matrixDiagram: true\n polling: 30","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Settings","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"86026929-aaac-4fbc-ad78-1f9833eb0994"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"name ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Name of your app.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Your app needs to be short. App drawers on mobile platforms abbreviate long names. Therefore keep it simple.","type":"text"}]},{"type":"paragraph","content":[{"text":"Examples:","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Treskon Self-Service App","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-cross_mark","text":":cross_mark:","shortName":":cross_mark:"}},{"text":" Treskon Team-App","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Treskon","type":"text"},{"type":"hardBreak"},{"type":"emoji","attrs":{"id":"atlassian-check_mark","text":":check_mark:","shortName":":check_mark:"}},{"text":" Team-App","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"owner ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Name of the app provider - usually your company.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"env ","type":"text"},{"text":"Enum","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"since 6.X","type":"text"}]},{"type":"paragraph","content":[{"text":"Optional settings - Default Value is “prod”","type":"text"},{"type":"hardBreak"},{"text":"Valid Values:","type":"text"}]},{"type":"paragraph","content":[{"text":"“dev“: enables additional ErrorMessages on the API","type":"text"},{"type":"hardBreak"},{"text":"”prod”: disables additional ErrorMessages on the API","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"description ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Intro, which is shown on the dashboard.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"url ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Public URL pointing to the app. Used in mails and other situations.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"dashboard ","type":"text"},{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://portrait.atlassian.net/wiki/spaces/PA7/pages/1029112591"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"auth.publicAccess ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"If you activate this flag, no authentication is needed and your app is accessible for everyone without a login.","type":"text"}]},{"type":"panel","attrs":{"panelType":"info"},"content":[{"type":"paragraph","content":[{"text":"This feature must be licensed.","type":"text"},{"type":"hardBreak"},{"text":"Check with your Portrait reseller.","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"banner ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]},{"type":"paragraph","content":[{"text":"Markdown formatting is accepted. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"termsAndConditions ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"This is your legal text, that each user that registers needs to accept. ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"theme ","type":"text"},{"text":"object","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://portrait.atlassian.net/wiki/spaces/PA7/pages/1029114316"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"sectionsCaption ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"First menu group name. e.g: “Sections”, “Documents”, …","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"pageSize ","type":"text"},{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Size of entries per page","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"matomoUrl ","type":"text"},{"text":"url","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Link to your matomo instance. ","type":"text"},{"type":"hardBreak"},{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://portrait.atlassian.net/wiki/spaces/PA7/pages/1029112460"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"matomoSiteId ","type":"text"},{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Site Id in your matomo instance. ","type":"text"},{"type":"hardBreak"},{"text":"See ","type":"text"},{"type":"inlineCard","attrs":{"url":"https://portrait.atlassian.net/wiki/spaces/PA7/pages/1029112460"}},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"matrixDiagram ","type":"text"},{"text":"bool","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"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.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"csvDelimiter ","type":"text"},{"text":"string","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"The delimiter, used in the CSV exports, is by default “;”. You can overwrite it according to your needs.","type":"text"}]},{"type":"panel","attrs":{"panelType":"note"},"content":[{"type":"paragraph","content":[{"text":"Some customers prefer a comma, since this is better accepted by Microsoft Excel. ","type":"text"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[318.0]},"content":[{"type":"paragraph","content":[{"text":"polling ","type":"text"},{"text":"int","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[442.0]},"content":[{"type":"paragraph","content":[{"text":"Polling is by default turned off. By defining this value in seconds, you can activate a regular polling for new data.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Users","type":"text"}]},{"type":"paragraph","content":[{"text":"When Portrait is initialized, a user is created for administration. This user is defined here:","type":"text"}]},{"type":"codeBlock","content":[{"text":"prepopulateUsers:\n enabled: false\n users:\n - email: admin@customer.com\n password: \"s3cur3d\"\n username: Administrator\n status: GRANTED\n role: ADMIN","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Settings","type":"text"}]},{"type":"table","attrs":{"layout":"default","width":760.0,"localId":"d2a6fcc5-2ec9-403f-a116-57a2750ad0f9"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"Name","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph"}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"enabled ","type":"text"},{"text":"boolean","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"We recommend keeping this feature set to ","type":"text"},{"text":"false","type":"text","marks":[{"type":"code"}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"If set to ","type":"text"},{"text":"true","type":"text","marks":[{"type":"code"}]},{"text":", each time you restart the server, the users will be recreated. This comes with a side effect, that all tokens are invalidated and you need to delete your auth-token manually.","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"users.email ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"E-Mail address for login","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"users.password ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"Preset password","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"users.username ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"Given username","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"users.status ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"GRANTED","type":"text","marks":[{"type":"code"}]},{"text":", ","type":"text"},{"text":"UNCHECKED","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"REVOKED","type":"text","marks":[{"type":"code"}]},{"text":" ","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[362.0]},"content":[{"type":"paragraph","content":[{"text":"users.role ","type":"text"},{"text":"String","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[398.0]},"content":[{"type":"paragraph","content":[{"text":"ADMIN","type":"text","marks":[{"type":"code"}]},{"text":" or ","type":"text"},{"text":"USER","type":"text","marks":[{"type":"code"}]}]}]}]}]},{"type":"paragraph","content":[{"text":"You could use this configuration also for mass creation of users. We use this feature for internal tests, but we doubt there is a use case for this in the real world.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Properties","type":"text"}]},{"type":"paragraph","content":[{"text":"These settings are internal, and usually you shouldn’t need to change them.","type":"text"}]},{"type":"paragraph","content":[{"text":"We document this example as a reference.","type":"text"}]},{"type":"codeBlock","content":[{"text":"####################################\n# Application properties #\n####################################\n\nendpoints:\n enabled: false\n sensitive: true\n jmx:\n enabled: false\n\njwt:\n header: Authorization\n secret: s3cur3d\n\nelasticsearch:\n host: index\n port: 9300\n clusterName: docker-cluster","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Custom Logging Configuration (Since 6.x)","type":"text"}]},{"type":"paragraph","content":[{"text":"Portrait uses the Logback Library for Logging and comes with a default logging configuration. ","type":"text"}]},{"type":"paragraph","content":[{"text":"This configuration can be overwritten with your own. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Configuration in application.yml:","type":"text"}]},{"type":"codeBlock","content":[{"text":"####################################\n# Application properties #\n####################################\n\nlogging:\n config: config/logback.xml","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" The path of the logfile needs to be accessible within the docker container. Therefore, it should be in the config folder, which is mapped as a volume inside the container. ","type":"text"}]},{"type":"paragraph","content":[{"text":"Example logback.xml","type":"text"}]},{"type":"codeBlock","content":[{"text":"\n\n \n\n \n ${HOME_LOG}\n\n \n logs/archived/portrait_backend.%d{yyyy-MM-dd}.%i.log.gz\n \n 10MB\n \n 20GB\n \n 60\n \n\n \n\n %d [%thread] %-5level %logger{36}:%method - %msg%n\n \n \n\n \n \n \n %d [%thread] %highlight(%-5level) %cyan(%logger{36}):%green(%method) - %msg%n\n \n \n \n\n \n \n \n \n\n \n \n \n \n\n","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" The Log files should be written to ","type":"text"},{"text":"logs/","type":"text","marks":[{"type":"code"}]},{"text":". Then the files will be mapped on the host via docker-compose.","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-info","text":":info:","shortName":":info:"}},{"text":" Further Information is available on the","type":"text"},{"text":" official logback documentation ","type":"text","marks":[{"type":"link","attrs":{"href":"https://logback.qos.ch/"}}]}]},{"type":"paragraph"}],"version":1}

Browser not supported