Recent changes to Installing

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Fri, 26 May 2023 15:58:15 -0000

--- v10
+++ v11
@@ -11,12 +11,11 @@
 - DBI,
 - Fcntl,
 - Getopt::Long,
+- HTTP::DAV,
 - Log::Log4perl,
 - MIME::Base64,
 - MIME::Parser,
  with all their dependencies (the list may include but not be limited to: Module::Install, Test::NoWarnings, Test::LongString, Class::Accessor, DateTime, DateTime::TimeZone, Moo, Set::Infinite, Test::Requires, Class::Accessor-Chained, Class::ReturnValue, DateTime::Event::ICal, DateTime::Event::Recurrence, Params::Validate, Text::vFile::asData).
-
-The Log::Log4perl module should be optional, but can be of great help with logging when problems occur.

 Actual mail sending requires the Net::SMTP and Net::Domain Perl modules,

@@ -138,6 +137,7 @@
 See also:
 - [Meqaris INI file]
 - [Mail server configuration]
+- [CalDAV configuration]

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Sun, 29 Jan 2023 20:19:00 -0000

--- v9
+++ v10
@@ -61,7 +61,7 @@
 ```

 ***NOTE for older database versions***
-On PostgreSQL versions older than 13.9 (12.4 probably fixes this, but I'm unsure), you may need to perform one additional step before running Meqaris - install the `btree_gist` extension manually in the Meqaris database you've just created. Meqaris cannot do this, because only the database superuser (usually `postgres`) is allowed to do it.
+On PostgreSQL versions older than 13.0, you may need to perform one additional step before running Meqaris - install the `btree_gist` extension manually in the Meqaris database you've just created. Meqaris cannot do this, because only the database superuser (usually `postgres`) is allowed to do it.
 Substitute the hostname and port number where necessary and run this command to install the extension:
 ```bash
    psql -U postgres -h <hostname> -p <port number=""> -d meqaris -c 'create extension if not exists btree_gist;'
</port></hostname>

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Sun, 29 Jan 2023 20:15:05 -0000

--- v8
+++ v9
@@ -58,6 +58,13 @@
 On PostgreSQL, login to the system as the database user `postgres` and run:
 ```bash
    createdb -O meqaris meqaris
+```
+
+***NOTE for older database versions***
+On PostgreSQL versions older than 13.9 (12.4 probably fixes this, but I'm unsure), you may need to perform one additional step before running Meqaris - install the `btree_gist` extension manually in the Meqaris database you've just created. Meqaris cannot do this, because only the database superuser (usually `postgres`) is allowed to do it.
+Substitute the hostname and port number where necessary and run this command to install the extension:
+```bash
+   psql -U postgres -h <hostname> -p <port number=""> -d meqaris -c 'create extension if not exists btree_gist;'
 ```

 Database access rules must be created within the database server, unless you wish to leave the default rules.
</port></hostname>

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Sat, 16 Jul 2022 21:32:49 -0000

--- v7
+++ v8
@@ -60,7 +60,7 @@
    createdb -O meqaris meqaris
 ```

-Database access rules must be created within the database server unless you wish to leave the default rules.
+Database access rules must be created within the database server, unless you wish to leave the default rules.
 On PostgreSQL, you would do (as the database user `postgres` or `root`):
 ```bash
     cp /var/lib/pgsql/data/pg_hba.conf /var/lib/pgsql/data/pg_hba.conf-backup
@@ -105,7 +105,7 @@
 - Copy `bin/meqaris` to `BINDIR`
 - Edit `config/meqaris.ini` to match your directories and database settings (see below)
 - Edit `config/meqaris-log4perl.cfg` and choose your log file's location
-- Copy the whole `sql` directory and the `config/meqaris-log4perl.cfg` file to `DATADIR/meqaris`. The `DATADIR/meqaris` directory must be writeable for your mail server
+- Copy the whole `sql` directory and the `config/meqaris-log4perl.cfg` file to `DATADIR/meqaris`. The `DATADIR/meqaris` directory must be writable for your mail server
 - Copy `config/meqaris.ini` to `CONFDIR`
 - Copy `config/meqaris.logrotate` to a directory expected to contain logrotate configuration files (like `CONFDIR/logrotate.d`)
 - Copy the manual to a place suitable for documentation, like `/usr/share/doc`
@@ -121,7 +121,7 @@
 ```
 All the above directories and their parent directories must be reachable by your mail server.

-The log file (`/var/log/meqaris.log` by default) must be created writeable for your mail server. Alternatively, the directory which would contain it must be writeable by your mail server.
+The log file (`/var/log/meqaris.log` by default) must be created writable for your mail server. Alternatively, the directory which would contain it must be writable by your mail server.

 The necessary database structures will be automatically created by the application itself while operating, but to avoid concurrent database upgrades (all of which except one would fail), it is recommended to run the database installation/upgrade scripts manually by calling
 ```bash
@@ -153,7 +153,7 @@
 ```bash
    dropuser meqaris
 ```
-Alternatively, if you have the `make` program and some common Linux utilities, you can run `make uninstall`, passing the the same directories that were used during installation. Examples:
+Alternatively, if you have the `make` program and some common Linux utilities, you can run `make uninstall`, passing the same directories that were used during installation. Examples:

 ```bash
    make uninstall BINDIR=/usr/bin CONFDIR=/etc DATADIR=/var/lib DOCDIR=/usr/share/doc MANDIR=/usr/share/man

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Fri, 15 Jul 2022 13:54:21 -0000

--- v6
+++ v7
@@ -23,7 +23,7 @@
 A [PostgreSQL](https://www.postgresql.org/) database, version 9.2 or newer, must be running.
 On a Linux system, you would do one of:

-- login to the system as the database user `postgres` (you can do `su - postgres` as `root` to login to that account on Linux) and run:
+- login to the system as the database user `postgres` (you can do `su - postgres` as `root` to log in to that account on Linux) and run:
 ```bash
     pg_ctl start
 ```

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Tue, 31 May 2022 17:21:37 -0000

--- v5
+++ v6
@@ -153,7 +153,7 @@
 ```bash
    dropuser meqaris
 ```
-Alternatively, if you have the 'make' program and some common Linux utilities, you can run 'make uninstall', passing the the same directories that were used during installation. Examples:
+Alternatively, if you have the `make` program and some common Linux utilities, you can run `make uninstall`, passing the the same directories that were used during installation. Examples:

 ```bash
    make uninstall BINDIR=/usr/bin CONFDIR=/etc DATADIR=/var/lib DOCDIR=/usr/share/doc MANDIR=/usr/share/man

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Tue, 31 May 2022 17:20:37 -0000

--- v4
+++ v5
@@ -1,6 +1,6 @@
 ## Initial steps - most are one-time ##

-Install [Perl](<https: www.perl.org="">), along with the following modules (available from [CPAN / metacpan](https://metacpan.org/)):
+Install [Perl](https://www.perl.org/), along with the following modules (available from [CPAN / metacpan](https://metacpan.org/)):

 - Config::Simple,
 - Data::ICal,
@@ -9,6 +9,7 @@
 - DateTime::TimeZone::ICal,
 - DBD::Pg,
 - DBI,
+- Fcntl,
 - Getopt::Long,
 - Log::Log4perl,
 - MIME::Base64,
@@ -100,19 +101,23 @@
     - `CONFDIR` - a directory for the Meqaris' configuration (like `/etc`),
     - `DATADIR` - a directory for the Meqaris' data files (like `/var/lib`). The data files will be installed in `DATADIR/meqaris`,
     - `DOCDIR` - a directory for the Meqaris' documentation (like `/usr/share/doc`). The documentation will be installed in `DOCDIR/meqaris`,
+    - `MANDIR`- a directory for the manual files (like `/usr/share/man`). The manual page will be installed in `MANDIR/man1`.
 - Copy `bin/meqaris` to `BINDIR`
 - Edit `config/meqaris.ini` to match your directories and database settings (see below)
 - Edit `config/meqaris-log4perl.cfg` and choose your log file's location
-- Copy the whole `sql` directory and the `config/meqaris-log4perl.cfg` file to `DATADIR/meqaris`. The `DATADIR/meqaris` directory must be writeable for your mail server.
+- Copy the whole `sql` directory and the `config/meqaris-log4perl.cfg` file to `DATADIR/meqaris`. The `DATADIR/meqaris` directory must be writeable for your mail server
 - Copy `config/meqaris.ini` to `CONFDIR`
+- Copy `config/meqaris.logrotate` to a directory expected to contain logrotate configuration files (like `CONFDIR/logrotate.d`)
+- Copy the manual to a place suitable for documentation, like `/usr/share/doc`

 Alternatively, if you have the `make` program and some common Linux utilities, you can run `make install`, passing the target directories.. Examples:
 ```bash
-   make install BINDIR=/usr/bin CONFDIR=/etc DATADIR=/var/lib DOCDIR=/usr/share/doc
+   make install BINDIR=/usr/bin CONFDIR=/etc DATADIR=/var/lib DOCDIR=/usr/share/doc MANDIR=/usr/share/man
    make install BINDIR=$HOME/tools/meqaris/bin \
        CONFDIR=$HOME/tools/meqaris/etc \
        DATADIR=$HOME/tools/meqaris/data \
-       DOCDIR=$HOME/tools/meqaris/doc
+       DOCDIR=$HOME/tools/meqaris/doc \
+       MANDIR=$HOME/tools/meqaris/man
 ```
 All the above directories and their parent directories must be reachable by your mail server.

@@ -136,8 +141,10 @@

 - remove the `meqaris` script from the directory you installed it to,
 - remove the `meqaris.ini` file from the directory you installed it to
+- remove the meqaris logrotate configuration file from the directory you installed it to
 - remove the `meqaris-log4perl.cfg` file from the directory you installed it to
 - remove the application SQL file(s) from the directory you installed them to
+- remove the documentation file(s) from the directories you installed them to
 - delete the application's database - run as `postgres`:
 ```bash
    dropdb meqaris
@@ -146,3 +153,13 @@
 ```bash
    dropuser meqaris
 ```
+Alternatively, if you have the 'make' program and some common Linux utilities, you can run 'make uninstall', passing the the same directories that were used during installation. Examples:
+
+```bash
+   make uninstall BINDIR=/usr/bin CONFDIR=/etc DATADIR=/var/lib DOCDIR=/usr/share/doc MANDIR=/usr/share/man
+   make uninstall BINDIR=$HOME/tools/meqaris/bin \
+       CONFDIR=$HOME/tools/meqaris/etc \
+       DATADIR=$HOME/tools/meqaris/data \
+       DOCDIR=$HOME/tools/meqaris/doc \
+       MANDIR=$HOME/tools/meqaris/man
+```
</https:>

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Mon, 23 May 2022 20:21:50 -0000

--- v3
+++ v4
@@ -118,7 +118,7 @@

 The log file (`/var/log/meqaris.log` by default) must be created writeable for your mail server. Alternatively, the directory which would contain it must be writeable by your mail server.

-The necessary database structures will be created by the application itself while operating. You can also choose to run the database installation/upgrade scripts yourself by running
+The necessary database structures will be automatically created by the application itself while operating, but to avoid concurrent database upgrades (all of which except one would fail), it is recommended to run the database installation/upgrade scripts manually by calling
 ```bash
     meqaris --upgrade-db
 ```

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Mon, 23 May 2022 20:01:41 -0000

--- v2
+++ v3
@@ -96,10 +96,10 @@
 To install:

 - Choose 4 paths:
-    - `BINDIR` - a directory for the Meqaris program (like `/usr/bin`)
-    - `CONFDIR` - a directory for the Meqaris' configuration (like `/etc`)
-    - `DATADIR` - a directory for the Meqaris' data files (like `/var/lib`)
-    - `DOCDIR` - a directory for the Meqaris' documentation (like `/usr/share/doc/meqaris`)
+    - `BINDIR` - a directory for the Meqaris program (like `/usr/bin`),
+    - `CONFDIR` - a directory for the Meqaris' configuration (like `/etc`),
+    - `DATADIR` - a directory for the Meqaris' data files (like `/var/lib`). The data files will be installed in `DATADIR/meqaris`,
+    - `DOCDIR` - a directory for the Meqaris' documentation (like `/usr/share/doc`). The documentation will be installed in `DOCDIR/meqaris`,
 - Copy `bin/meqaris` to `BINDIR`
 - Edit `config/meqaris.ini` to match your directories and database settings (see below)
 - Edit `config/meqaris-log4perl.cfg` and choose your log file's location

Installing modified by Bogdan Drozdowski

Bogdan Drozdowski — Fri, 20 May 2022 10:03:59 -0000

--- v1
+++ v2
@@ -10,11 +10,12 @@
 - DBD::Pg,
 - DBI,
 - Getopt::Long,
+- Log::Log4perl,
 - MIME::Base64,
 - MIME::Parser,
  with all their dependencies (the list may include but not be limited to: Module::Install, Test::NoWarnings, Test::LongString, Class::Accessor, DateTime, DateTime::TimeZone, Moo, Set::Infinite, Test::Requires, Class::Accessor-Chained, Class::ReturnValue, DateTime::Event::ICal, DateTime::Event::Recurrence, Params::Validate, Text::vFile::asData).

-The Log::Log4perl module is optional, but can be of great help with logging when problems occur.
+The Log::Log4perl module should be optional, but can be of great help with logging when problems occur.

 Actual mail sending requires the Net::SMTP and Net::Domain Perl modules,

@@ -111,7 +112,7 @@
    make install BINDIR=$HOME/tools/meqaris/bin \
        CONFDIR=$HOME/tools/meqaris/etc \
        DATADIR=$HOME/tools/meqaris/data \
-       DOCDIR=$HOME/tools/meqaris/doc

DOCDIR=$HOME/tools/meqaris/doc
```
All the above directories and their parent directories must be reachable by your mail server.