Skip to content

Service Identifiers Reference

This document provides a comprehensive reference for all service naming conventions, identifiers, and URLs across the SyRF platform.

Source Data: service-identifiers.yaml

Core Application Services

API

Identifier Value
Display Name API
Description Main REST API for systematic reviews
Type .NET 10.0
Monorepo Path src/services/api/
Chart Path src/services/api/.chart
Dockerfile src/services/api/SyRF.API.Endpoint/Dockerfile
.NET Project SyRF.API.Endpoint
Solution Filter src/services/api/api.slnf
Git Tag Prefix api-v
Current Version 9.2.1
Docker Image syrf-api
Image Repository ghcr.io/camaradesuk/syrf-api
Staging URL api.staging.syrf.org.uk
Production URL api.syrf.org.uk
Preview URL Pattern api.pr-{N}.syrf.org.uk

Project Management

Identifier Value
Display Name Project Management
Description Project and study management service
Type .NET 10.0
Monorepo Path src/services/project-management/
Chart Path src/services/project-management/.chart
Dockerfile src/services/project-management/SyRF.ProjectManagement.Endpoint/Dockerfile
.NET Project SyRF.ProjectManagement.Endpoint
Solution Filter src/services/project-management/project-management.slnf
Git Tag Prefix project-management-v
Current Version 11.3.1
Docker Image syrf-project-management
Image Repository ghcr.io/camaradesuk/syrf-project-management
Staging URL project-management.staging.syrf.org.uk
Production URL project-management.syrf.org.uk
Preview URL Pattern project-management.pr-{N}.syrf.org.uk

Rename Status: Complete ✅

This service was renamed from pm to project-management on 2025-11-18.

Old Names (deprecated):

  • Service ID: pm
  • Docker Image: syrf-pm
  • Git Tag Prefix: pm-v

New Names (current):

  • Service ID: project-management
  • Docker Image: syrf-project-management
  • Git Tag Prefix: project-management-v

All references now use the new naming convention as of tag project-management-v11.3.1.

Quartz

Identifier Value
Display Name Quartz
Description Background job scheduling and processing
Type .NET 10.0
Monorepo Path src/services/quartz/
Chart Path src/services/quartz/.chart
Dockerfile src/services/quartz/SyRF.Quartz/Dockerfile
.NET Project SyRF.Quartz
Solution Filter src/services/quartz/quartz.slnf
Git Tag Prefix quartz-v
Current Version 0.5.0
Docker Image syrf-quartz
Image Repository ghcr.io/camaradesuk/syrf-quartz
Staging URL quartz.staging.syrf.org.uk
Production URL quartz.syrf.org.uk
Preview URL Pattern quartz.pr-{N}.syrf.org.uk

Web

Identifier Value
Display Name Web
Description Angular frontend application
Type Angular 18.2.0
Monorepo Path src/services/web/
Chart Path src/services/web/.chart
Dockerfile src/services/web/Dockerfile.ci
Node Version 20
Git Tag Prefix web-v
Current Version 5.4.1
Docker Image syrf-web
Image Repository ghcr.io/camaradesuk/syrf-web
Staging URL staging.syrf.org.uk
Production URL prod.syrf.org.uk (temporary until legacy switchover, then syrf.org.uk)
Preview URL Pattern pr-{N}.syrf.org.uk

Documentation Services

User Guide

Identifier Value
Display Name User Guide
Description End-user documentation
Type Jekyll (just-the-docs theme)
Monorepo Path user-guide/
Chart Path user-guide/.chart
Dockerfile user-guide/Dockerfile
Git Tag Prefix user-guide-v
Current Version 1.1.0
Docker Image syrf-user-guide
Image Repository ghcr.io/camaradesuk/syrf-user-guide
Staging URL help.staging.syrf.org.uk
Production URL help.syrf.org.uk
Preview URL Pattern help.pr-{N}.syrf.org.uk

Team Docs

Identifier Value
Display Name Team Docs
Description Internal developer documentation
Type MkDocs (material theme)
Monorepo Path docs/
Chart Path docs/.chart
Dockerfile docs/Dockerfile.ci
Git Tag Prefix docs-v
Current Version 1.6.3
Docker Image syrf-docs
Image Repository ghcr.io/camaradesuk/syrf-docs
Staging URL docs.staging.syrf.org.uk
Production URL docs.syrf.org.uk
Preview URL Pattern docs.pr-{N}.syrf.org.uk

Lambda Service

S3 Notifier

Identifier Value
Display Name S3 Notifier
Description S3 event processing and RabbitMQ notification
Type AWS Lambda (.NET 10.0)
Monorepo Path src/services/s3-notifier/
.NET Project SyRF.S3FileSavedNotifier.Endpoint
Solution Filter src/services/s3-notifier/s3-notifier.slnf
Git Tag Prefix s3-notifier-v
Current Version 1.0.0
Lambda Function syrfAppUploadS3Notifier
AWS Region eu-west-1
Runtime dotnet10

Quick Reference Tables

Git Tags and Docker Images

Service Git Tag Format Docker Image
api api-v{version} ghcr.io/camaradesuk/syrf-api:{version}
project-management project-management-v{version} ghcr.io/camaradesuk/syrf-project-management:{version}
quartz quartz-v{version} ghcr.io/camaradesuk/syrf-quartz:{version}
web web-v{version} ghcr.io/camaradesuk/syrf-web:{version}
user-guide user-guide-v{version} ghcr.io/camaradesuk/syrf-user-guide:{version}
docs docs-v{version} ghcr.io/camaradesuk/syrf-docs:{version}
s3-notifier s3-notifier-v{version} N/A (Lambda)

URLs by Environment

Service Staging Production Preview Pattern
api api.staging.syrf.org.uk api.syrf.org.uk api.pr-{N}.syrf.org.uk
project-management project-management.staging.syrf.org.uk project-management.syrf.org.uk project-management.pr-{N}.syrf.org.uk
quartz quartz.staging.syrf.org.uk quartz.syrf.org.uk quartz.pr-{N}.syrf.org.uk
web staging.syrf.org.uk prod.syrf.org.uk* pr-{N}.syrf.org.uk
user-guide help.staging.syrf.org.uk help.syrf.org.uk help.pr-{N}.syrf.org.uk
docs docs.staging.syrf.org.uk docs.syrf.org.uk docs.pr-{N}.syrf.org.uk

* Web production URL is temporary (prod.syrf.org.uk) until legacy switchover, then becomes syrf.org.uk.

Infrastructure URLs

Service URL
ArgoCD argocd.camarades.net
RabbitMQ rabbitmq.syrf.org.uk

Kubernetes Namespaces

Environment Namespace
Staging syrf-staging
Production syrf-production

Naming Conventions

Docker Images

  • Format: syrf-{service-name}
  • Registry: ghcr.io/camaradesuk/
  • Example: ghcr.io/camaradesuk/syrf-api:9.2.1

Git Tags

  • Format: {service-name}-v{semver}
  • Examples: api-v9.2.1, web-v5.4.1

Helm Charts

  • Location: {service-path}/.chart
  • Chart.yaml version: 0.0.0 (stable)
  • App version: Comes from Docker image tag

cluster-gitops Paths

  • Service configs: syrf/services/{service-name}/
  • Environment configs: syrf/environments/{env}/{service-name}/
  • Files:
  • config.yaml - Service metadata, chartTag, imageTag
  • values.yaml - Helm value overrides