docs/overview.rst

   1 Overview
   2 ========
   3
   4 Dynamic content
   5 ---------------
   6 The dynamic content of the website is rendered using Django. The
   7 django project is called "pgweb", and consists of a number of
   8 applications under it. These applications are *not* designed to be
   9 independent, and cross-referencing between them is both allowed and
  10 normal. It should therefor not be expected that they will work if
  11 copied outside the pgweb environment.
  12
  13 For more details about the django implementation, see the django.rst file.
  14
  15 Static HTML content
  16 -------------------
  17 For those pages that don't need any database access or other kinds of
  18 logic, simple HTML templates are used.  Any content here is edited as
  19 plain HTML, and the django template engine is used to wrap this
  20 content in the regular website framework.
  21
  22 All pages handled this way are stored in templates/pages/, with each
  23 subdirectory mapping to a sub-url. The code for rendering these pages
  24 is found in pgweb/core/views.py, function fallback().
  25
  26 Non-HTML content
  27 ----------------
  28 Non-HTML content is stored in the media/ directory, which is served up
  29 by django when run under the local webserver, but is expected to be
  30 served up directly by the webserver when deployed in production. This
  31 directory has subdirectories for images, css and javascript, as well
  32 as some imported modules.
  33
  34 Note that there is also /adminmedia/, which is directly linked to the
  35 django administrative interface media files, that are shipped with
  36 django and not with pgweb.
  37
  38 Non-web content
  39 ---------------
  40 Non-web content, such as PDF files and other static data, is handled
  41 in it's own git repository, in order to keep the size of the main
  42 repository down (since some of these files can be very large). The
  43 repository is named pgweb-static.git, and also located on
  44 git.postgresql.org. These files should be made visible through the
  45 webserver at the /files/ url.
  46
  47 Batch jobs and integrations
  48 ---------------------------
  49 There are a number of batch jobs expected to run on the server, in
  50 order to fetch data from other locations. There are also jobs that
  51 need to run on a different server, such as the ftp server, to push
  52 information to the main server. For more details about these, see the
  53 batch.rst file.