@@ -4,22 +4,17 @@ Recovery Source: Services
44This repository provides a "standardized" solution to test, deploy, and maintain
55various web "services" provided by [ Recovery Source] ( https://handbook.recoverysource.net/ ) .
66
7- Basic Workflows
8- ---------------
9-
10- To Do ...
11-
127Repository Structure
138--------------------
149
15- The structure of this repository :
10+ Important directories :
1611
17- - `` Makefile `` : Convenient helper tasks
18- - `` data/ `` : Primary source of data (all known 12-Step groups)
19- - `` sync/ `` : Python3 module that collects and re-mangles data
20- - `` web_index/ `` : Hugo-based website that hosts https://sober.page
21- - `` ansible/ `` : Used for configuration management (deploy, maintain, etc.)
22- - `` test/ `` : Data used for automated testing
12+ - ** data ** : Source data for all services
13+ - ** web_index ** : [ Directory listing of 12-Step groups] ( https://sober.page/ )
14+ - ** nameserver ** : Configuration for [ DNS ] ( https://handbook.recoverysource.net/essentials/websites.html#domain-name-system ) services
15+ - ** forwarder ** : Configuration for "HTTP Redirector" service
16+ - ** sync ** : Python module used to synchronize data
17+ - ** test** : Data used for automated testing
2318
2419Web Index
2520---------
@@ -69,23 +64,7 @@ of feed locations (type+url)
6964Sync
7065----
7166
72- Data synchronization is done using the `` sync `` python module.
73-
74- ** $ cd services && python3 -m sync -h** :
67+ Data synchronization is done using the `` sync `` python module:
7568```
76- usage: python3 -m sync [-h] [actions] <options>
77-
78- Synchronize sober.page data with various destinations
79-
80- options:
81- -h, --help show this help message and exit
82- -H <path> Path to source data (hugo format)
83- -w <path> Local workspace used for importing/caching data
84- -l <level> Log level (DEBUG, INFO*, WARNING, ERROR)
85-
86- actions[*]:
87- -m <path> Generate nginx map file at <path>
88- -z <zone>:<path> Generate bind9 zone (db) at <path>
89-
90- [*] At least one script action must be specified.
69+ $ cd services && python3 -m sync -h
9170```
0 commit comments