~ubuntu-branches/ubuntu/saucy/postbooks-schema-empty/saucy-proposed

« back to all changes in this revision

Viewing changes to debian/README.Debian

  • Committer: Package Import Robot
  • Author(s): Daniel Pocock
  • Date: 2013-09-20 15:51:45 UTC
  • Revision ID: package-import@ubuntu.com-20130920155145-1f62xummfjo1y7lw
Tags: 4.0.2-1
Initial release. (Closes: #723853)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
 
 
2
=== IMPORTANT INFORMATION ABOUT DATABASE UPGRADES ===
 
3
 
 
4
PostBooks is a client/server solution, however, there is no actual
 
5
PostBooks server.  PostgreSQL is used as the server.
 
6
 
 
7
The PostBooks client code (Debian package "postbooks") can be used to
 
8
connect to a PostgreSQL instance on the same machine or on a network.
 
9
Consequently,
 
10
 
 
11
- The postgresql package and the database schema are not automatically
 
12
  installed with the GUI package
 
13
 
 
14
- Upgrading the client GUI package does not upgrade the database.  It is
 
15
  the administrator's responsibility to manage the database upgrade.
 
16
  The Debian maintainers of this package only aim to provide the
 
17
  GUI and a quickstart database for new users.
 
18
 
 
19
The database schema includes information about the schema version.
 
20
The client GUI checks the database version when you connect and will warn
 
21
if there is a mismatch.  Using a mismatched client with a different
 
22
database version is strongly discouraged and risks data corruption.
 
23
 
 
24
On the host where you want to run the PostgreSQL server, please
 
25
try installing one of the postbooks-schema packages, for example:
 
26
 
 
27
  # apt-get install postbooks-schema-quickstart \
 
28
       postgresql postgresql-contrib
 
29
 
 
30
to automatically install PostgreSQL itself, the required modules,
 
31
database and schema creation.
 
32
 
 
33
=== QUICKSTART ===
 
34
 
 
35
Use one of the postbooks-schema-* packages or download from
 
36
the PostBooks web site, there are three to choose from:
 
37
 
 
38
  postbooks-schema-empty
 
39
   - empty database, no chart of accounts, just tables
 
40
 
 
41
  postbooks-schema-quickstart
 
42
   - quickstart database, basic chart of accounts
 
43
 
 
44
  postbooks-schema-demo
 
45
   - demo database, has some customers in it
 
46
 
 
47
On the machine where you want to run the PostgreSQL server:
 
48
 
 
49
  # apt-get install postgresql postgresql-contrib
 
50
 
 
51
Now use the following script code at the shell on your
 
52
PostgreSQL server machine:
 
53
 
 
54
cat > /tmp/init.sql << EOF
 
55
CREATE GROUP xtrole;
 
56
CREATE USER admin WITH PASSWORD 'crm'
 
57
                       CREATEDB CREATEUSER
 
58
                       IN GROUP xtrole;
 
59
EOF
 
60
 
 
61
   su - postgres
 
62
   psql -U postgres -f /tmp/init.sql postgres
 
63
   createdb -U admin -W -h localhost pb_data
 
64
 
 
65
If using the packaged schema:
 
66
 
 
67
   zcat /usr/share/postbooks-schema/postbooks_${SCHEMA_AND_VERSION}.sql.gz | \
 
68
      pg_restore -U admin -W -h localhost -d pb_data -f - -v
 
69
 
 
70
or if you prefer to download the schema from xTuple:
 
71
 
 
72
   wget -O empty.backup http://<insert URL of database you want>
 
73
   pg_restore -U admin -W -h localhost -d pb_data empty.backup -v
 
74
 
 
75
If your GUI is not on the same host as the PostgreSQL server, you
 
76
may have to edit /etc/postgresql/9.1/main/pg_hba.conf to
 
77
add your host or IP range to the ACL, eg. add something like this:
 
78
 
 
79
host  pb_data    all   192.168.1.0/24   md5
 
80
 
 
81
and then
 
82
 
 
83
  service postgresql reload
 
84
 
 
85
Finally, start the GUI with the command "postbooks" and login
 
86
using your database credentials.
 
87
 
 
88
=== PRODUCT NAME: xTuple OR PostBooks? ===
 
89
 
 
90
Upstream seems to use the names "xTuple" and "PostBooks" interchangeably
 
91
to refer to their product.
 
92
 
 
93
The tarball is named xtuple and the git repository is xtuple/qt-client
 
94
 
 
95
The name xTuple appears to be used in this way with several products
 
96
from the same upstream, some of them distributed as commercially
 
97
licensed non-free software.  The PostBooks name has been designated
 
98
by upstream for the free version of the product.  Consequently,
 
99
the Debian packaging refers to the source package and the binary
 
100
using the name "postbooks".
 
101