From fb1ae371c51bdac696ad4bcc2626e3e5277ceae7 Mon Sep 17 00:00:00 2001
From: Mark Bumiller <mark.bumiller@gmail.com>
Date: Fri, 17 Jun 2022 15:09:09 -0400
Subject: [PATCH] preventing credential leaks

both ini files end up with secrets that should not be checked in
since they are user specifc, they should bnot be in version control
- moving example configs to have `.example` extension
- adding configs/*.ini to gitignore

fixes Jxck-S/plane-notify#60
---
 .gitignore                                     | 2 ++
 README.md                                      | 1 +
 configs/{mainconf.ini => mainconf.ini.example} | 0
 configs/{plane1.ini => plane1.ini.example}     | 0
 4 files changed, 3 insertions(+)
 rename configs/{mainconf.ini => mainconf.ini.example} (100%)
 rename configs/{plane1.ini => plane1.ini.example} (100%)

diff --git a/.gitignore b/.gitignore
index 456c050..fe2bcb0 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,3 +1,5 @@
+configs/*.ini
+
 # PyCharm
 .idea
 .vscode/settings.json
diff --git a/README.md b/README.md
index e3cb733..6ac25fa 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,7 @@ cd plane-notify
 
 ### Configure main config file with keys and URLs (mainconf.ini) in the configs directory
 
+-   Copy `mainconf.ini.example` to `mainconf.ini` andCopy `plane1.ini.example` to `plane1.ini`. `plane1.ini` can change names as long as it ends with the ini extension
 -   Edit them with nano or vi on the running machine or on your pc and transfer the config to where you will be running the bot
 -   Pick between OpenSky and ADS-B Exchange
 -   The OpenSky API is free for everyone but the data is not as good as ADS-B Exchange. The ADS-B Exchange API is not free and this program will not work for the Rapid API from ADS-B Exchange. It only works with the API that they give when you have a partnership with ADS-B Exchange. It is not cheap to get the ADS-B Exchange full API, Don't contact them unless you are ready to pay. 
diff --git a/configs/mainconf.ini b/configs/mainconf.ini.example
similarity index 100%
rename from configs/mainconf.ini
rename to configs/mainconf.ini.example
diff --git a/configs/plane1.ini b/configs/plane1.ini.example
similarity index 100%
rename from configs/plane1.ini
rename to configs/plane1.ini.example