From 25fd63590fb4882b5ae80a264deb1509642dbcea Mon Sep 17 00:00:00 2001
From: Baptiste Jonglez <git@bitsofnetworks.org>
Date: Sun, 6 Jun 2021 19:04:14 +0200
Subject: [PATCH] Move config files to .cfg.example

This makes sure that the actual configuration is not tracked in git,
simplifying deployment.
---
 .gitignore                         | 2 ++
 lg.cfg => lg.cfg.example           | 5 +++++
 lgproxy.cfg => lgproxy.cfg.example | 7 +++++--
 3 files changed, 12 insertions(+), 2 deletions(-)
 rename lg.cfg => lg.cfg.example (80%)
 rename lgproxy.cfg => lgproxy.cfg.example (77%)

diff --git a/.gitignore b/.gitignore
index 52e4e61..ce38835 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,4 @@
 *.pyc
 *.pyo
+lg.cfg
+lgproxy.cfg
diff --git a/lg.cfg b/lg.cfg.example
similarity index 80%
rename from lg.cfg
rename to lg.cfg.example
index 505cda2..78354eb 100644
--- a/lg.cfg
+++ b/lg.cfg.example
@@ -1,3 +1,6 @@
+# Configuration file example for lg.py
+# Adapt and copy to lg.cfg
+
 WEBSITE_TITLE="Bird-LG / Looking Glass"
 DEBUG = False
 LOG_FILE="/var/log/lg.log"
@@ -8,6 +11,7 @@ LOG_NUM_DAYS=0
 DOMAIN = "tetaneutral.net"
 
 # Used to optionally restrict access to lgproxy based on a shared secret.
+# Empty string or unset = no shared secret is used to run queries on lgproxies.
 SHARED_SECRET="ThisTokenIsNotSecret"
 
 BIND_IP = "0.0.0.0"
@@ -34,4 +38,5 @@ AS_NUMBER = {
 # DNS zone to query for ASN -> name mapping
 ASN_ZONE = "asn.cymru.com"
 
+# Used for secure session storage, change this
 SESSION_KEY = '\xd77\xf9\xfa\xc2\xb5\xcd\x85)`+H\x9d\xeeW\\%\xbe/\xbaT\x89\xe8\xa7'
diff --git a/lgproxy.cfg b/lgproxy.cfg.example
similarity index 77%
rename from lgproxy.cfg
rename to lgproxy.cfg.example
index 0daded1..e238d42 100644
--- a/lgproxy.cfg
+++ b/lgproxy.cfg.example
@@ -1,3 +1,5 @@
+# Configuration file example for lgproxy.py
+# Adapt and copy to lgproxy.cfg
 
 DEBUG=False
 
@@ -17,8 +19,9 @@ ACCESS_LIST = ["91.224.149.206", "178.33.111.110", "2a01:6600:8081:ce00::1"]
 # Empty string or unset = no shared secret is required to run queries.
 SHARED_SECRET="ThisTokenIsNotSecret"
 
-IPV4_SOURCE=""
-IPV6_SOURCE=""
+# Used as source address when running traceroute (optional)
+IPV4_SOURCE="198.51.100.42"
+IPV6_SOURCE="2001:db8:42::1"
 
 BIRD_SOCKET="/var/run/bird/bird.ctl"
 BIRD6_SOCKET="/var/run/bird/bird6.ctl"