mirror/0bin
1
0
Fork 0
mirror of https://github.com/Tygs/0bin.git synced 2023-08-10 21:13:00 +03:00
Code Issues Projects Releases Wiki Activity
a3dcbe9c2b
0bin/docs/.build/html/fr/options.html

291 lines
14 KiB
HTML
Raw Normal View History

Added documentation, removed some options
2012-05-18 16:29:52 +04:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Options &mdash; 0bin 0.1 documentation</title>
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="top" title="0bin 0.1 documentation" href="../index.html" />
<link rel="prev" title="Personnaliser l’apparence" href="theming.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="theming.html" title="Personnaliser l’apparence"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">0bin 0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="options">
<h1>Options<a class="headerlink" href="#options" title="Permalink to this headline"></a></h1>
<p>Le comportement de 0bin peut être ajusté à l&#8217;aide d&#8217;options passées depuis un
fichier de configuration ou directement à la ligne de commande. Certains
paramètres sont uniquement disponibles dans le fichier de configuration.</p>
<p>Si une option n&#8217;est pas passée, 0bin utilise la valeur par
défaut présente dans le fichier zerobin/default_settings.py.</p>
<div class="section" id="ligne-de-commande">
<h2>Ligne de commande<a class="headerlink" href="#ligne-de-commande" title="Permalink to this headline"></a></h2>
<div class="section" id="host-et-port">
<h3>&#8211;host et &#8211;port<a class="headerlink" href="#host-et-port" title="Permalink to this headline"></a></h3>
<p>L&#8217;hôte et le port sur lesquels écouter les requêtes entrantes. En général
127.0.0.1 et 8000 pour écouter localement, ou 0.0.0.0 et 80 pour
écouter les requêtes extérieures.</p>
<p>Défaut: 127.0.0.1 et 8000
Equivalent du fichier de configuration : HOST et PORT</p>
</div>
<div class="section" id="debug">
<h3>&#8211;debug<a class="headerlink" href="#debug" title="Permalink to this headline"></a></h3>
<p>Afffiche un listing d&#8217;informations utiles pour déboguer quand quelque chose
se passe mal à la place d&#8217;une page d&#8217;erreur 500.</p>
<p>En mode debug, le serveur recharge aussi automatiquement tout fichier Python
modifié.</p>
<p>Défaut: False
Equivalent du fichier de configuration : DEBUG</p>
</div>
<div class="section" id="user-et-group">
<h3>&#8211;user et &#8211;group<a class="headerlink" href="#user-et-group" title="Permalink to this headline"></a></h3>
<p>L&#8217;utilisateur et le group que le serveur essayera d&#8217;adopter après le démarrage.</p>
<p>Utile quand on lance la commande avec les droits admin afin de pouvoir
écouter sur le port 80, mais qu&#8217;on souhaite, pour des raisons de sécurité, que
le processus n&#8217;est pas accès aux fichiers protégés du système.</p>
<p>&#8211;group prend de &#8211;user si il n&#8217;est pas précisé.</p>
<p>Défaut: Aucun
Equivalent du fichier de configuration : USER et GROUP</p>
</div>
<div class="section" id="settings-file">
<h3>&#8211;settings-file<a class="headerlink" href="#settings-file" title="Permalink to this headline"></a></h3>
<p>Chemin vers le fichier de configuration, si vous souhaitez en utiliser un.</p>
<p>Défaut: Aucun
Equivalent du fichier de configuration : Aucun</p>
</div>
<div class="section" id="compressed-static">
<h3>&#8211;compressed-static<a class="headerlink" href="#compressed-static" title="Permalink to this headline"></a></h3>
<p>Sert les versions minifiées fichiers statiques (css et js). A utiliser en
production pour un site plus rapide.</p>
<p>Défaut: False
Equivalent du fichier de configuration : COMPRESSED_STATIC_FILES</p>
</div>
<div class="section" id="version-et-help">
<h3>&#8211;version et &#8211;help<a class="headerlink" href="#version-et-help" title="Permalink to this headline"></a></h3>
<p>Affiche l&#8217;aide ou la version de 0bin</p>
<p>Défaut: Aucun
Equivalent du fichier de configuration : Aucun</p>
</div>
<div class="section" id="exemples">
<h3>Exemples<a class="headerlink" href="#exemples" title="Permalink to this headline"></a></h3>
<p>Production:</p>
<div class="highlight-python"><pre>sudo zerobin --host 0.0.0.0 --port 80 --user foo --compressed-static</pre>
</div>
<p>Développement:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">zerobin</span> <span class="o">--</span><span class="n">debug</span> <span class="o">--</span><span class="n">serve</span><span class="o">-</span><span class="n">static</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fichier-de-configuration">
<h2>Fichier de configuration<a class="headerlink" href="#fichier-de-configuration" title="Permalink to this headline"></a></h2>
<p>Le fichier configuration doit être un fichier Python ordinnaire, généralement
appelé settings.py. On l&#8217;utilise ainsi:</p>
<div class="highlight-python"><pre>zerobin --settings-file '/chemin/vers/settings.py'</pre>
</div>
<p>Toutes les autres options passées à la commandes auront priorité sur les options
du fichier de configuration. Le fichier zerobin/default_settings.py peut servir
d&#8217;exemple pour créer son propre fichier de configuration, il est largement commenté.</p>
<div class="section" id="id1">
<h3>DEBUG<a class="headerlink" href="#id1" title="Permalink to this headline"></a></h3>
<p>Afffiche un listing d&#8217;informations utiles pour déboguer quand quelque chose
se passe mal à la place d&#8217;une page d&#8217;erreur 500.</p>
<p>En mode debug, le serveur recharge aussi automatiquement tout fichier Python
modifié.</p>
<p>Défaut: False
Equivalent en ligne de commande : &#8211;debug</p>
</div>
<div class="section" id="static-files-root">
<h3>STATIC_FILES_ROOT<a class="headerlink" href="#static-files-root" title="Permalink to this headline"></a></h3>
<p>Chemin absolu du dossier dans lequel 0bin va chercher les fichiers statiques
(css, js et images).</p>
<p>Défaut: dossier &#8220;static&#8221; dans le dossier &#8220;zerobin&#8221;
Equivalent en ligne de commande : Aucun</p>
</div>
<div class="section" id="compressed-static-files">
<h3>COMPRESSED_STATIC_FILES<a class="headerlink" href="#compressed-static-files" title="Permalink to this headline"></a></h3>
<p>Sert les versions minifiées fichiers statiques (css et js). A utiliser en
production pour un site plus rapide.</p>
<p>Défaut: False
Equivalent en ligne de commande : &#8211;compressed-static</p>
</div>
<div class="section" id="paste-files-root">
<h3>PASTE_FILES_ROOT<a class="headerlink" href="#paste-files-root" title="Permalink to this headline"></a></h3>
<p>Chemin absolu du dossier dans lequel 0bin va sauvegarder les pastes.</p>
<p>Défaut: dossier &#8220;static/content&#8221; dans le dossier &#8220;zerobin&#8221;
Equivalent en ligne de commande : Aucun</p>
</div>
<div class="section" id="template-dirs">
<h3>TEMPLATE_DIRS<a class="headerlink" href="#template-dirs" title="Permalink to this headline"></a></h3>
<p>Liste des chemins absolus des dossiers qui contiennent les templates que 0bin
utilise pour générer les pages du site. Les premiers éléments de la liste
ont priorités sur les suivant.</p>
<p>Si vous voulez utiliser vos propres templates, ajoutez le dossier qui les
contient au début de la liste:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="kn">from</span> <span class="nn">zerobin.defauls_settings</span> <span class="kn">import</span> <span class="n">TEMPLATE_DIRS</span>
<span class="n">TEMPLATE_DIRS</span> <span class="o">=</span> <span class="p">(</span>
<span class="s">&#39;/chemin/version/votre/dossier/de/templates&#39;</span><span class="p">,</span>
<span class="p">)</span> <span class="o">+</span> <span class="n">TEMPLATE_DIRS</span>
</pre></div>
</div>
<p>Défaut: dossier &#8220;view&#8221; dans le dossier &#8220;zerobin&#8221;
Equivalent en ligne de commande : Aucun</p>
</div>
<div class="section" id="id2">
<h3>HOST et PORT<a class="headerlink" href="#id2" title="Permalink to this headline"></a></h3>
<p>L&#8217;hôte et le port sur lesquels écouter les requêtes entrantes. En général
127.0.0.1 et 8000 pour écouter localement, ou 0.0.0.0 et 80 pour
écouter les requêtes extérieures.</p>
<p>Défaut: 127.0.0.1 et 8000
Equivalent du fichier de configuration : &#8211;host et &#8211;port</p>
</div>
<div class="section" id="id3">
<h3>USER et GROUP<a class="headerlink" href="#id3" title="Permalink to this headline"></a></h3>
<p>L&#8217;utilisateur et le group que le serveur essayera d&#8217;adopter après le démarrage.</p>
<p>Utile quand on lance la commande avec les droits admin afin de pouvoir
écouter sur le port 80, mais qu&#8217;on souhaite, pour des raisons de sécurité, que
le processus n&#8217;est pas accès au fichiers système.</p>
<p>GROUP prend de USER si il n&#8217;est pas précisé.</p>
<p>Défaut: Aucun
Equivalent du fichier de configuration : &#8211;user et &#8211;group</p>
</div>
<div class="section" id="menu">
<h3>MENU<a class="headerlink" href="#menu" title="Permalink to this headline"></a></h3>
<p>Une liste de paires &#8216;Nom&#8217; + &#8216;Liens&#8217; à utiliser pour construire le menu qui
est en haut de chaque page.</p>
<p>Le lien peut être un lien relatif, absolu, ou une adresse email.</p>
<p>Toute addresse email sera automatiquement protégée contre le spam.</p>
<p>Défaut:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="n">MENU</span> <span class="o">=</span> <span class="p">(</span>
<span class="p">(</span><span class="s">&#39;Home&#39;</span><span class="p">,</span> <span class="s">&#39;/&#39;</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;Download 0bin&#39;</span><span class="p">,</span> <span class="s">&#39;https://github.com/sametmax/0bin&#39;</span><span class="p">),</span>
<span class="p">(</span><span class="s">&#39;Contact&#39;</span><span class="p">,</span> <span class="s">&#39;mailto:your@email.com&#39;</span><span class="p">)</span> <span class="c"># email</span>
<span class="p">)</span>
</pre></div>
</div>
<p>Equivalent en ligne de commande : Aucun</p>
</div>
<div class="section" id="max-size">
<h3>MAX_SIZE<a class="headerlink" href="#max-size" title="Permalink to this headline"></a></h3>
<p>Valeur approximative de limite de taille d&#8217;un paste.</p>
<p>Défaut = 500000 octets (500 ko)
Equivalent en ligne de commande : Aucun</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="../index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Options</a><ul>
<li><a class="reference internal" href="#ligne-de-commande">Ligne de commande</a><ul>
<li><a class="reference internal" href="#host-et-port">&#8211;host et &#8211;port</a></li>
<li><a class="reference internal" href="#debug">&#8211;debug</a></li>
<li><a class="reference internal" href="#user-et-group">&#8211;user et &#8211;group</a></li>
<li><a class="reference internal" href="#settings-file">&#8211;settings-file</a></li>
<li><a class="reference internal" href="#compressed-static">&#8211;compressed-static</a></li>
<li><a class="reference internal" href="#version-et-help">&#8211;version et &#8211;help</a></li>
<li><a class="reference internal" href="#exemples">Exemples</a></li>
</ul>
</li>
<li><a class="reference internal" href="#fichier-de-configuration">Fichier de configuration</a><ul>
<li><a class="reference internal" href="#id1">DEBUG</a></li>
<li><a class="reference internal" href="#static-files-root">STATIC_FILES_ROOT</a></li>
<li><a class="reference internal" href="#compressed-static-files">COMPRESSED_STATIC_FILES</a></li>
<li><a class="reference internal" href="#paste-files-root">PASTE_FILES_ROOT</a></li>
<li><a class="reference internal" href="#template-dirs">TEMPLATE_DIRS</a></li>
<li><a class="reference internal" href="#id2">HOST et PORT</a></li>
<li><a class="reference internal" href="#id3">USER et GROUP</a></li>
<li><a class="reference internal" href="#menu">MENU</a></li>
<li><a class="reference internal" href="#max-size">MAX_SIZE</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="theming.html"
title="previous chapter">Personnaliser l&#8217;apparence</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/fr/options.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="theming.html" title="Personnaliser l’apparence"
>previous</a> |</li>
<li><a href="../index.html">0bin 0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, Sam et Max.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>
Reference in New Issue Copy Permalink