j3d1/esp-open-rtos
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity

WiFi credentials

Browse source 
Changed local.h to include/ssid_config.h and added instructions on how
to keep your WiFi credentials safe from Github.
This commit is contained in:
Johan Kanflo 2015-07-28 23:56:47 +02:00
parent 1cb2de5b96
commit 0e521a74a9
5 changed files with 39 additions and 15 deletions
Download patch file Download diff file Expand all files Collapse all files

31
include/ssid_config.h Normal file
View file

@ -0,0 +1,31 @@
//
// Why this file?
//
// We all need to add our personal SSID/password to each ESP project but we
// do not want that information pushed to Github. This file solves that
// problem.
//
// First tell git to ignore changes to this file:
//
// git update-index --assume-unchanged include/ssid_config.h
//
// Then, enter your SSID and passphrase below and it will never be committed
// to Github.
//
// Change password on project basis? Copy the default version this file to your
// project directory, redo the instructions and you have separate wifi settings
// for that project.
//
// For reference, see
// https://www.kernel.org/pub/software/scm/git/docs/git-update-index.html
//
#warning "You need to enter your wifi credentials in this file and follow the instructions here to keep the password safe from Github commits."
#ifndef __SSID_CONFIG_H__
#define __SSID_CONFIG_H__
#define WIFI_SSID "mywifissid"
#define WIFI_PASS "my secret password"
#endif // __SSID_CONFIG_H__