Install Instructions

This page, is a template which can be used for document install procedure in wiki pages.

Contents

  1. This page Goals (& arguments)
    1. Ways to improve this page
  2. Known Issues

<---- TEMPLATE START HERE ---- > Unused sections are suggested to be kept under comment. In future you might need it. Example: 

        {{{
        #!comment
        1. '''Check''' dependencies:
           i. none required
        }}}        
        [[BR]][[BR]]
  1. [sudo], when used, is optional case you already have enough authority to modify your server.

  1. Check dependencies:
    1. none required

  2. Install component (plugin or macro):
    • with easy_install, globally: 
             $ [sudo] easy_install https://trac-hacks.org/svn/YOUR-SELECTED-PLUGIN/0.VV
      • You might be required to select a specific tag, branch. Defaults to select from trunk
    • Manually:
      1. Download ...
      2. Build egg if not previously available ....
      3. Place the egg file at....

  3. Enable this component as follows:
    • by updating trac.ini file under appropriate configuration section; 
             [components]
       ...
       YOUR-SELECTED-PLUGIN.* = enabled
       ...
    • or accessing your Admin panel (under selected Trac environment ..admin/general/plugins ).

  4. Configure Trac environment as follows:
    • by updating trac.ini file under appropriate configuration section: 
           [YOUR-SELECTED-PLUGIN-SECTION]
     <argument> = <value>
     <argument> = <value>
    • or accessing your Admin panel (under selected Trac environment ..admin/general/plugins ).

  5. Restart web server:
    • Apache on Ubuntu, example command line: 
             $ [sudo] /etc/init.d/apache2 restart


  6. Test if this component is working properly (main environment and secondary ones if also exists).
    1. If this component is installed correctly, then the configuration you have made should reflect on tickets.
    2. If this component is installed correctly, then the example shown in the #Usage section should be also displayed on the WikiMacros#.... page.
    3. ....

<---- TEMPLATE ENDS HERE ---- >

This page Goals (& arguments)

  1. keep install instruction at only one place
    • [+] different plugins / macros can refer to this page
    • [+] a standard procedure
    • [+] easy user's life
    • [-] will be possible to adopt a single set of installation instruction?
    • [-] redoing TracPlugins??
      • [-] this have to be avoided (otherwise fails with this first goal)
      • [+] TracPlugins have generic instructions and should be kept as a global reference
      • [+] This should focus on a step by step one shot installation guideline, and must lower the entry barrier / tool adoption
  2. standardize or reduce variance of install instructions
    • [+] turn user's life easier
    • [+] reduce mistakes
    • [+] easy maintenance (for plugin maintainer, user and I.T. staff)
    • [+] guideline to plugin developers

Ways to improve this page

Brainstorm:

  • Q: How to allow a page to pass parameters to, full fill automatically YOUR-SELECTED-PLUGIN ?
  • Q: How to reuse sections on install instructions? (for easy and widespread maintenance)
    1. use of TracSubPagesMacro

Known Issues