Documentation
Oskari is an Open source distributed and extensible geoportal built with Java and Javascript. The goal is to help businesses and municipalities offer better online and mobile map services to their citizens and consumers. Take a look at the features it provides and the roadmap for things on their way. A sample application is provided as download and live demo. Read also development basics.
Issue tracking
Reporting issues for any part of Oskari: GitHub issues
Roadmap
Features that are planned on being added by the community:GitHub roadmap. Ones without additional "approved" label are still under consideration.
Contribute
The documentation below describes the internal workings of Oskari and helps you to extend it to your needs and make meaningful contributions for the community!
Sample app
The sample app can be used as a template for building your own Oskari-based geoportal. Select functionalities you want to include and add your own application specific customizations for your needs like initial map layers, users etc. The sample app uses Oskari as dependency on npm for frontend and Maven for server. This is the app you get from the download page.
- Sample frontend app built on top of oskari-frontend
- Sample server / Java webapp built on top of oskari-server
- Sample configurations for running the Oskari services
Source code for Oskari
- Oskari frontend Javascript-based code to use on your app
- Oskari server Maven-packaged Java code to use on your app
- RPC client library for controlling embedded maps
- Oskari frontend community modules additional frontend bundles for more functionality
- Code and content for this site
Running an Oskari instance
- Architecture
- Setup database
- Setup Jetty
- Setup Redis (Optional)
- Setup Geoserver (Optional)
- Setup development environment (Optional)
- Setup nginx (Optional)
- Server clustering (Optional)
- Updating Oskari version
Customizing Oskari
- Create a custom frontend application
- Create a custom Oskari-server extension
- Modifying app setups
- Customize logo
- Customize index map icon
- Configuring 3D map view
- Configuring a map projection
- Customize properties
- Customizing the search functionality
- Additional configuration for map layers
- Enabling thematic maps
- Customize demo users
- Enabling wfs-t (editing of wfs layer features)
- Enabling the my places module
- Enabling the analysis module
- Enabling the user data store
- User authentication
Using a hosted Oskari - RPC
One of the features of Oskari is the ability to embed a map to another website. RPC-functionality allows a developer to control the embedded map and react to events on the map from the embedding website. (Read more)
Frontend
The user interface is a Javascript-based single-page app built by selecting a series of modules that provide features for an application. The modules provide a documented API for interaction and/or easy replacement for a new implementation of a feature. You can mix and match the modules or create new ones to customize the application for your needs.
Server
The oskari-server is built with Java and Maven. It provides deployable webapps for managing and launching the user interface for Oskari-based apps. It also provides endpoints (action routes) for http-requests triggered by the frontend.