about summary refs log tree commit diff
path: root/genenetwork
diff options
context:
space:
mode:
authorPjotr Prins2024-04-05 11:14:39 +0200
committerPjotr Prins2024-04-05 11:14:39 +0200
commit070ee145c591795cc42146b4943fbc7d65132e34 (patch)
tree5b28082f93cc820420e05e934a9f5a98e1561ef7 /genenetwork
parent5f326f1d9930b7c144c417ace8ff36e37ca30d82 (diff)
downloadgn-machines-070ee145c591795cc42146b4943fbc7d65132e34.tar.gz
Document configuration settings
Diffstat (limited to 'genenetwork')
-rw-r--r--genenetwork/services/genenetwork.scm29
1 files changed, 15 insertions, 14 deletions
diff --git a/genenetwork/services/genenetwork.scm b/genenetwork/services/genenetwork.scm
index 4a1de05..62849da 100644
--- a/genenetwork/services/genenetwork.scm
+++ b/genenetwork/services/genenetwork.scm
@@ -1,6 +1,7 @@
 ;;; genenetwork-machines --- Guix configuration for genenetwork machines
 ;;; Copyright © 2024 Arun Isaac <arunisaac@systemreboot.net>
 ;;; Copyright © 2024 Frederick M. Muriithi <fredmanglis@gmail.com>
+;;; Copyright © 2024 Pjotr Prins <pjotr.public01@thebird.nl>
 ;;;
 ;;; This file is part of genenetwork-machines.
 ;;;
@@ -37,20 +38,20 @@
   #:export (genenetwork-service-type
             genenetwork-configuration
             genenetwork-configuration?
-            genenetwork-configuration-genenetwork2
-            genenetwork-configuration-genenetwork3
-            genenetwork-configuration-server-name
-            genenetwork-configuration-port
-            genenetwork-configuration-gn2-port
-            genenetwork-configuration-gn3-port
-            genenetwork-configuration-auth-db
-            genenetwork-configuration-xapian-db
-            genenetwork-configuration-genotype-files
+            genenetwork-configuration-genenetwork2   ; gn2 guix package used from guix-bioinformatics
+            genenetwork-configuration-genenetwork3   ; gn3 guix package used from guix-bioinformatics
+            genenetwork-configuration-server-name    ; outside DNS
+            genenetwork-configuration-port           ; external port
+            genenetwork-configuration-gn2-port       ; internal port
+            genenetwork-configuration-gn3-port       ; internal port
+            genenetwork-configuration-auth-db        ; RW auth DB
+            genenetwork-configuration-xapian-db      ; RO search index, unless you want to regenerate inside VM
+            genenetwork-configuration-genotype-files ; RO genotype files
+            genenetwork-configuration-gn3-data-directory ; RO
             genenetwork-configuration-sparql-endpoint
-            genenetwork-configuration-gn-sourcecode-directory
-            genenetwork-configuration-gn3-data-directory
-            genenetwork-configuration-gn2-secrets
-            genenetwork-configuration-gn3-secrets
+            genenetwork-configuration-gn-sourcecode-directory ; used for mounting local source code inside VM (dev/debug)
+            genenetwork-configuration-gn2-secrets ; RO GN2 secrets so we don't need to regenerate every startup
+            genenetwork-configuration-gn3-secrets ; RO GN3 secrets so we don't need to regenerate every startup
             gn-uploader-service-type
             gn-uploader-configuration
             gn-uploader-configuration?
@@ -161,7 +162,7 @@ their values. Keys must be strings. Values may be strings,
 G-expressions or numbers."
   #~(begin
       (use-modules (ice-9 match))
-      
+
       (call-with-output-file #$output
         (lambda (port)
           (for-each (match-lambda