add examples and update README

douban · Jul 25, 2019 · b27b2b0 · b27b2b0
1 parent ca4fd43
commit b27b2b0
Show file tree

Hide file tree

Showing 10 changed files with 43 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,22 +1,39 @@
 # SA Tools Core
 
+SA Tools 顾名思义是 System Administrator 的工具集，包含一些实用工具，涉及 DNS 管理、远程批量执行脚本、日志分析查询、通知提醒等。
 
 ## Development guide
 
 Currently support python2.7 ~ python3.7
 
-### quick start
+### Quick start
 
 ```
 make init
 ```
 
-### re-install after modify codes
+### Re-install after modify codes
 
 ```
 make install
 ```
 
+## Configuration
+
+```
+cp local_config.py.example local_config.py
+# then edit local_config.py
+vi local_config.py
+```
+
+You can use a system-wide configuration path as well, by default it is `/etc/sa-tools/`, it can be configured via `CONFIG_DIR`.
+
+Local configs will override [sa_tools_core/consts.py](sa_tools_core/consts.py).
+
+For other third party service configs, see [examples/config](examples/config).
+
+You can put third party service configs to `/etc/sa-tools/` directory.
+
 ## Command Line Tools
 
 For all the CLI tools, you can type `-h` or `--help` to get help messages and examples.

diff --git a/examples/config/dns_monitor_callback_key b/examples/config/dns_monitor_callback_key
@@ -0,0 +1 @@
+xxxxxxxxxxxxxxx
diff --git a/examples/config/dnspod b/examples/config/dnspod
@@ -0,0 +1 @@
+10001,xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx,*
diff --git a/examples/config/external_domains b/examples/config/external_domains
@@ -0,0 +1,16 @@
+[main]
+www
+book
+movie
+music
+
+[top_level_record]
+@
+
+[example2.com:top_level_record]
+@
+
+[example2.com:all]
+*.host1
+host2
+host3
diff --git a/examples/config/icinga b/examples/config/icinga
@@ -0,0 +1 @@
+user:password
diff --git a/examples/config/pushbullet b/examples/config/pushbullet
@@ -0,0 +1 @@
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
diff --git a/examples/config/pushover b/examples/config/pushover
@@ -0,0 +1 @@
+xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
diff --git a/examples/config/telegram b/examples/config/telegram
@@ -0,0 +1 @@
+111111111:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
diff --git a/examples/config/wechat b/examples/config/wechat
@@ -0,0 +1 @@
+wxaaaaaaaaaaaaaaaa:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:1
diff --git a/examples/config/wework b/examples/config/wework
@@ -0,0 +1 @@
+XXXXXXXXXXXXXXXXXX:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:1000001
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		wxaaaaaaaaaaaaaaaa:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx:1
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		XXXXXXXXXXXXXXXXXX:YYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYYY:1000001