This is the technical reference for the Listiary wiki platform.

Describe is built and developed for Listiary, but can also be used on its own. Both Listiary and Describe are free and copyleft-ed, under the GNU Affero General Public License, version 3 (AGPLv3).

Here you can find documentation on the architecture, components, modules, infrastructure, and other technical aspects of Listiary and its supporting software. This section is currently under development.


Modules of Listiary

listiary-modules

The Listiary system can be divided into four layers:

  • hosting infrastructure
  • administrative modules
  • user-facing modules
  • standalone pages

Hosting Layer - A Listiary installation requires conventional PHP/SQL-capable web hosting and an Amazon Web Services (AWS) account for its server-side services - namely the Describe compiler. The documentation site is hosted separately as a static site and does not need to be hosted by individual Listiary administrators.

  • PHP capable web hosting
  • SQL server (Maria DB compatible)
  • AWS lambda function micro service
  • Hosting for the static documentation site

Administrative Modules - The administrative layer provides the tools required to install, configure, and administer a Listiary instance. It also includes the Session Module, which manages access and permissions, and Spark CLI, a separate console application for administering a Listiary backend from an operating-system console.

  • Web Installer - PHP based installer/configurator
  • Web Admin - The admin panel
  • Session Module - The accounts and session management
  • Spark CLI - OS based admin framework. Separate software

Userland Modules - These are the modules that users interact with during normal use of Listiary.

  • Index Module - the usual wiki view
  • Editor Module - the Describe editor
  • Code Viewer Module - similar to the editor, but read-only
  • History Module - view/compare edit history
  • Search Module - the search page/engine

Standalone Pages - These are standalone pages that are adjacent to the core Listiary system and do not need to interact with it at a deeper level. The documentation site and legal pages are examples: they are part of the overall Listiary project, but do not depend on the wiki functionality itself.

  • Documentation - This documentation website
  • Legal Docs - ToS, Cookie Consent, Privacy Policy and such
  • Contact Us - contact us / bug report forms


Modules

Listiary Wiki - Spark
Listiary Wiki - Database


User Documentation
Site SubMap

Back