Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
armon committed Apr 27, 2014
1 parent 19b8037 commit 84f0ec5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

`confd` is a lightweight configuration management tool focused on:

* keeping local configuration files up-to-date by polling [etcd](https://github.com/coreos/etcd) and processing [template resources](docs/template-resources.md).
* keeping local configuration files up-to-date by polling [etcd](https://github.com/coreos/etcd) or
[Consul](http://consul.io) and processing [template resources](docs/template-resources.md).
* reloading applications to pick up new config file changes

## Community
Expand All @@ -15,7 +16,7 @@

## Quick Start

Before we begin be sure to [download and install confd](docs/installation.md).
Before we begin be sure to [download and install confd](docs/installation.md).

### Add keys to etcd

Expand All @@ -26,6 +27,8 @@ etcdctl set /myapp/database/url db.example.com
etcdctl set /myapp/database/user rob
```

Alternatively, Consul can be used a Key/Value store.

### Create the confdir

The confdir is where template resource configs and source templates are stored. The default confdir is `/etc/confd`. Create the confdir by executing the following command:
Expand Down Expand Up @@ -74,7 +77,7 @@ confd supports two modes of operation, daemon and onetime mode. In daemon mode,
Assuming your etcd server is running at http://127.0.0.1:4001 you can run the following command to process the `~/confd/conf.d/myconfig.toml` template resource:

```
confd -verbose -onetime -node 'http://127.0.0.1:4001' -confdir ~/confd
confd -verbose -onetime -node 'http://127.0.0.1:4001' -confdir ~/confd
```
Output:
```
Expand All @@ -91,7 +94,7 @@ cat /tmp/myconfig.conf
```

Output:
```
```
# This a comment
[myconfig]
database_url = db.example.com
Expand Down
2 changes: 2 additions & 0 deletions docs/command-line-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ Usage of confd:
-client-key="": the client key
-confdir="/etc/confd": confd conf directory
-config-file="": the confd config file
-consul=false: specified to enable use of Consul
-consul-addr="": address of Consul HTTP interface
-debug=false: enable debug logging
-etcd-scheme="http": the etcd URI scheme. (http or https)
-interval=600: etcd polling interval
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Optional:
* `client_cert` (string) The cert file of the client.
* `client_key` (string) The key file of the client.
* `confdir` (string) - The path to confd configs. The default is /etc/confd.
* `consul` (bool) - Should Consul be used instead of etcd for Key/Value storage.
* `consul_addr` (string) - Address of consul. The default is "127.0.0.1:8500".
* `etcd_nodes` (array of strings) - An array of etcd cluster nodes. The default
is ["http://127.0.0.1:4001"].
* `etcd_scheme` (string) - The etcd scheme to use. Must be 'http' or 'https'
Expand Down

0 comments on commit 84f0ec5

Please sign in to comment.