Tobago Demo

Menu

Root Dummy Intro Search Getting Started Docker What's New Migration Compatibility FAQ API Download Server Info Logging Info In Suggest Textarea Date Range Group 5 Star Rating File Upload Out Label Badge Image Figure Progress Object Checkbox Toggle Dropdown Radio Listbox SelectOneList Multi Checkbox Multi Listbox Shuttle SelectManyList Button and Link Default Command Button Group Customizer Link Group Box Panel Separator Section Header and Footer Bar Popup Popover Toast Basic example Tab Client Tab Ajax Tab Server Basic example Sheet Sorting Paginator Sheet Column Selector Sheet Selectionchange Sheet Event Sheet Action Sheet Markup Sheet Style Empty Sheet Column Bar Sheet Filter Sheet Static Header Sheet Multi Header Sheet Tree Column Panel Sheet Editable Sheet Lazy Sheet Nested Basic example Tree Command Types Tree Select Tree Editor Tree Menu Tree Listbox Intro TinyMCE CKEditor Flow Layout Flex Layout Segment Layout Label Layout Grid Layout Split Layout Message-layout Overview Collapsible Box Collapsible Popup Collapsible Panel Collapsible Section Content Validation JSR 303 Severity Messages Content Security Policy Sanitize Roles Form AccessKey Focus Exception Handler Style Tag Bootstrap Theme Icons Partial Ajax Behavior WebSocket Transition Non Faces Request Conversion Error Handling For Each ConversationScoped Download Configuration Format Locale DataAttribute Meta
Root Dummy Intro Search Getting Started Docker What's New Migration Compatibility FAQ API Download Server Info Logging Info In Suggest Textarea Date Range Group 5 Star Rating File Upload Out Label Badge Image Figure Progress Object Checkbox Toggle Dropdown Radio Listbox SelectOneList Multi Checkbox Multi Listbox Shuttle SelectManyList Button and Link Default Command Button Group Customizer Link Group Box Panel Separator Section Header and Footer Bar Popup Popover Toast Basic example Tab Client Tab Ajax Tab Server Basic example Sheet Sorting Paginator Sheet Column Selector Sheet Selectionchange Sheet Event Sheet Action Sheet Markup Sheet Style Empty Sheet Column Bar Sheet Filter Sheet Static Header Sheet Multi Header Sheet Tree Column Panel Sheet Editable Sheet Lazy Sheet Nested Basic example Tree Command Types Tree Select Tree Editor Tree Menu Tree Listbox Intro TinyMCE CKEditor Flow Layout Flex Layout Segment Layout Label Layout Grid Layout Split Layout Message-layout Overview Collapsible Box Collapsible Popup Collapsible Panel Collapsible Section Content Validation JSR 303 Severity Messages Content Security Policy Sanitize Roles Form AccessKey Focus Exception Handler Style Tag Bootstrap Theme Icons Partial Ajax Behavior WebSocket Transition Non Faces Request Conversion Error Handling For Each ConversationScoped Download Configuration Format Locale DataAttribute Meta

Getting Started

This section describes how to build Tobago and run the example applications from the sources.

Checking Out

Check out the current development sources by running the following: $ git clone https://github.com/apache/myfaces-tobago tobago You can check out older versions like 2.x by using the git remote branch (tobago-2.x) running: $ git clone -b tobago-2.x https://github.com/apache/myfaces-tobago tobago-2.x

Building

You need Maven (at least version 3.0.4) and Java (version 8 or higher) to build Tobago.

Change to the local loaded source directory and call

$ mvn clean install

to run the install target on all sub projects. This will download all necessary artifacts into your local Maven repository.

Todo: Update this page and merge it with the 'Docker' page.

Examples

You can run the examples inside tobago-example with jetty $ mvn jetty:run -Pjetty or $ mvn package and deploy the WAR from the target directory manually.

Using different JSF implementations

By default the example will be started with MyFaces 2.3 and Jetty 9. $ mvn jetty:run -Pjetty For Jetty 10 use the profile jee8. $ mvn jetty:run -Pjetty -Pjee8 You can select a specific JSF implementation with the jsf variable, like Mojarra. $ mvn jetty:run -Djsf=mojarra-2.3
It's also possible to run the demo in TomEE from Maven directly $ mvn clean package tomee:run -Ptomee -Djsf=provided

Development

For development the example-demo could be run with maven profile "dev".

$ mvn -Pdev jetty:run -Pjetty

In this case the npm scripts "dev-css" and "dev-ts" could be run to compile css and typescript classes. These changes would be detected by jetty without restart.

© 2005-2025 Apache Software Foundation, Licensed under the Apache License, Version 2.0.