diff frontend/doc/config.rst @ 24:3a2876457625

małe zmiany w dokumentacji
author Michał Rudowicz <michal.rudowicz@fl9.eu>
date Mon, 09 May 2011 10:46:38 +0200
parents
children d017e2ab3027
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/frontend/doc/config.rst	Mon May 09 10:46:38 2011 +0200
@@ -0,0 +1,38 @@
+.. _config-ini:
+
+Plik konfiguracyjny
+===================
+
+Przykładowy plik konfiguracyjny
+-------------------------------
+.. code-block:: ini
+
+    [Basic]
+    # W przypadku sqlite, ścieżka do pliku bazy
+    Database = baza.sqlite
+    # Wygenerować losowy dla każdej instalacji bazy
+    Secret_Key = TakBardzoTajne
+    # Dla poważnej instalacji ustawić na 0
+    Debug = 1
+    # Algorytm wyliczający hashe dla haseł
+    HashCrypto = sha1
+    # Klucz API
+    ApiKey = apikey
+
+Opis pól w pliku konfiguracyjnym
+--------------------------------
+
+Database
+    Nazwa pliku zawierającego bazę danych.
+Secret_Key
+    Tajny plucz. Podczas automatycznego tworzenia pliku konfiguracyjnego
+    generowany jest losowy 10-znakowy klucz.
+Debug
+    Powoduje wyświetlanie informacji o debugowaniu w przypadku błędu
+    aplikacji. **UWAGA:** W przypadku poważnych instalacji należy ustawić na
+    0, ponieważ na stronie z informacjami o debugowaniu wyświetlana jest
+    również konsola debugowania, co jest bardzo niebezpieczne.
+HashCrypto
+    Algorytm hashowania haseł w bazie.
+ApiKey
+    Klucz API.