Home - NatLibFi/Skosmos GitHub Wiki
Welcome to the Skosmos wiki!
Skosmos is a web-based tool providing services for accessing controlled vocabularies, which are used by indexers describing documents and searchers looking for suitable keywords. Vocabularies are accessed via SPARQL endpoints containing SKOS vocabularies.
Installing, configuring and using Skosmos
- InstallTutorial - the first guide you should read if you want to start using Skosmos
- FAQ and Troubleshooting - common questions and issues
- Upgrading - upgrading Skosmos to the newest version, including version-specific upgrade instructions
- Configuration - global configuration settings
- Vocabularies - vocabulary-specific settings
- TextAnalysisConfiguration - how to configure the jena-text index so you get the search results you want
- FusekiTuning - how to speed up Fuseki with JVM settings, timeouts and a Varnish HTTP proxy cache
- ReverseProxy - hints for running Skosmos behind a HTTP reverse proxy such as Varnish or nginx
- ServingLinkedData - how to set up Skosmos to serve vocabulary URI requests with content negotiation and RDF data
- Install Skosmos with Fuseki in Docker - using Skosmos within a Docker container
- Install Skosmos using a Vagrant VM - using Skosmos within a Vagrant virtual machine
Somewhat outdated documentation but possibly still useful
- Installation - old install guide, short but not very specific
- InstallFusekiJenaText - setting up Fuseki1; nowadays we recommend Fuseki2, see InstallTutorial
About the software
- Data Model - requirements for vocabulary data (SKOS + some spported extensions)
- REST API - documentation for the Skosmos REST API (superseded by Swagger specification)
- Embedded JSON LD - information about the JSON-LD data embedded in HTML pages by Skosmos 2.0+
- Backend architecture - overview of the Skosmos PHP codebase for developers
Development processes
- Roadmap
- Branches and Tags
- Release Process
- Contributing to the development of Skosmos
- Translation - how to translate Skosmos to your own language or fix existing translations
- Unit and integration tests - how to run the unit tests
- Cypress UI tests - how to run the Cypress end-to-end and accessibility tests
- Continuous Integration services