Mercurial > p > roundup > code

comparison doc/installation.txt @ 7523:f2c588128202

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Clarify support for basic FTS all backends; augment native FTS desc. Link to FTS setup/explanation in admin_guide for SQLite. Add FTS support paragraph with link to admin_guide for PostgreSQL too.
author John Rouillard <rouilj@ieee.org>
date Tue, 04 Jul 2023 23:47:25 -0400
parents bbcdc7c92787
children 6dc0f7afde80
comparison
equal deleted inserted replaced
7522:bbcdc7c92787 7523:f2c588128202
569 569
570 Choosing Your Backend 570 Choosing Your Backend
571 --------------------- 571 ---------------------
572 572
573 The actual storage of Roundup tracker information is handled by backends. 573 The actual storage of Roundup tracker information is handled by backends.
574 There's several to choose from, each with benefits and limitations: 574
575 Roundup supports basic full text search (FTS) for all backends. Some
576 backends support a faster native FTS. Also Roundup supports using
577 whoosh or xapian for FTS.
578
579 There are several backends to choose from, each with benefits and
580 limitations:
575 581
576 ========== =========== ===== ============================== 582 ========== =========== ===== ==============================
577 Name Speed Users Support 583 Name Speed Users Support
578 ========== =========== ===== ============================== 584 ========== =========== ===== ==============================
579 anydbm Slowest Few Always available 585 anydbm Slowest Few Always available
580 sqlite Fastest Few Always available 586 sqlite Fastest Few Always available
581 postgresql Fast Many Needs install/admin (psycopg2_) 587 postgresql Fast Many Needs install/admin (psycopg2_)
582 mysql Fast Many Needs install/admin (MySQLdb_) 588 mysql Fast Many Needs install/admin (MySQLdb_)
601 being bundled with Python 2.5+) 607 being bundled with Python 2.5+)
602 608
603 Installed SQLite should be the latest version available (3.3.8 is known 609 Installed SQLite should be the latest version available (3.3.8 is known
604 to work, 3.1.3 is known to have problems). 610 to work, 3.1.3 is known to have problems).
605 611
606 Roundup supports using sqlite's full text search capability. This 612 Roundup supports using `SQLite's full text search capability
613 <admin_guide.html#sqlite-details>`_. This
607 can improve searching if you are not installing another indexer like 614 can improve searching if you are not installing another indexer like
608 xapian or whoosh. It works best with English text. 615 xapian or whoosh. It works best with English text.
609 **postgresql** 616 **postgresql**
610 Backend for popular RDBMS PostgreSQL. You must read 617 Backend for popular RDBMS PostgreSQL. You must read
611 `doc/postgresql.txt`_ for additional installation steps and 618 `doc/postgresql.txt`_ for additional installation steps and
612 requirements. You must also configure 619 requirements. You must also configure
613 the ``rdbms`` section of your tracker's ``config.ini``. It is recommended 620 the ``rdbms`` section of your tracker's ``config.ini``. It is recommended
614 that you use at least version 2.8 of psycopg2. 621 that you use at least version 2.8 of psycopg2.
622
623 Roundup supports using `postgresql's full text search
624 capability
625 <admin_guide.html#postgresql-info>`_. This
626 can improve searching if you are not installing another indexer like
627 xapian or whoosh. It can be tuned to work with different languages.
615 **mysql** 628 **mysql**
616 Backend for popular RDBMS MySQL. You must read `doc/mysql.txt`_ for 629 Backend for popular RDBMS MySQL. You must read `doc/mysql.txt`_ for
617 additional installation steps and requirements. You must also 630 additional installation steps and requirements. You must also
618 configure the ``rdbms`` section of your tracker's ``config.ini`` 631 configure the ``rdbms`` section of your tracker's ``config.ini``
619 632
Roundup Issue Tracker: http://roundup-tracker.org/