Skip to content

Commit

Permalink
docs config update
Browse files Browse the repository at this point in the history
  • Loading branch information
@dpgaspar
dpgaspar committed Feb 9, 2015
1 parent d1b2dca commit c2b7b84
Show file tree
Hide file tree
Showing 7 changed files with 105 additions and 44 deletions.
Binary file modified docs/_build/doctrees/config.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
29 changes: 28 additions & 1 deletion docs/_build/html/_sources/config.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ Configuration keys

Use config.py to configure the following parameters. By default it will use SQLLITE DB, and bootstrap 3.1.1 base theme:

.. cssclass:: table-bordered table-hover

+-----------------------------------+--------------------------------------------+-----------+
| Key | Description | Mandatory |
+===================================+============================================+===========+
Expand All @@ -30,35 +32,48 @@ Use config.py to configure the following parameters. By default it will use SQLL
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_SERVER | define your ldap server when AUTH_TYPE=2 | Cond. |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_SEARCH | define your ldap server to do indirect | No |
| | bind by searching for the bind field. | |
| | Comment out or leave blank to do direct | |
| | bind to ldap server. | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_BIND_FIELD | if doing an indirect bind to ldap, this | No |
| | is the field to bind to. | |
| | Default is "cn". | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
| | | |
| | AUTH_LDAP_BIND_FIELD = "cn" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_UID_FIELD | if doing an indirect bind to ldap, this | No |
| | is the field that matches the username | |
| | when searching for the account to bind | |
| | to. | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
| | | |
| | AUTH_LDAP_UID_FIELD = "uid" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_FIRSTNAME_FIELD | sets the field in the ldap directory that | No |
Expand All @@ -67,9 +82,13 @@ Use config.py to configure the following parameters. By default it will use SQLL
| | into the User database. | |
| | Default is "givenName". | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
| | | |
| | AUTH_LDAP_FIRSTNAME_FIELD = "givenName" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_LASTNAME_FIELD | sets the field in the ldap directory that | No |
Expand All @@ -78,9 +97,13 @@ Use config.py to configure the following parameters. By default it will use SQLL
| | into the User database. | |
| | Default is "sn". | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
| | | |
| | AUTH_LDAP_LASTNAME_FIELD = "sn" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_LDAP_EMAIL_FIELD | sets the field in the ldap directory that | No |
Expand All @@ -89,9 +112,13 @@ Use config.py to configure the following parameters. By default it will use SQLL
| | address into the User database. | |
| | Default is "mail". | |
| | example: | |
| | | |
| | AUTH_TYPE = 2 | |
| | | |
| | AUTH_LDAP_SERVER = "ldap://ldapserver.new" | |
| | | |
| | AUTH_LDAP_SEARCH = "ou=people,dc=example" | |
| | | |
| | AUTH_LDAP_EMAIL_FIELD = "mail" | |
+-----------------------------------+--------------------------------------------+-----------+
| AUTH_ROLE_ADMIN | Configure the name of the admin role. | No |
Expand All @@ -116,7 +143,7 @@ Use config.py to configure the following parameters. By default it will use SQLL
| IMG_UPLOAD_URL | Image relative URL. | No |
| | Mandatory for image uploads. | |
+-----------------------------------+--------------------------------------------+-----------+
| IMG_SIZE | tuple to define image resize. | No |
| IMG_SIZE | tuple to define default image resize. | No |
| | (width, height, True|False). | |
+-----------------------------------+--------------------------------------------+-----------+
| BABEL_DEFAULT_LOCALE | Babel's default language. | No |
Expand Down
89 changes: 48 additions & 41 deletions docs/_build/html/config.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ <h1>Base Configuration<a class="headerlink" href="#base-configuration" title="Pe
<div class="section" id="configuration-keys">
<h2>Configuration keys<a class="headerlink" href="#configuration-keys" title="Permalink to this headline"></a></h2>
<p>Use config.py to configure the following parameters. By default it will use SQLLITE DB, and bootstrap 3.1.1 base theme:</p>
<table border="1" class="docutils">
<table border="1" class="table-bordered table-hover docutils">
<colgroup>
<col width="39%" />
<col width="49%" />
Expand Down Expand Up @@ -241,83 +241,90 @@ <h2>Configuration keys<a class="headerlink" href="#configuration-keys" title="Pe
<td>Cond.</td>
</tr>
<tr class="row-odd"><td>AUTH_LDAP_SERVER</td>
<td>define your ldap server when AUTH_TYPE=2
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</td>
<td><p class="first">define your ldap server when AUTH_TYPE=2
example:</p>
<p>AUTH_TYPE = 2</p>
<p class="last">AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
</td>
<td>Cond.</td>
</tr>
<tr class="row-even"><td>AUTH_LDAP_SEARCH</td>
<td>define your ldap server to do indirect
<td><p class="first">define your ldap server to do indirect
bind by searching for the bind field.
Comment out or leave blank to do direct
bind to ldap server.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p class="last">AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-odd"><td>AUTH_LDAP_BIND_FIELD</td>
<td>if doing an indirect bind to ldap, this
<td><p class="first">if doing an indirect bind to ldap, this
is the field to bind to.
Default is &#8220;cn&#8221;.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;
AUTH_LDAP_BIND_FIELD = &#8220;cn&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p>AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
<p class="last">AUTH_LDAP_BIND_FIELD = &#8220;cn&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-even"><td>AUTH_LDAP_UID_FIELD</td>
<td>if doing an indirect bind to ldap, this
<td><p class="first">if doing an indirect bind to ldap, this
is the field that matches the username
when searching for the account to bind
to.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;
AUTH_LDAP_UID_FIELD = &#8220;uid&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p>AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
<p class="last">AUTH_LDAP_UID_FIELD = &#8220;uid&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-odd"><td>AUTH_LDAP_FIRSTNAME_FIELD</td>
<td>sets the field in the ldap directory that
<td><p class="first">sets the field in the ldap directory that
stores the user&#8217;s first name. This field
is used to propagate user&#8217;s first name
into the User database.
Default is &#8220;givenName&#8221;.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;
AUTH_LDAP_FIRSTNAME_FIELD = &#8220;givenName&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p>AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
<p class="last">AUTH_LDAP_FIRSTNAME_FIELD = &#8220;givenName&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-even"><td>AUTH_LDAP_LASTNAME_FIELD</td>
<td>sets the field in the ldap directory that
<td><p class="first">sets the field in the ldap directory that
stores the user&#8217;s last name. This field
is used to propagate user&#8217;s last name
into the User database.
Default is &#8220;sn&#8221;.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;
AUTH_LDAP_LASTNAME_FIELD = &#8220;sn&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p>AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
<p class="last">AUTH_LDAP_LASTNAME_FIELD = &#8220;sn&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-odd"><td>AUTH_LDAP_EMAIL_FIELD</td>
<td>sets the field in the ldap directory that
<td><p class="first">sets the field in the ldap directory that
stores the user&#8217;s email address. This
field is used to propagate user&#8217;s email
address into the User database.
Default is &#8220;mail&#8221;.
example:
AUTH_TYPE = 2
AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8221;
AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;
AUTH_LDAP_EMAIL_FIELD = &#8220;mail&#8221;</td>
example:</p>
<p>AUTH_TYPE = 2</p>
<p>AUTH_LDAP_SERVER = &#8220;<a class="reference external" href="ldap://ldapserver.new">ldap://ldapserver.new</a>&#8220;</p>
<p>AUTH_LDAP_SEARCH = &#8220;ou=people,dc=example&#8221;</p>
<p class="last">AUTH_LDAP_EMAIL_FIELD = &#8220;mail&#8221;</p>
</td>
<td>No</td>
</tr>
<tr class="row-even"><td>AUTH_ROLE_ADMIN</td>
Expand Down Expand Up @@ -359,7 +366,7 @@ <h2>Configuration keys<a class="headerlink" href="#configuration-keys" title="Pe
<td>No</td>
</tr>
<tr class="row-even"><td>IMG_SIZE</td>
<td>tuple to define image resize.
<td>tuple to define default image resize.
(width, height, True|False).</td>
<td>No</td>
</tr>
Expand Down
Binary file modified docs/_build/html/objects.inv
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/searchindex.js
View file

Large diffs are not rendered by default.

0 comments on commit c2b7b84

Please sign in to comment.