Recovery Source: Services

This repository provides a "standardized" solution to test, deploy, and maintain various web "services" provided by Recovery Source.

Repository Structure

Important directories:

• data: Source data for all services
• web_index: Directory listing of 12-Step groups
• nameserver: Configuration for DNS services
• forwarder: Configuration for "HTTP Redirector" service
• sync: Python module used to synchronize data
• test: Data used for automated testing

Web Index

Sober Pages service as a directory services for 12-step focused websites and aims to provide support for basic maintenance tasks.

See this website running at https://sober.page/.

Source Data

Everything the Recovery Source project knows about 12-Step groups.

Data Format

Location: data/domains/<group>.yaml

Format [YAML]:

<subdomain>:
  title: website title
  keywords: list, of, regions
  target: <URL>
  type: forward OR cname
  feed: <type>^<URL>[^<options>]

Required: subdomain, title, target

Rules:

• data/domains/*.yaml MUST be valid YAML
• [title, keywords] may be mixed-case, all other fields must be lower-case
• target should be the shortest functional URL (without path/query/fragment)
• target should include www if upstream redirects to this address
• feed may be a YAML list of feed locations (type+url)
• subdomain is limited to one (1) per target
• subdomain format should follow [type][area]-[district] (e.g. aa0-5)
• subdomain may append characters to resolve conflicts (e.g. aa1-4north)
• subdomain should use the lowest represented district as canonical
• subdomain can be used as a SP alias to redirect additional-represented districts
• feed/type must be one of [aamod, tsml]

Sync

Data synchronization is done using the sync python module:

$ cd services && python3 -m sync -h