docs content

Author: jarofgreen

docs/hosting/index.rst

@@ -0,0 +1,10 @@
+Hosting
+=======
+
+
+
+.. toctree::
+   :maxdepth: 2
+
+   requirements.rst
+   with_dokku.rst

docs/hosting/requirements.rst

@@ -1,11 +1,6 @@
 Hosting Requirements
 ====================
 
-Python server for the Django app
-----------------------------------
-
-Normal options
-
 Database
 ----------
 
@@ -19,7 +14,36 @@ Normal options
 File Storage
 ------------
 
-TODO
+A file storage area is needed. This holds the files supplied by users, and the cached results of processing.
+
+All code access in this library to the file storage area should be through Django `DefaultStorage` API.
+This means in theory, you are free to use:
+
+* file storage by setting `MEDIA_ROOT` and `MEDIA_URL`.
+* cloud bucket solutions (eg AWS S3, Azure Storage Container).
+* any other Django compatible Storage API.
+
+Nothing in this library requires the contents of this storage to be served on the web.
+
+However, code in apps that uses this library may have:
+
+* direct access to the file system, in which case file storage by setting `MEDIA_ROOT` and `MEDIA_URL` is required.
+* direct users to URL's for download, in which case the contents of this storage must be served on the web.
+
+All apps that use this library currently just use direct file storage by setting `MEDIA_ROOT` and `MEDIA_URL`,
+and that should be considered the only tested solution.
+
+
+Python web server for the Django app
+------------------------------------
+
+Normal options
+
+
+A background worker
+-------------------
+
+Run using Celery's normal run options.
 
 Cron tasks
 ----------

docs/hosting/with_dokku.rst

@@ -0,0 +1,8 @@
+Hosting with Dokku
+==================
+
+For examples of this, see:
+
+* https://github.com/openownership/cove-bods
+* https://github.com/Open-Telecoms-Data/cove-ofds
+* https://github.com/GFDRR/rdls-cove

docs/index.rst

@@ -26,6 +26,6 @@ The application consists of:
    django-settings.rst
    python-api/index.rst
    migration-from-lib-cove-web.rst
-   hosting/requirements.rst
+   hosting/index.rst 
    used-by.rst