Mercurial > p > roundup > code

comparison doc/installation.txt @ 6163:c2fd254c9257

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Doc updates/indexing. doc/admin_guide.txt, doc/customizing.txt, doc/features.txt, doc/installation.txt, doc/mysql.txt, doc/postgresql.txt: adding index entries doc/customizing.txt: reference schema changes later in document in addition to wiki. website/www/contents.txt: make wiki url https:.... Remove indices/tables as they don't show up in web interface. Put docs/announcement.txt into hidden toctree to silence warning from sphinx. Announcement.txt is referenced from index.txt so can't silence by adding to conf.py exclude_patern. website/www/index.txt: mention security and other improvements in jinja2 templates. website/www/conf.py: get rid of all warning by using exclude_patterns to ignore docs that aren't included. Remove exclude_trees using exclude_pattern instead. Make html_add_permalinks value acceptable so no warning reported. website/www/_static/style.css, website/www/_templtes/layout.html: add prev/next/index links for all doc pages.
author John Rouillard <rouilj@ieee.org>
date Wed, 13 May 2020 00:40:14 -0400
parents 55c56ceacb8e
children de9d602c8ce6
comparison
equal deleted inserted replaced
6162:9cfdbfc6d8ed 6163:c2fd254c9257
329 The minimal template has the minimum setup required for a tracker 329 The minimal template has the minimum setup required for a tracker
330 installation. That is, it has the configuration files, defines a user database 330 installation. That is, it has the configuration files, defines a user database
331 and the basic HTML interface to that. It's a completely clean slate for you to 331 and the basic HTML interface to that. It's a completely clean slate for you to
332 create your tracker on. 332 create your tracker on.
333 333
334 .. index:: database; choosing your backend
334 335
335 Choosing Your Backend 336 Choosing Your Backend
336 --------------------- 337 ---------------------
337 338
338 The actual storage of Roundup tracker information is handled by backends. 339 The actual storage of Roundup tracker information is handled by backends.
394 395
395 You may need to give the web server user permission to access the tracker home 396 You may need to give the web server user permission to access the tracker home
396 - see the `UNIX environment steps`_ for information. You may also need to 397 - see the `UNIX environment steps`_ for information. You may also need to
397 configure your system in some way - see `platform-specific notes`_. 398 configure your system in some way - see `platform-specific notes`_.
398 399
400 .. index:: pair: web interface; cgi
399 401
400 Web Server cgi-bin 402 Web Server cgi-bin
401 ~~~~~~~~~~~~~~~~~~ 403 ~~~~~~~~~~~~~~~~~~
402 404
403 A benefit of using the cgi-bin approach is that it's the easiest way to 405 A benefit of using the cgi-bin approach is that it's the easiest way to
487 489
488 Now loading the (sub-)domain in a browser should load the tracker web 490 Now loading the (sub-)domain in a browser should load the tracker web
489 interface. If you get a "500" error then enable the "cgitb" lines in the 491 interface. If you get a "500" error then enable the "cgitb" lines in the
490 stub to get some debugging information. 492 stub to get some debugging information.
491 493
494 .. index:: pair: web interface; stand alone server
492 495
493 Stand-alone Web Server 496 Stand-alone Web Server
494 ~~~~~~~~~~~~~~~~~~~~~~ 497 ~~~~~~~~~~~~~~~~~~~~~~
495 498
496 This approach will give you faster response than cgi-bin. You may 499 This approach will give you faster response than cgi-bin. You may
506 509
507 To make the server run in the background, use the "-d" option, specifying the 510 To make the server run in the background, use the "-d" option, specifying the
508 name of a file to write the server process id (pid) to. 511 name of a file to write the server process id (pid) to.
509 512
510 513
514 .. index:: pair: web interface; Zope
515
511 Zope Product - ZRoundup 516 Zope Product - ZRoundup
512 ~~~~~~~~~~~~~~~~~~~~~~~ 517 ~~~~~~~~~~~~~~~~~~~~~~~
513 518
514 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to 519 ZRoundup installs as a regular Zope product. Copy the ZRoundup directory to
515 your Products directory either in INSTANCE_HOME/Products or the Zope 520 your Products directory either in INSTANCE_HOME/Products or the Zope
516 code tree lib/python/Products. 521 code tree lib/python/Products.
517 522
518 When you next (re)start up Zope, you will be able to add a ZRoundup object 523 When you next (re)start up Zope, you will be able to add a ZRoundup object
519 that interfaces to your new tracker. 524 that interfaces to your new tracker.
525
526 .. index:: ! triple: web interface; apache; mod_wsgi
527 ! single: wsgi; apache
520 528
521 Apache HTTP Server with mod_wsgi 529 Apache HTTP Server with mod_wsgi
522 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 530 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
523 531
524 This is a work in progress thanks to Garth Jensen. 532 This is a work in progress thanks to Garth Jensen.
673 681
674 1. From the tracker home directory, bash 682 1. From the tracker home directory, bash
675 ``sudo mod_wsgi-express setup-server wsgi.py --port=80 --user admin --group mytrackergrp --server-root=/etc/mod_wsgi-express-80`` 683 ``sudo mod_wsgi-express setup-server wsgi.py --port=80 --user admin --group mytrackergrp --server-root=/etc/mod_wsgi-express-80``
676 2. Then, run ``sudo /etc/mod_wsgi-express-80/apachectl start`` 684 2. Then, run ``sudo /etc/mod_wsgi-express-80/apachectl start``
677 3. To stop, run ``sudo /etc/mod_wsgi-express-80/apachectl stop`` 685 3. To stop, run ``sudo /etc/mod_wsgi-express-80/apachectl stop``
686
687 .. index:: triple: web interface; apache; mod_python (depricated)
678 688
679 Apache HTTP Server with mod_python 689 Apache HTTP Server with mod_python
680 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 690 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
681 691
682 As of roundup 2.0, mod_python support is deprecated. The apache.py 692 As of roundup 2.0, mod_python support is deprecated. The apache.py
810 serving with SSL. 820 serving with SSL.
811 821
812 WSGI Variations 822 WSGI Variations
813 ~~~~~~~~~~~~~~~ 823 ~~~~~~~~~~~~~~~
814 824
825 .. index:: triple: web interface; apache; mod_wsgi
826 single: wsgi; apache
827
815 Apache Alternate 828 Apache Alternate
816 ^^^^^^^^^^^^^^^^ 829 ^^^^^^^^^^^^^^^^
817 830
818 This method from Thomas Arendsen Hein goes into a bit more detail and 831 This method from Thomas Arendsen Hein goes into a bit more detail and
819 is designed to allow you to run multiple roundup trackers each under 832 is designed to allow you to run multiple roundup trackers each under
912 925
913 One last change is needed. In the tracker's config.ini change the db 926 One last change is needed. In the tracker's config.ini change the db
914 parameter in the [main] section to be /home/roundup-foo/db. This will 927 parameter in the [main] section to be /home/roundup-foo/db. This will
915 put the files and messages in the db directory for the user. 928 put the files and messages in the db directory for the user.
916 929
930 .. index:: pair: web interface; gunicorn
931 single: wsgi; gunicorn
932
917 Gunicorn Installation 933 Gunicorn Installation
918 ^^^^^^^^^^^^^^^^^^^^^ 934 ^^^^^^^^^^^^^^^^^^^^^
919 935
920 To run with gunicorn use pip to install gunicorn. This configuration 936 To run with gunicorn use pip to install gunicorn. This configuration
921 uses a front end web server like nginx, hiawatha, apache configured as 937 uses a front end web server like nginx, hiawatha, apache configured as
940 956
941 SCRIPT_NAME=/tracker gunicorn --bind 127.0.0.1:8917 --timeout=10 wsgi:app 957 SCRIPT_NAME=/tracker gunicorn --bind 127.0.0.1:8917 --timeout=10 wsgi:app
942 958
943 this runs roundup at port 8917 on the loopback interface. You should 959 this runs roundup at port 8917 on the loopback interface. You should
944 configure the reverse proxy to talk to 127.0.0.1 at port 8917. 960 configure the reverse proxy to talk to 127.0.0.1 at port 8917.
961
962 .. index:: pair: web interface; uWSGI
963 single: wsgi; uWSGI
945 964
946 uWSGI Installation 965 uWSGI Installation
947 ^^^^^^^^^^^^^^^^^^ 966 ^^^^^^^^^^^^^^^^^^
948 967
949 For a basic roundup install using uWSGI behind a front end server, 968 For a basic roundup install using uWSGI behind a front end server,
Roundup Issue Tracker: http://roundup-tracker.org/