Snow Owl Docs
9.x
9.x
  • Introduction
  • Quick Start
    • Create your first Resource
    • Import SNOMED CT
    • Find concepts by ID or term
    • Find concepts using ECL
    • Next steps
  • Setup and Administration
    • Plan your deployment
      • Technology stack
      • Hardware requirements
      • Software requirements
    • Configuration
      • Release package
      • Folder structure
      • Get SSL certificate (optional)
      • Preload dataset (optional)
      • Configure Elastic Cloud (optional)
      • System settings
      • Spin up the service
    • Upgrade Snow Owl
    • Backup and restore
      • Backup
      • Restore
    • User management
    • Advanced installation methods
      • Install Snow Owl
        • Using an archive
        • Using RPM
        • Using DEB
      • System configuration
        • Disable swapping
        • File descriptors
        • Virtual memory
        • Number of threads
      • Configure Snow Owl
      • Start Snow Owl
      • Stop Snow Owl
    • Advanced configuration
      • Setting JVM options
      • Logging configuration
      • Elasticsearch configuration
      • Security
        • File realm
        • LDAP realm
  • Terminology Standards
    • SNOMED CT
      • Extensions and Snow Owl
      • Scenarios
        • Single Edition
        • Single Extension Authoring
        • Multi Extension Authoring
      • Development
      • Releases
      • Upgrading
    • LOINC
    • Socialstyrelsen Standards
      • ICD-10-SE
      • ICF
      • KVÃ… (KKÃ…/KMÃ…)
  • Content syndication
  • REST APIs
    • FHIR API
      • CodeSystem
      • ValueSet
      • ConceptMap
    • Native API
      • Resource management
      • Content access
      • Content management
      • SNOMED CT API
        • Branching
        • Compare
        • Concepts
        • Reference Sets
  • Release notes
Powered by GitBook
On this page
Export as PDF
  1. Setup and Administration
  2. Configuration

Spin up the service

Last updated 11 months ago

Full list of steps to perform before spinning up the service:

  1. Extract the Terminology Server release archive to a folder. E.g. /opt/snow-owl

  2. (Optional) Obtain an SSL certificate

    1. Make sure a DNS A record is routed to the host's public IP address

    2. Go into the folder ./snow-owl/docker/cert

    3. Execute the ./init-certificate.sh script:

    ./init-certificate.sh -d snow-owl.example.com

  3. (Optional) Configure access for managed Elasticsearch Cluster (elastic.co)

  4. (Optional) Extract dataset to ./snow-owl/resources where folder structure should look like ./snow-owl/resources/indexes/nodes/0 at the end.

  5. Verify file ownership to be UID=1000 and GID=0:

    chmod -R 1000:0 ./snow-owl/docker ./snow-owl/logs ./snow-owl/resources

  6. Check any credentials or settings that need to be changed in ./snow-owl/docker/.env

  7. Authenticate with our private docker registry while in the folder ./snow-owl/docker:

    cat docker_login.txt | docker login -u <username> --password-stdin https://docker.b2ihealthcare.com

  8. Issue a pull (in folder ./snow-owl/docker)

    docker compose pull

  9. Spin up the service (in the folder ./snow-owl/docker)

    docker compose up -d

  10. Verify that the REST API of the Terminology Server is available at:

    1. With SSL: https://snow-owl.example.com/snowowl

    2. Without SSL: http://hostname:8080/snowowl

  11. Verify that the server and cluster status is GREEN by querying the following REST API endpoint:

    1. With SSL:

      curl https://snow-owl.example.com/snowowl/info

    2. Without SSL:

      curl http://hostname:8080/snowowl/info

  12. Enjoy using the Snow Owl Terminology Server

🎉