move bot.conf.example to docs/

2 files changed, 91 insertions, 1 deletions

diff --git a/docs/bot.conf.example b/docs/bot.conf.example
new file mode 100644
index 00000000..8b9993fa
--- /dev/null
+++ b/docs/bot.conf.example
@@ -0,0 +1,90 @@
+# Any of these settings can be removed or left blank. The revelant functionality 
+# will be disabled.
+
+[bot]
+# client-side tls key/cert for IRC connections
+tls-key                  =
+tls-certificate          =
+
+# localhost port used for REST API
+api-port                 =
+
+# the default channel BitBot automatically joins
+bot-channel              =
+
+# module blacklist and whitelist. comma-separated. leave both empty to load all
+# modules, leave whitelist empty to load all but blacklisted modules, populate 
+# whitelist to not load all modules by default.
+module-blacklist         =
+module-whitelist         =
+
+# path to an external directory for modules to be found in
+external-modules         =
+
+# https://openweathermap.org/api
+openweathermap-api-key   =
+
+# https://products.wolframalpha.com/api/
+wolframalpha-api-key     =
+
+# https://developers.google.com/custom-search/v1/overview#prerequisites
+google-api-key           =
+google-search-id         =
+
+# https://words.bighugelabs.com/api.php
+bighugethesaurus-api-key =
+
+# https://developer.wordnik.com/
+wordnik-api-key          =
+
+# https://www.last.fm/api
+lastfm-api-key           =
+
+# https://trakt.docs.apiary.io/#
+trakt-api-key            =
+
+# https://developers.soundcloud.com/docs/api/guide
+soundcloud-api-key       =
+
+# https://developer.twitter.com/en/docs.html
+twitter-api-key          =
+twitter-api-secret       =
+twitter-access-token     =
+twitter-access-secret    =
+
+# https://api.tfl.gov.uk/
+tfl-api-id               =
+tfl-api-key              =
+
+# http://openldbsv.nationalrail.co.uk/
+nre-api-key              =
+
+# https://github.com/EvelynSubarrow/Eagle
+eagle-api-key            =
+eagle-api-url            =
+
+# https://docs.pushbullet.com/
+pushbullet-api-key       =
+pushbullet-channel-tag   =
+
+# http://www.omdbapi.com/
+omdbapi-api-key          =
+
+# https://www.virustotal.com/en/documentation/public-api/
+virustotal-api-key       =
+
+# https://apidocs.imgur.com/
+imgur-api-key            =
+
+# https://developer.spotify.com/dashboard/
+spotify-client-id        =
+spotify-client-secret    =
+
+# https://opencagedata.com/users/sign_up
+opencagedata-api-key     =
+
+# https://bitly.com/a/oauth_apps
+bitly-api-key            =
+
+# https://help.github.com/en/articles/creating-a-personal-access-token-for-the-command-line
+github-token             =
diff --git a/docs/help/setup.md b/docs/help/setup.md
index 3f8633aa..d9ce0e22 100644
--- a/docs/help/setup.md
+++ b/docs/help/setup.md
@@ -1,6 +1,6 @@
 ## Setting up BitBot
 
-* Move `bot.conf.example` to `~/.bitbot/bot.conf` and fill in the config options you care about. Ones blank or removed will disable relevant functionality.
+* Move `docs/bot.conf.example` to `~/.bitbot/bot.conf` and fill in the config options you care about. Ones blank or removed will disable relevant functionality.
 * Run `./bitbotd -a` to add a server.
 * Run `./bitbotd -m permissions -M master-password` to get the master admin password (needed to add regular admin accounts)
 * Run `./bitbotd` to start the bot.