. '''To [[Software|Software]]''' - '''To [[OverviewProjectsBoard|Overview Projects Board]]''' - '''To [[SystemAdministration/Systems/Webdb|Webdb Sys Administration]]'''

----

= Software: Webdb Documentation (Project WIP) =

== Overview ==

 * [[Software/SourceCode|General Overview]]

== Source Code ==

 a. Tarball thru CAcert main website: [[http://www.cacert.org/src-lic.php|About CAcert.org - Sourcecode]]
 a. git repository: [[Software/DevelopmentWorkflow|Systems - GIT Repository / Development Workflow]]
 a. [[Software/Webdb/Source/Orphans|Orphan]] files in repository

== Installation ==

 a. [[Software/HowToInstallSource|How To Install Source]]
 a. [[SystemAdministration/Systems/Webdb|Systems description install instructions]]
 a. Post-installation tasks
  1. load Location Database
  1. Add new Root and Subroots
  1. Add root and subroots descriptions into table Root_Certs

== Database ==

 a. [[Software/Database/StructureDefined|Database structure defined]]
 a. [[Software/Database/LocationDatabase|Location Database]]

== Groups of Users ==

 a. new members
 a. members
 a. fully assured members
 a. prospective assurers
 a. assurers
 a. experienced assurers
 a. organisation admins (assurers within organisations)
 a. organisation assurers
 a. support engineers
 a. 

== Main Functions ==

=== User account functions ===
 a. create account
 a. account verification
 a. setting up user account
  1. notifications
  1. list me
  1. set location
  1. lost password questions
  1. define language
  1. secondary language settings
 a. modify account
 a. delete account
 a. email dispute
 a. domain dispute
 a. create email
 a. create client cert
 a. create domain
 a. create server cert
 a. create gpg/pgp key
 a. enable special flags
  1. codesigning
  1. assurer flag
  1. admin flag
  1. ttpadmin
  1. orgadmin
  1. board
  1. tverify
  1. locadmin
  1. adadmin
   . adadmin = 0 => (default) no ADS request or confirm function is allowed to the user, view ADS is enabled to all users
   . adadmin = 1 => customer is enabled to request ADs
   . adadmin = 2 => Treasurer or other CAcert people (Board? Support-Engineers?) can check outstanding ADS requests and can confirm the request, so ADS are placed onto the main website under the right bar menu
 a. other special flags
  1. locked
  1. assurer_blocked
  1. otppin
  1. uniqueID
  1. orphash 

=== Assurer functions ===
 a. CATS
 a. Is Assurer flag
 a. List of CATS passed
 a. Assure someone
 a. Revoke Assurance

=== Support Engineer functions ===
 a. search user
 a. search domain

=== Organisation Assurer functions ===

=== Organisation Admin functions ===

=== Location (database) Admin functions ===

=== TTP admin functions ===

=== Board flag functions ===

=== Tverify flag functions (depricated) ===

=== AD admin functions ===
 . adadmin = 0 => (default) no ADS request or confirm function is allowed to the user, view ADS is enabled to all users
 . adadmin = 1 => customer is enabled to request ADs
 . adadmin = 2 => Treasurer or other CAcert people (Board? Support-Engineers?) can check outstanding ADS requests and can confirm the request, so ADS are placed onto the main website under the right bar menu

 {{{
PG 2011-07-26
Yes, adadmin=1 is for the customers who can easily request multiple links 
whenever they want to.
Be careful with the ads, though: too many ads (>=5 I would say) will 
decrease our Google rank, since Google does not like irrelevant 
advertisement, and our Google ad income will drop considerably.
}}}

== Structure ==
The system structure is splitted to the Webdb (web application and database) and the Signer (CA)
 1. Webdb
  1. Entry point
   1. index.php
   1. account.php
   1. wot.php
 1. Signer
  * The signer communication is splitted to client.pl and server.pl
  * 2 scripts that communicates thru a serial line connection between the physical machine '''Webdb''' and '''Signer'''
  * client.pl is running on the '''Webdb''' side (the client)
  * server.pl is running on the '''Signer''' side (the server)

== Database Access ==

== External Access ==

== CommModule ==
 * The !CommModule is the systems heart to send certificate signing requests (client.pl) from the '''Webdb''' machine thru a serial connection to the '''Signer''' server (server.pl).
 * [[Software/Webdb/CommModule|Details of !CommModule communication]]

== Maintenance ==
 1. [[Software/Webdb/Maintenance/AddNewRoots|Add new Root, Subroots]]
 1. [[Software/Webdb/Maintenance/DatabaseUpgrades|Database Upgrades]]

=== Procedures ===
 * [[SystemAdministration/Systems/CATS|Transfer data from CATS]]


----
 . CategorySoftware
 . CategorySoftwareWebdb
 . CategorySystems