Added documentation, removed some options

Author: sametmax

README.rst

@@ -1,13 +1,21 @@
 0bin
 ====
 
-Have a try here: <a href="http://0bin.net">0bin.net</a>
-
 0bin is a client side encrypted pastebin that can run without a database.
 
-It allows anybody to host a pastebin while welcoming any type of content to be pasted in it. The idea is that one can (probably...) not be legally entitled to <a href="http://www.zdnet.com/blog/security/pastebin-to-hunt-for-hacker-pastes-anonymous-cries-censorship/11336">moderate the pastebin content</a> as he/she has no way to decrypt it.
+* Try it: `0bin.net <http://0bin.net>`_
+* Get the `source on github <https://github.com/sametmax/0bin>`_
+* `Report a bug <https://github.com/sametmax/0bin/issues>`_
+
+0bin allows anybody to host a pastebin while welcoming any type of content to
+be pasted in it. The idea is that one can (probably...) not be legally entitled
+to `moderate the pastebin content`_ as he/she has no way to decrypt it.
+
+It's an Python implementation of the
+`zerobin project`_. It's easy to
+install even if you know nothing about Python.
 
-It's an Python implementation of the <a href="https://github.com/sebsauvage/ZeroBin/">zerobin project</a>. It's easy to install even if you know nothing about Python.
+For now tested with IE9, and the last opera, safari, chrome and FF.
 
 How it works
 =============
@@ -33,17 +41,30 @@ Key points:
 - all operations, including code coloration, must happens on the client;
 - the server is no more than a fancy recipient for the encrypted data.
 
+Other features
+======================
+
+- automatic code coloration (no need to specify);
+- pastebin expiration: 1 day, 1 month or never;
+- burn after reading: the paste is destroyed after the first reading;
+- clone paste: you can't edit a paste, but you can duplicate any of them;
+- code upload: if a file is too big, you can upload it instead of using copy/paste;
+- copy paste to clipboard in a click;
+- get paste short URL in a click;
+- own previous pastes history;
+- visual hash of a paste to easily tell it appart from others in a list.
 
 Technologies used
 ==================
 
-- <a href="https://en.wikipedia.org/wiki/Python_(programming_language)">Python</a>
-- <a href="http://bottlepy.org/">The Bottle Python Web microframework</a>
-- <a href="http://crypto.stanford.edu/sjcl/">SJCL</a> (js crypto tools)
-- <a href="http://jquery.com/">jQuery</a>
-- <a href="http://twitter.github.com/bootstrap/">Bootstrap</a>, the twitter css framework
-- <a href="https://github.com/sametmax/VizHash.js">VizHash.js</a> to create visual hashes from pastes
-- Cherrypy (server only)
+- Python_
+- `The Bottle Python Web microframework`_
+- SJCL_ (js crypto tools)
+- jQuery_
+- Bootstrap_, the Twitter HTML5/CSS3 framework
+- VizHash.js_ to create visual hashes from pastes
+- Cherrypy_ (server only)
+
 
 Known issues
 ============
@@ -56,6 +77,18 @@ Known issues
 What does 0bin not implement?
 =================================
 
-* Request throttling. It would be inefficient to do it at the app level, and web servers have robust implementations.
-* Hash collision prevention: the ratio "probability it happens/consequence seriousness" <a href="http://stackoverflow.com/questions/201705/how-many-random-elements-before-md5-produces-collisions">is not worth it</a>
-* Comments: for now. It's on the todo list.
+* Request throttling. It would be inefficient to do it at the app level, and web servers have robust implementations for it.
+* Hash collision prevention: the ratio "probability it happens/consequence seriousness" `is not worth it`_
+* Comments: it was initially planed. But comes with a lot of issues so we chose to focus on lower handing fruits.
+
+
+.. _moderate the pastebin content: http://www.zdnet.com/blog/security/pastebin-to-hunt-for-hacker-pastes-anonymous-cries-censorship/11336
+.. _zerobin project: https://github.com/sebsauvage/ZeroBin/
+.. _Python: https://en.wikipedia.org/wiki/Python_(programming_language)
+.. _The Bottle Python Web microframework: http://bottlepy.org/
+.. _SJCL: http://crypto.stanford.edu/sjcl/
+.. _jQuery: http://jquery.com/
+.. _Bootstrap: http://twitter.github.com/bootstrap/
+.. _VizHash.js: https://github.com/sametmax/VizHash.js
+.. _Cherrypy: http://www.cherrypy.org/ (server only)
+.. _is not worth it: http://stackoverflow.com/questions/201705/how-many-random-elements-before-md5-produces-collisions

docs/.build/doctrees/en/apache_install.doctree

@@ -1,3 +1,39 @@
-=========================
-Installation with Apache
-=========================
+=============
+Apache setup
+=============
+
+Apache is slower, heavier and more complicated to setup than Nginx. But it's also
+much more famous:
+
+- more people will be able to help you on forums;
+- your hosting will most probably support Apache;
+- the configuration file syntax is familiar to a lot of people.
+
+An Apache setup is still much more robust and secure than an easy installation.
+
+Une installation apache est aussi beaucoup plus solide et sécurisé qu'une
+installation facile. You'll benefit from having:
+
+- the possiblity to have several projects listening to the port 80;
+- several Apache module at your disposal (like requests throttling);
+- Apache robustness in front end: it's secure, and there is much less chance
+  it will crash under heavy load;
+- your web site processes won't run with admin rights, even if --user doesn't
+  work on your OS.
+
+
+Mod_wsgi
+==========
+
+The modern Web Python servers all work the same way, following an norm for
+interfacing: WSGI.
+
+This is the most performante solution, and the best to use. But it will require
+the setup of the Apache module mod_wsgi. If you don't know how to do this, or
+if you can't do it (E.G: your hosting won't let you), you need to go for
+the CGI setup.
+
+==========
+
+This setup is considered as slow, but you will still benefit from Apache
+robustness.

docs/.build/doctrees/en/easy_install.doctree

@@ -1,3 +1,58 @@
 ====================
 Easiest installation
-====================
+====================
+
+These solution are easy all will be able to handle a personnal website traffic.
+For more robust and secure solutions, see Apache et Nginx setups.
+
+10 seconds setup (if you know Python already)
+===============================================
+
+pip install zerobin
+zerobin --host 0.0.0.0 --port 80 --compressed-static # as admin
+
+30 seconds setup (for anybody)
+===============================
+
+- Make sure you have Python 2.6 or 2.7 (`python --version`)
+- Download the last zip of the sources code.
+- Extract all of it where you wish the site to be stored.
+- Go to the extracted files.
+- Run `python zerobin.py --host 0.0.0.0 --port 80 --compressed-static`
+  with the admin rights.
+
+On ubuntu, this is a one liner::
+
+    wget stuff && unzip zerobin.zip && cd zerobin && sudo python zerobin.py --host 0.0.0.0 --port 80 --compressed-static
+
+Check out for more configuration options.
+
+Run 0bin in background
+=======================
+
+0bin doesn't come with something built in for this. You have several solutions:
+
+For a small website:
+
+Just make it a shell background process. E.G in GNU/Linux::
+
+  nohup python zerobin.py --host 0.0.0.0 --port 80 --compressed-static &
+
+Or run it in a screen.
+
+For a big Website:
+
+- setup 0bin with Apache;
+- setup 0bin with supervisord (best way to do it);
+
+.. Note::
+
+    You can even use zerobin on your private local network from your laptop.
+
+    Make sure you firewall won't block the port, and run::
+
+        python zerobin.py --host 0.0.0.0 --port 8000
+
+    0bin will now be accessible from http://your.local.ip.address:8000.
+
+    This can be very cool way to share code in a companie or during a code sprint.

docs/.build/doctrees/en/intro.doctree

@@ -54,15 +54,15 @@ Technologies used
 - `The Bottle Python Web microframework`_
 - SJCL_ (js crypto tools)
 - jQuery_
-- Bootstrap_, the twitter HTML5/CSS3 framework
+- Bootstrap_, the Twitter HTML5/CSS3 framework
 - VizHash.js_ to create visual hashes from pastes
 - Cherrypy_ (server only)
 
 
 Known issues
 ============
 
-- 0bin use several HTML5/CSS3 features that are not widely supported. In that case we handle the degradation as gracefully as we can.
+- 0bin uses several HTML5/CSS3 features that are not widely supported. In that case we handle the degradation as gracefully as we can.
 - The "copy to clipboard" feature is buggy under linux. It's flash, so we won't fix it. Better wait for the HTML5 clipboard API to be implemented in major browsers.
 - The pasted content size limit check is not accurate. It's just a safety net, so we thinks it's ok.
 - Some url shorteners and other services storing URLs break the encryption key. We will sanitize the URL as much as we can, but there is a limit to what we can do.
@@ -71,7 +71,7 @@ What does 0bin not implement?
 =================================
 
 * Request throttling. It would be inefficient to do it at the app level, and web servers have robust implementations for it.
-* Hash collision: the ratio "probability it happens/consequence seriousness" <a href="http://stackoverflow.com/questions/201705/how-many-random-elements-before-md5-produces-collisions"is not worth it</a
+* Hash collision prevention: the ratio "probability it happens/consequence seriousness" `is not worth it`_
 * Comments: it was initially planed. But comes with a lot of issues so we chose to focus on lower handing fruits.
 
 
@@ -83,4 +83,5 @@ What does 0bin not implement?
 .. _jQuery: http://jquery.com/
 .. _Bootstrap: http://twitter.github.com/bootstrap/
 .. _VizHash.js: https://github.com/sametmax/VizHash.js
-.. _Cherrypy: http://www.cherrypy.org/ (server only)
+.. _Cherrypy: http://www.cherrypy.org/ (server only)
+.. _is not worth it: http://stackoverflow.com/questions/201705/how-many-random-elements-before-md5-produces-collisions

docs/.build/doctrees/en/nginx_install.doctree

@@ -1,3 +1,64 @@
-========================
-Installing with Nginx
-========================
+============
+Nginx setup
+============
+
+Nginx is a very popular choice to serve a Python project:
+
+- It's fast.
+- It's lightweight.
+- Configuration files are simple.
+
+If you have your own server, it's the best choice. If not, try the easiest
+setup, or the Apache setup.
+
+Nginx doesn't run any Python process, it only serve requests from outside to
+the Python server.
+
+Therefor there are two steps:
+
+- Run the Python process.
+- Run Nginx.
+
+You will benefit from having:
+
+- the possiblity to have several projects listening to the port 80;
+- several Apache module at your disposal (like requests throttling);
+- Apache robustness in front end: it's secure, and there is much less chance
+  it will crash under heavy load;
+- your web site processes won't run with admin rights, even if --user doesn't
+  work on your OS;
+- the ability to manage a Python process without touching Nginx or the other
+  processes. It's very handy for updates.
+
+The Python process
+==================
+
+Run 0bin as usual, but this time make it listen to a local port and host. E.G::
+
+    zerobin --host 127.0.0.1 --port 8000
+
+In PHP, when you edit a file, the changes are immediatly visible. In Python,
+the whole code is often loaded in memory for performance reasons. This means
+you have to restart the Python process to see the changes effect. Having a
+separate process let you do this without having to restart the server.
+
+Nginx
+======
+
+Nginx can be installed with you usual package manager, so we won't cover
+installing it.
+
+Vous must create a Nginx configuration file for 0bin. On GNU/Linux, they usually
+go into /etc/nginx/conf.d/. Name it zerobin.conf.
+
+The minimal file to run the site is:
+
+But you can make some adjustement to get better perfomances:
+
+
+
+
+
+
+
+