From: konrad Date: Mon, 14 Mar 2011 21:19:02 +0000 (+0000) Subject: add client docu: config and concepts X-Git-Url: http://git.silmor.de/gitweb/?a=commitdiff_plain;h=91f85fc73d3a3d951ddabc88361f928e182d0378;p=konrad%2Fsmoke.git add client docu: config and concepts git-svn-id: https://silmor.de/svn/softmagic/smoke/trunk@743 6e3c4bff-ac9f-4ac1-96c5-d2ea494d3e33 --- diff --git a/doc/client/concepts.html b/doc/client/concepts.html index 071c85d..28e3008 100644 --- a/doc/client/concepts.html +++ b/doc/client/concepts.html @@ -4,13 +4,95 @@

Magic Smoke Concepts Documentation

Architecture

+ +MagicSmoke consists of two main components: the server and the client. The server stores all events, tickets, orders, etc. The client provides access to it.

+ +There are two main lanes of access to the server - one for customers through a web browser and one for the theater itself through the specialized client.

+ + + + + + + + + + + +
Theater Access + Customer Access +
Client + Browser +
Network (HTTP)
machine.php
(Theater Interface) + index.php
(Customer Interface) +
MagicSmoke Server / Apache / Database

+ +

Events and Tickets

+ +Selling seats for events is what MagicSmoke was created for. In terms of MagicSmoke an event has the following properties: + +

a title that tells the audience what the programme is called +
an artist who performs it +
a room in which it is performed +
a start and end time and date, that tells us when it is performed +
a capacity that tells us how many tickets can be sold for the event, initially this is copied from the room's settings, but can be changed for each event +
a description that is shown to customers on the web page +
prices that tell us the price of tickets and how many of each category can be sold +

+ +Tickets belong to a specific event and enable the owner to enter the audience of an event. A Ticket has these properties: + +

the event it belongs to +
the price category it belongs to +
its price, which is normally copied from the category, but can be changed by privileged users +
a ticket ID that uniquely identifies the ticket +
the order in which it was sold (see below) +

+ +The amount of tickets for an event is limited by several factors: + +

the capacity of the event is the absolute upper limit, no more than this can be sold +
the capacity of the ticket's price category +

+ +

Orders and Vouchers

+ +MagicSmoke stores customers with names and potentially many addresses. Customers can be created from the client or by the customer him/herself through the web interface.

+ +An order is generated whenever tickets are ordered, sold, or given away for free. The order connects tickets with customers and tracks the payment of those. The difference between an order and a straight sale is that the "order" is not paid and shipped when created, while the "sale" is paid and shipped right from the start.

+ +Vouchers can be bought by customers and in return they can be used to pay for orders. Like tickets, each voucher has a unique ID that identifies it. + +

Templates and Printing

+ +Templates are the base of everything that can be stored in OpenOffice files or that can be printed.

+ +MagicSmoke has two ways of printing: tickets and vouchers are printed directly from the client. Other documents are created in OpenDocument format and then stored, opened with OpenOffice, or printed through OpenOffice. + +

Login, Users, Hosts, and Profiles

+ + +MagicSmoke uses the multi-layer login. It authenticates both the client host and the user. This is to make sure that users only connect from hosts that belong to the correct theater, it is also possible to restrict some users to fewer hosts.

+ +The login process performs the following checks: +

Architecture (Server, Browser, Client) -
Events -
Orders and Tickets -
Printing -
Users, Hosts, Profiles -
Scripting +
the client authenticates the server using the SSL certificate +
the server authenticates the client using its host name and key +
the server authenticates the user by name and password +
the server checks that the user is allowed to log in from that host

+If any of those checks fails the login is denied.

+ +Profiles are used by the client to link a specific server together with a specific host setting and other settings to be used with this server. + +

Scripting

+ +MagicSmoke attempts to execute specific scripts at various times, like client startup, the printing of tickets, or the creation of order bills. Scripts are written in the Javascript dialect of Qt. + \ No newline at end of file diff --git a/doc/client/config-office.png b/doc/client/config-office.png new file mode 100644 index 0000000..38e2096 Binary files /dev/null and b/doc/client/config-office.png differ diff --git a/doc/client/config-profile.png b/doc/client/config-profile.png new file mode 100644 index 0000000..8998a2e Binary files /dev/null and b/doc/client/config-profile.png differ diff --git a/doc/client/config-settings.png b/doc/client/config-settings.png new file mode 100644 index 0000000..cdac75f Binary files /dev/null and b/doc/client/config-settings.png differ diff --git a/doc/client/config.html b/doc/client/config.html index b208845..1870ded 100644 --- a/doc/client/config.html +++ b/doc/client/config.html @@ -4,4 +4,91 @@

Magic Smoke Client Configuration

+From the configuration dialog you can edit profiles and change all global settings that are independent of profiles and running connections. + +

Profiles

+ + +Each profile describes how connections to a specific server is made and what security settings are used for this profile. A profile has a name that is visible in the title bar of the session window.

+ +A profile is created by chosing "Profile" - "New Profile..." from the menu.

+ +

+ +In the picture above you can see the connection settings. The URL must contain the complete path to the machine.php file - the MagicSmoke client forces this URL to start with "https://". The settings below are used if you have to connect through a web proxy - check the "Proxy" checkbox to activate proxy support.

+ +The profile that is displayed bold is the default profile. The default profile is the one that is pre-selected when MagicSmoke is started.

+ +The Profile menu allows you to manipulate profiles: +

New Profile... - creates a new empty profile.
Delete Profile - deletes the currently selected profile.
Rename Profile... - gives the currently selected profile a new name.
Clone Profile... - creates a new profile by copying the currently selected profile.
Make Default Profile - marks the currently selected profile as default profile.

+ +

+ + + +Below you see the Authentication tab, which defines how the MagicSmoke client authenticates to the server:
+ +

Hostname - the name under which the client identifies itself to the server
Hostkey - the key that the client uses to identify itself. The key should be a hexa-decimal number.
Default Username - the user name that is pre-selected in the login window. Leave this field empty if you do not want a pre-selection.

+ +You can manipulate host keys through the "Profile" menu:

+ +

Generate Host Key... - generates a new key for the host.
Export Host Key... - exports the name and key as a file that can be imported in other clients or through the admin interface of the server.
Import Host Key... - imports a key file.

+ +

+ +The "SSL Exceptions" tab (below) can be used to allow the use of self-signed certificates for MagicSmoke servers. Normally the SSL engine used by MagicSmoke insists that the server's connection is properly authenticated down to a root certificate known to the operating system. To configure these connections click the "Probe Server" - MagicSmoke will either tell you that the connection was successful or what errors occurred. Check the finger print - if it matches accept the errors - from now on MagicSmoke will compare all errors it encounters with the recorded finger print and stored errors and accepts the connection if they match.

+ +

+ +The "Scripting" tab (below) defines whether any scripts are performed by the client and which source of scripts are accepted.

+ +

+ +Server side scripts: it is possible to store scripts on the server. If allowed, MagicSmoke downloads those scripts and executes them at specific times. Since scripts can access any part of the program and even the underlying system, you should allow this only for servers that you trust.

+ +Built in scripts: MagicSmoke comes with some very basic scripts built in. Use these if you do not allow any other scripts.

+ +User local scripts: scripts can also be installed locally - either to overide the server scripts or to use a known good version copied from the server. The User script path setting tells MagicSmoke where to find those local scripts.

+ +

Other Settings

+ +The "Settings" menu allows you to change settings that are shared by all profiles.

+ +

+ +Using the Language... menu item you can chose between all installed translations - the new translation becomes active after a restart of MagicSmoke.

+ +The OpenOffice.org Settings... allow you to define how MagicSmoke interfaces with OpenOffice or LibreOffice version 3.x. OpenOffice is used to create and print reports, bills, etc.

+ +Available options are:

+ +

Path to Executable - the program that is being called. Per default "soffice" is called and expected to be in the systems PATH.
Printer - the printer that is being used when printing through OpenOffice.
+
Always confirm... - if checked MagicSmoke will ask the user which printer is to be used with the one configured above being pre-selected. If unchecked MagicSmoke prints on that printer without asking.
Save printed files - asks the user to chose a file name to store a copy of any file that is being printed.
Always open as Read-Only - asks OpenOffice to open files in read-only mode instead of read-write mode.
Automatically open... - when saving files also opens them.

+ +

+ +The Set Default Label Font... allows you to chose a fall-back font for labels (tickets and vouchers) if they do not contain their own font or the font inside them cannot be interpreted by the MagicSmoke.

+ +The Set Application Style... menu item allows you to change how MagicSmoke looks.

+ \ No newline at end of file diff --git a/doc/client/config1.png b/doc/client/config1.png new file mode 100644 index 0000000..df8f129 Binary files /dev/null and b/doc/client/config1.png differ diff --git a/doc/client/config2.png b/doc/client/config2.png new file mode 100644 index 0000000..05746a4 Binary files /dev/null and b/doc/client/config2.png differ diff --git a/doc/client/config3.png b/doc/client/config3.png new file mode 100644 index 0000000..9a6898c Binary files /dev/null and b/doc/client/config3.png differ diff --git a/doc/client/config4.png b/doc/client/config4.png new file mode 100644 index 0000000..0f2fc1e Binary files /dev/null and b/doc/client/config4.png differ diff --git a/doc/client/index.html b/doc/client/index.html index 0278413..6764aa5 100644 --- a/doc/client/index.html +++ b/doc/client/index.html @@ -13,6 +13,7 @@ This section of the documentation describes how to use the dedicated Magic Smoke

Creating Events and Inventory

Selling and Shipping

User Administration +

Templates

Scripting diff --git a/doc/server.html b/doc/server.html index 205bfc2..3567090 100644 --- a/doc/server.html +++ b/doc/server.html @@ -131,6 +131,7 @@ These options configure the timeouts of cookies, what features are available to

Database Initialization

+ Open a browser and direct it to admin.php in your MagicSmoke installation (usually something like http://localhost/magicsmoke/admin.php). @@ -142,7 +143,7 @@ Click the create database button. Create an initial administrator user using the form at the bottom of the page.

-Open the client and create a host key for it - upload this host key using the admin form and allow the initial administrator to use any host.

+Open the client and create a host key for it - upload this host key using the admin form and allow the initial administrator to use any host.

Done.

Theater Access +	Customer Access +

Client +	Browser +
Network (HTTP)
machine.php (Theater Interface) +	index.php (Customer Interface) +
MagicSmoke Server / Apache / Database