Overview
Install Guide
Dashboard User Guide
Integration Guide
Contribute
Overview
Install Guide
Dashboard User Guide
Integration Guide
Contribute
  • Overview
  • Install Guide

    • Overview
    • Quick Start
    • Distributions
    • Development Installation
    • Production Installation
    • Configuration
    • Installation Modes
  • Dashboard User Guide

    • Overview
    • Projects
    • Subjects
    • Skills
    • Self Reporting
    • Skills Catalog
    • Skill Groups
    • Description Editor
    • Quizzes and Surveys
    • Admin Groups
    • Badges
    • Learning Path
    • Progress and Ranking
    • Icons
    • Levels
    • Users
    • Metrics
    • Inception
    • Contact Admins
    • Settings
  • Integration Guide

    • Overview
    • Client App Integration
    • Authentication
    • Programmatic Endpoints
    • Legacy Frameworks
  • Open Source Contributions

    • Contribution Guidelines
    • Architecture
    • Development Environment
  • Release Notes

    • Overview
    • Dashboard and API Release Notes
    • Client Libraries Release Notes

Overview

This section focuses on installing the SkillTree platform. Once the service is installed you will have access to the management dashboard and API.

Tips

Please note that this section is only applicable if you are installing the SkillTree platform from scratch. If your organization is already running a centralized service please proceed to the Integration User Guide or the Dashboard User Guide

There are two official distributions:

  • Jar-based: hosted on GitHub
  • Docker: hosted on DockerHub

Quick Start shows how to install and start each distribution type.

Once a distribution has been selected, the next consideration is to select an installation mode. The SkillTree platform supports two modes:

  • Password Auth Mode: Accounts created and managed by SkillTree and/or delegated to OAuth2 authentication provider (ex. GitHub, Google, etc..)
  • PKI Auth Mode: PKI Mode is for intranets where organizations utilize PKI with 2-way SSL certificates to implement authentication and authorization. User's browser must be setup with a personal PKI certificate and that certificate must be issued by a Certificate Authority trusted in the dashboard application's truststore.

Tips

Use Password Auth Mode if you are not sure which mode is applicable to you.

Please visit the Installation Modes section to learn more.

So what's next?

  • Quick Start: Become familiar with starting the service, the dashboard and what client-lib integration looks like.
  • Development Installation: Run the dashboard and the service on your test and/or development environments.
  • Production Installation: Detailed documentation for production-grade installations.
  • Configuration: SkillTree configuration and catalog of options.
Next
Quick Start