Skip to content

Commit 06a3bb1

Browse files
committed
Moves the config file doc to a more appropriate location
1 parent 8085217 commit 06a3bb1

2 files changed

Lines changed: 8 additions & 5 deletions

File tree

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,22 @@
11
.. _config_file:
22

33

4-
CLI Configuration File
5-
======================
6-
The CLI loads your settings from a number of different locations.
4+
Configuration File
5+
==================
6+
The SoftLayer API bindings load your settings from a number of different locations.
77

8+
* Input directly into SoftLayer.Client(...)
89
* Enviorment variables (SL_USERNAME, SL_API_KEY)
9-
* Config file (~/.softlayer)
10+
* Config file locations (~/.softlayer, /etc/softlayer.cfg)
1011
* Or argument (-C/path/to/config or --config=/path/to/config)
1112

1213
The configuration file is INI-based and requires the `softlayer` section to be present. The only required fields are `username` and `api_key`. You can optionally supply the `endpoint_url` as well. This file is created automatically by the `sl config setup` command detailed here: :ref:`config_setup`.
1314

14-
*Full config*
15+
*Config Example*
1516
::
1617

1718
[softlayer]
1819
username = username
1920
api_key = oyVmeipYQCNrjVS4rF9bHWV7D75S6pa1fghFl384v7mwRCbHTfuJ8qRORIqoVnha
2021
endpoint_url = https://api.softlayer.com/xmlrpc/v3/
22+
timeout = 40

docs/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ This is the documentation to SoftLayer's Python API Bindings. These bindings use
1717
:glob:
1818

1919
install
20+
config_file
2021
api/*
2122
cli
2223

0 commit comments

Comments
 (0)