[doc] update the documentation
authormathieui <mathieui@mathieui.net>
Fri, 7 Mar 2014 18:40:23 +0000 (19:40 +0100)
committermathieui <mathieui@mathieui.net>
Fri, 7 Mar 2014 18:40:23 +0000 (19:40 +0100)
README.rst
examples/apache_fcgi [moved from examples/apache with 100% similarity]
examples/lighttpd_fcgi [moved from examples/lighttpd with 100% similarity]
examples/nginx_fcgi [moved from examples/nginx with 100% similarity]

index 44788a2..0a8e9e5 100644 (file)
@@ -1,5 +1,5 @@
 PleasShare
-=================
+==========
 
 PleaseShare is a file-sharing website that aims to decentralize file-sharing through the use of torrent, DHT, and webseeds.
 
@@ -57,6 +57,7 @@ Create a database and an administrator:
 Update the schema with the latest South migration:
 
 ::
+
     $ ./manage.py migrate pleaseshare
 
 Then edit the variables in local_settings.py and in settings.py to fit your needs.
@@ -64,15 +65,16 @@ local_settings.py contains a few variables related to pleaseshare only (web seed
 settings.py contains things more related to django, with a lot of things you should not touch.
 
 Things you might want to touch:
-    - In settings.py
-        - ADMINS
-        - DEBUG (edit it)
-        - MEDIA_ROOT: used to store the uploaded files and torrents
-        - MEDIA_URL: used to locate the uploaded medias in the url
-        - SECRET_KEY: this is the one I generated, it is public, choose another
-    - In local_settings.py
-        - DATABASES (sqlite is not recommended for anything else than testing)
-        - Everything.
+
+- In settings.py
+    - ADMINS
+    - DEBUG (edit it)
+    - MEDIA_ROOT: used to store the uploaded files and torrents
+    - MEDIA_URL: used to locate the uploaded medias in the url
+    - SECRET_KEY: this is the one I generated, it is public, choose another
+- In local_settings.py
+    - DATABASES (sqlite is not recommended for anything else than testing)
+    - Everything.
 
 
 Now, to deploy it, you can choose between various methods, my favourite is fastCGI_ with a local port (like 3042).
@@ -89,19 +91,31 @@ Now that your website is up and running, log in into the admin interface at http
 
 Finally, in order to get the webseeds to work, do not forget to have the directory where you upload the files (the MEDIA_ROOT var) directly handled by the web server, because django was not created to serve static files, and does not support range http requests, mandatory for webseeds, comment out the bottom lines in urls.py to be sure.
 
-.. _fastCGI : https://docs.djangoproject.com/en/1.3/howto/deployment/fastcgi/
-.. _And configure your webserver : https://docs.djangoproject.com/en/1.3/howto/deployment/
+.. _fastCGI : https://docs.djangoproject.com/en/1.6/howto/deployment/fastcgi/
+.. _And configure your webserver : https://docs.djangoproject.com/en/1.6/howto/deployment/
+
+
+.. note::
+    Do not forget to read the wiki_.
 
-*Do not forget to read the wiki: https://gitorious.org/pleaseshare/pages/Home*
+.. _wiki: https://gitorious.org/pleaseshare/pages/Home
 
 Misc
 ----
 
 Some indications about how webseeds work might be in order.
-When the torrent has a single file, then it’s easy: the webseed is the complete url of the file.
-When the torrent is multifile, then the webseed url is the url of the parent directory (I’m talking about the torrents in PleaseShare, which are always contained in a parent directory named after the archive name).
+
+- When the torrent has a single file, then it’s easy: the webseed is the complete url of the file.
+- When the torrent is multifile, then the webseed url is the url of the parent directory (I’m talking about the torrents in PleaseShare, which are always contained in a parent directory named after the archive name).
+
 For example, you upload a koin.tar.gz archive, you will have a url like /upload/48a3-[…]/, containing a 'koin' directory, that will contain the files inside the archive.
-The webseed url should *not* contain the 'koin' directory, but the parent level ; and, of course, file indexing should be disabled, or the file generated by the webserver might cause problems to some clients.
 
-So let’s say you want to add a source to the torrent using your personal webserver (again for the koin.tar.gz torrent), you will have to put something like that as a webseed: http://example.com/uploads/.
+The webseed url should *not* contain the 'koin' directory, but the parent
+level; and, of course, file indexing should be disabled, or the file generated
+by the webserver might cause problems to some torrent clients.
+
+So let’s say you want to add a source to the torrent using your personal
+webserver (again for the koin.tar.gz torrent), you will have to put something
+like that as a webseed: http://example.com/uploads/ which will contain a ``koin``
+directory.
 
similarity index 100%
rename from examples/apache
rename to examples/apache_fcgi
similarity index 100%
rename from examples/lighttpd
rename to examples/lighttpd_fcgi
similarity index 100%
rename from examples/nginx
rename to examples/nginx_fcgi