1.3.15-2/debian/README.Debian

LedgerSMB for Debian
--------------------

Optional Perl modules
=====================

    Net::TCLink              [Support for TrustCommerce credit card processing]
    Parse::RecDescent        [Support for the *experimental* scripting engine]
    Template::Plugin::Latex  [Support for Postscript and PDF output]
    OpenOffice::OODoc        [Support for OpenOffice output]
    Excel::Template::Plus    [Support for Excel output]

    The credit card processing support for TrustCommerce is available as
    the package libnet-tclink-perl if not already installed:

    The Open Office output support is available as libopenoffice-oodoc-perl if
    it is not already installed.

    The scripting engine support is available as libparse-recdescent-perl
    if it is not already installed:

    If the libtemplate-plugin-latex-perl package needed for the PDF/Postscript
    output option is not available, then if you want to use that option you
    will need to download and install the module Template::Plugin::Latex from
    CPAN.

    Please note that the PDF/Postscript module depends on the TeX/LaTeX
    package which is available as texlive-latex-recommended.

    If the libexcel-template-plus-perl package needed for the Excel output
    option is not available, then if you want to use that option you will
    need to download and install Excel::Template::Plus module from CPAN.


Initializing a company database
===============================

    LedgerSMB 1.3 stores data for each company in a separate "database". A
    database is a PostgreSQL concept for grouping tables, indexes, etc. Each
    company database must be named.  This name is essentially the system
    identifier within PostgreSQL for the company's dataset.  The name for the
    company database can only contain letters, digits and underscores, and
    it must start with a letter.  Company database names are case insensitive,
    meaning you can't create two separate company databases called 'Ledgersmb'
    and 'ledgersmb'.

    One way that company databases can be created fairly easily is by directing
    your web browser to the setup.pl script, which by default can be accessed at 
    http://localhost/ledgersmb/setup.pl. This is very different from approaches
    taken by LedgerSMB 1.2.x and SQL-Ledger, but rather forms a wizard to walk
    you through the process of creating company databases and initial users for
    those databases.

    The standard database superuser used in the setup.pl script has the name
    'ledgersmb'. If it is not created during the package configuration,
    it can be created using the following sql statement:
    
CREATE ROLE ledgersmb WITH SUPERUSER LOGIN NOINHERIT ENCRYPTED PASSWORD 'password';

    Besides assuming that a database superuser is known, the setup.pl script
    also assumes that the contrib_dir directive is already set correctly in
    /etc/ledgersmb/ledgersmb.conf for the location of the PostgreSQL contrib
    scripts. For v8.4 it would be /usr/share/postresql/8.4/contrib; or for
    v9.1 that would be /usr/share/postgresql/9.1/extension.
    

Manual addition of a company database
=====================================

    If you want to perform the installation of the company database completely
    manually, you should consult the 'prepare-company-database.sh' or the
    'dbsetup.pl' scripts which are available in the /usr/share/ledgersmb/tools/
    directory as the authorative documentation of the steps to perform.


Company database removal
========================

    In the /usr/share/ledgersmb/tools/ directory, there's a script which will
    remove a company database and all the standard authorization data that had
    been created by the 'prepare-company-database.sh' script.  The script is
    named 'delete-company-database.sh'.


 -- Robert James Clay <jame@rocasa.us>  Wed, 18 Apr 2012 15:24:06 -0500
1	LedgerSMB for Debian
2	--------------------
3
4	Optional Perl modules
5	=====================
6
7	Net::TCLink [Support for TrustCommerce credit card processing]
8	Parse::RecDescent [Support for the experimental scripting engine]
9	Template::Plugin::Latex [Support for Postscript and PDF output]
10	OpenOffice::OODoc [Support for OpenOffice output]
11	Excel::Template::Plus [Support for Excel output]
12
13	The credit card processing support for TrustCommerce is available as
14	the package libnet-tclink-perl if not already installed:
15
16	The Open Office output support is available as libopenoffice-oodoc-perl if
17	it is not already installed.
18
19	The scripting engine support is available as libparse-recdescent-perl
20	if it is not already installed:
21
22	If the libtemplate-plugin-latex-perl package needed for the PDF/Postscript
23	output option is not available, then if you want to use that option you
24	will need to download and install the module Template::Plugin::Latex from
25	CPAN.
26
27	Please note that the PDF/Postscript module depends on the TeX/LaTeX
28	package which is available as texlive-latex-recommended.
29
30	If the libexcel-template-plus-perl package needed for the Excel output
31	option is not available, then if you want to use that option you will
32	need to download and install Excel::Template::Plus module from CPAN.
33
34
35	Initializing a company database
36	===============================
37
38	LedgerSMB 1.3 stores data for each company in a separate "database". A
39	database is a PostgreSQL concept for grouping tables, indexes, etc. Each
40	company database must be named. This name is essentially the system
41	identifier within PostgreSQL for the company's dataset. The name for the
42	company database can only contain letters, digits and underscores, and
43	it must start with a letter. Company database names are case insensitive,
44	meaning you can't create two separate company databases called 'Ledgersmb'
45	and 'ledgersmb'.
46
47	One way that company databases can be created fairly easily is by directing
48	your web browser to the setup.pl script, which by default can be accessed at
49	http://localhost/ledgersmb/setup.pl. This is very different from approaches
50	taken by LedgerSMB 1.2.x and SQL-Ledger, but rather forms a wizard to walk
51	you through the process of creating company databases and initial users for
52	those databases.
53
54	The standard database superuser used in the setup.pl script has the name
55	'ledgersmb'. If it is not created during the package configuration,
56	it can be created using the following sql statement:
57
58	CREATE ROLE ledgersmb WITH SUPERUSER LOGIN NOINHERIT ENCRYPTED PASSWORD 'password';
59
60	Besides assuming that a database superuser is known, the setup.pl script
61	also assumes that the contrib_dir directive is already set correctly in
62	/etc/ledgersmb/ledgersmb.conf for the location of the PostgreSQL contrib
63	scripts. For v8.4 it would be /usr/share/postresql/8.4/contrib; or for
64	v9.1 that would be /usr/share/postgresql/9.1/extension.
65
66
67	Manual addition of a company database
68	=====================================
69
70	If you want to perform the installation of the company database completely
71	manually, you should consult the 'prepare-company-database.sh' or the
72	'dbsetup.pl' scripts which are available in the /usr/share/ledgersmb/tools/
73	directory as the authorative documentation of the steps to perform.
74
75
76	Company database removal
77	========================
78
79	In the /usr/share/ledgersmb/tools/ directory, there's a script which will
80	remove a company database and all the standard authorization data that had
81	been created by the 'prepare-company-database.sh' script. The script is
82	named 'delete-company-database.sh'.
83
84
85
86	-- Robert James Clay <jame@rocasa.us> Wed, 18 Apr 2012 15:24:06 -0500