11 Application troubleshooting
What to do, if application is not working properly?
- Test yourself
- Check these steps
- Create issue
11.1 Issue tracking
Reporting issues for any part of Oskari: GitHub issues
1 Introduction
2 Application environment
- 2 Application environment
- 2.1 Framework
- 2.2 Frontend
- 2.2.1 Frontend architecture
- 2.2.2 Libraries and technologies
- 2.2.3 Source code and folder structure
- 2.3 Backend
- 2.3.1 Backend architecture
- 2.3.2 Libraries and technologies
- 2.3.3 Source code and folder structure
- 2.4 Directory structure for Oskari
- 2.4.1 Bundle implementation convention
3 Setup instructions
- 3 Setup instructions
- 3.1 Setup database
- 3.1.1 Database requirements:
- 3.1.2 Steps to create the database
- 3.2 Setup Jetty
- 3.3 Setup Oskari development environment
- 3.3.1 Requirements
- 3.3.2 Setup Git configuration
- 3.3.3 Fetch Oskari-server source code
- 3.3.4 Build Oskari server
- 3.3.5 Fetch sample-server-extension source code and compile it
- 3.3.6 Copy updated/relevant artifacts under `{jetty.base}/webapps`
- 3.4 Updating Oskari version
- 3.4.1 Migration and release notes
- 3.4.2 Updating the server
- 3.4.3 Updating the frontend
- 3.5 Advanced configuration
- 3.5.1 Advanced Jetty configuration
- 3.5.2 Setup Redis for Oskari (Optional)
- 3.5.3 Configuring nginx (Optional)
- 3.5.4 Server clustering (Optional)
4 Application core functionality
5 Frontend main functionalities
6 Other functionalities
- 6 Other functionalities
- 6.1 Authentication and user management (requires backend)
- 6.2 Create data using My Data (requires backend)
- 6.3 Import data (requires backend)
- 6.4 Embedded maps with Create map mode (requires backend)
- 6.5 GetFeatureInfo
- 6.6 Map Legends (Flyouts)
- 6.7 Print mode (requires backend)
- 6.8 Thematic Maps (requires backend)
- 6.9 WFS layers and attribute data table functionalities (requires backend)
- 6.10 Compatibility and support
- 6.10.1 Multilingual support
- 6.10.2 Browser support
- 6.10.3 Multi-screen support
- 6.10.4 Role-based user management
- 6.10.5 SSO authentication support
7 Operating instructions
- 7 Operating instructions
- 7.1 Usage instructions
- 7.1.1 How to use development tools
- 7.1.2 How to use localization
- 7.1.3 How to use Oskari filter
- 7.1.4 How to use Oskari style
- 7.1.5 How to use publisher tools
- 7.1.6 How to use a bundle
- 7.1.7 How to use a bundle manager/loader
- 7.1.8 How to use Oskari classes
- 7.1.9 How to use user authentication
- 7.2 Other instructions
- 7.2.1 How to contribute to Oskari project
- 7.3 Creating releases
- 7.3.1 Versioning the code
8 Developing instructions
- 8 Developing instructions
- 8.1 Development Guidelines
- 8.1.1 General
- 8.1.2 Code
- 8.1.3 Commits
- 8.1.4 Pull requests
- 8.1.5 Changing the API
- 8.1.6 Frontend
- 8.1.7 User interface
- 8.1.8 Documentation
- 8.1.9 Server
- 8.2 How to create a bundle
- 8.2.1 The Sample bundle
- 8.2.2 Editing the sample bundle
- 8.3 How to configure a bundle
- 8.4 How to add third party JavaScript libraries
- 8.5 How to create a custom Oskari Server Extension
- 8.5.1 Requirements
9 Configuration instructions
- 9 Configuration instructions
- 9.1 Customizing service logo
- 9.2 Custom favicon
- 9.3 Customizing index map icon
- 9.4 How to modify app setups
- 9.4.1 Frontend
- 9.4.2 Database
- 9.4.3 Role based functionalities
- 9.4.4 Oskari instance initial applications
- 9.4.5 Modifying applications after the initial database population
- 9.5 How to configure 3D map view
- 9.5.1 3D map view setup frontend
- 9.5.2 D map view setup backend
- 9.5.3 Adding your own 3D data
- 9.5.4 Configuring 3D-tiles map layers
- 9.5.5 Oskari 3D current state
- 9.5.6 Creating your own 3D datasets using Cesium Ion
- 9.6 How to configure a map projection
- 9.7 How to configure properties
- 9.7.1 Properties
- 9.7.2 Environment variables
- 9.8 How to configure the search
- 9.8.1 Configuring default search channels
- 9.8.2 Whitelisting enabled search channels
- 9.8.3 Things to improve (TODO)
- 9.9 Creating a custom location search channel
- 9.9.1 SearchChannel methods to override
- 9.9.2 More examples
- 9.10 ChannelProvider customizations
- 9.11 WFS search functionality deployment
- 9.11.1 Customized search user interface
- 9.12 How to configure map layers
- 9.13 Configuration options for vector feature layers
- 9.13.1 Data
- 10 ${value}
10 Enabling modules
- 10 Enabling modules
- 10.1 How to enable thematic maps
- 10.1.1 Requirements for thematic maps
- 10.1.2 Configuring thematic maps functionality
- 10.1.3 Known issues
- 10.2 How to enable WFS-T (Content editor)
- 10.2.1 Prerequisites
- 10.2.2 Front-end
- 10.2.3 Back-end
- 10.2.4 Installation
- 10.2.5 Configuration
- 10.2.6 Remarks
- 10.2.7 Known issues
11 Application troubleshooting
12 Changelog
- 12 Changelog
- 12.1 Frontend changelog
- 12.1.1 Removed `framework/featuredata2` bundle
- 12.1.2 Removed `framework/admin-layerrights` bundle
- 12.1.3 Removed `catalogue/metadatacatalogue` bundle
- 12.1.4 Removed `catalogue/metadataflyout` bundle
- 12.1.5 Removed `AddSearchResultActionRequest` request
- 12.1.6 Removed `MetaData.FinishedDrawingEvent` event
- 12.1.7 Removed `catalogue.AddTabRequest` request
- 12.1.8 Removed parallel version for `statsgrid` bundle
- 12.2 Frontend release notes
- 12.2.1 New base class for bundle instances
- 12.2.2 Publisher
- 12.2.3 Changes for bundle registrations
- 12.2.4 Styling changes
- 12.2.5 Cleaning up
- 12.3 Migration guide
- 12.3.1 Migrated from javax.servlet to jakarta-namespace
- 12.3.2 Spring configuration
- 12.3.3 User management
- 12.3.4 Junit migrated from 4 to 5
- 12.3.5 Generic proxy removed
- 12.3.6 Removed deprecated action routes
- 12.3.7 Language code for Indonesia changed in Java 17.
- 12.4 Server release notes
- 12.4.1 Spring update 5.x -> 6.x
- 12.4.2 Routing adapter changed
- 12.4.3 Dependency updates (see )
- 12.4.4 Removal of old code