PubliForge’s documentation

PubliForge is a Pyramid Web site and Web service application. It was originally developed by iinov team. It is licensed under the the terms of the GNU General Public License.

PubliForge is PEP8 compliant and pylint checked.

You can download the latest stable release at http://pypi.python.org/pypi/PubliForge.

You can visit demonstration site at http://demo.publiforge.org (user: demo, password: demo-password).

Latest version: 2.3.0

Installation

How to install PubliForge in production mode along with development mode.

• Deployment Environment
  • Installing a Global Virtual Environment
  • Adding a User
  • Installing Required Packages
  • Setting up the Database
  • Installing PubliForge
  • Setting Up PubliForge Environment
  • Populating the Database and the Storages
  • Activating Job Scheduler
  • Deploying
• Deployment with Apache and mod_wsgi
  • Installing mod_wsgi
  • Creating WSGI script
  • Configuring Apache
• Deployment with Nginx and supervisord
  • Managing Your Paster Processes with Supervisord
  • Configuring Nginx
• Customization with INI File
  • [app:PubliForge] Section
  • [Populate] Section
• Development Environment
  • Installing the Virtualenv Environment
  • Setting up an UTF-8 environment
  • Installing Required Packages and modules
  • Setting up the Database
  • Installing PubliForge
  • Populating the Database and the Storages
  • Testing the application
  • Running the application
• Local storage publishing with Mercurial and Apache
  • Generating a Self-Signed Certificate
  • Installing Mercurial Configuration Files
  • Configuring Apache
• Documentation Generation

Extension

How to generate a set of configuration files for PubliForge or to create a new processor.

• Instance Creation
• Processor Creation

Front Web User Guide

A guide to work with the Web interface.

• Interface
• Storages
  • Storage index
  • Storage browser
  • Advanced search
• Projects
  • Project index
  • Dashboard
• Administration
  • User Guide
  • Group Guide
  • Storage Guide
  • Indexer Guide
  • Project Guide
• Script Guide
  • pfpopulate
  • pfbackup

Agent User Guide

A guide to use agent with command-line scripts and to know how to configure a resource for a processing.

• Module Guide
  • Validator
  • LePrisme
  • Publiseter
  • Generator
• Processor Guide
  • CharCount
  • PublidocValid
  • Publidoc2XHtml
  • Publidoc2Html5
  • Publidoc2EPub2
  • Publidoc2EPub3
  • Publidoc2Pdf
  • PublidocClean
  • Publiquiz2Html5
  • Publiquiz2EPub3
  • Publiset4Publidoc
  • Publiset4Publiquiz
  • PackFilling
  • CleanStorage
• Script Guide
  • pfbuild

Front Web Reference

Front web reference includes documentation for every PubliForge front API.

• Script Reference
  • The scripts.pfpopulate Script
  • The scripts.pfpbackup Script
• Initialization Reference
  • The __init__ Module
  • The initialize Module
• View Reference
  • The views.security Module
  • The views.maintenance Module
  • The views.home Module
  • The views.user Module
  • The views.selection Module
  • The views.group Module
  • The views.storage Module
  • The views.indexer Module
  • The views.file Module
  • The views.project Module
  • The views.processing Module
  • The views.role Module
  • The views.task Module
  • The views.pack Module
  • The views.site Module
  • The views.build Module
  • The views.maestro Module
• Model Reference
  • The models Module
  • The models.users Module
  • The models.groups Module
  • The models.storages Module
  • The models.indexers Module
  • The models.processors Module
  • The models.projects Module
  • The models.processings Module
  • The models.packs Module
  • The models.tasks Module
• Front Library Reference
  • The lib.build.front Module
  • The lib.opener Module
  • The lib.handler Module
  • The lib.xml Module
  • The lib.i18n Module
  • The lib.config Module
  • The lib.utils Module
  • The lib.log Module
  • The lib.filter Module
  • The lib.viewutils Module
  • The lib.packutils Module
  • The lib.form Module
  • The lib.breadcrumbs Module
  • The lib.menu Module
  • The lib.tabset Module
  • The lib.rsync Module
  • The lib.vcs Module
• Permissions
  • Global permissions
  • Permissions on a storage
  • Permissions on a project
• Session
• Cookies

Agent Reference

Agent reference includes documentation for every PubliForge agent API.

• Script Reference
  • The scripts.pfbuild Module
• Agent Library Reference
  • The lib.build.agent Module
  • Modules
    • The lib.processor.validator Module
    • The lib.processor.leprisme Module
    • The lib.processor.publiseter Module
    • The lib.processor.generator Module
• XML-RPC Reference

Indices and tables

• Index
• Module Index
• Search Page