aboutsummaryrefslogtreecommitdiffstats
path: root/config.py.sample
diff options
context:
space:
mode:
authorAsbjørn Sloth Tønnesen <ast@fiberby.net>2021-05-25 18:23:14 +0000
committerAsbjørn Sloth Tønnesen <ast@fiberby.net>2021-05-25 18:36:50 +0000
commit966b99a1a0eb13d2aa88d656116fc3d9e9acd874 (patch)
tree00cfa9c9dc1e0556cc3faae970e47f66de86c874 /config.py.sample
parent0ef91e74908fb8d9dfc813c276c9c2559708f3f9 (diff)
downloadpeeringdb-simplesync-966b99a1a0eb13d2aa88d656116fc3d9e9acd874.tar.gz
peeringdb-simplesync-966b99a1a0eb13d2aa88d656116fc3d9e9acd874.tar.xz
peeringdb-simplesync-966b99a1a0eb13d2aa88d656116fc3d9e9acd874.zip
document config keys
Signed-off-by: Asbjørn Sloth Tønnesen <ast@fiberby.net>
Diffstat (limited to 'config.py.sample')
-rw-r--r--config.py.sample13
1 files changed, 13 insertions, 0 deletions
diff --git a/config.py.sample b/config.py.sample
index d85e4ef..42bbac4 100644
--- a/config.py.sample
+++ b/config.py.sample
@@ -1,4 +1,17 @@
from requests.auth import HTTPBasicAuth
+#
+# Config keys
+# ===========
+#
+# db_conn_str: libpq database connection string
+# https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING
+#
+# db_schema: database schema name
+# If not specified, it defaults to 'peeringdb'
+#
+# auth: HTTPBasicAuth('username', 'password')
+# Authenticate using username/password
+#
def get_config():
return {