wiki:Install

Version 6 (modified by AdrianFritz, 2 years ago) (diff)

Removed WebAdminPlugin as it´s included in Trac since 0.11 version

Install Instructions

This page, by now is a template to be (maybe) used as a reference for hacks wiki pages.

<---- TEMPLATE START HERE ---- >

Installation

  1. Be noticed:
    1. Below instructions should be specific for some O.S. Please, help expanding this instructions.
    2. Broader installation guidelines are made available at TracPlugins
    3. Sections not used, are suggested to be kept under comment. In future you might need it. For example:
      {{{
      #!comment
      1. '''Check''' dependencies:
         i. none required
         * ,,`[sudo]` is optional case you already have enough authority to modify your server.,,[[BR]][[BR]]
      }}}        
      


  2. Check dependencies:
    1. none required
    • [sudo] is optional case you already have enough authority to modify your server.

  3. Install plugin:
    • globally, with easy_install:
      $ [sudo] easy_install https://trac-hacks.org/svn/YOUR-SELECTED-PLUGIN/0.VV
      
      • [sudo] is optional case you already have enough authority to modify your server.
      • 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....
  4. Enable this component by updating trac.ini file as follows:
    • by updating trac.ini file under appropriate configuration section;
      [components]
      ...
      YOUR-SELECTED-PLUGIN.* = enabled
      ...
      
    • or accessing your Admin panel (at your Trac environment ..admin/general/plugins );

  5. Configure 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 (at your Trac environment ..admin/general/plugins );

  6. Restart web server on command line:
    $ [sudo] /etc/init.d/apache2 restart
    
    • [sudo] is optional case you already have enough authority to modify your server.
    • Above example command line is for Apache on Ubuntu.

  7. Test if this component is working properly (main environment and secondary ones if you have).
    1. If this component is installed correctly, the configuration you have made should reflect on tickets.

    2. ....

<---- 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:

  • allow a page to pass parameters to, full fill automatically YOUR-SELECTED-PLUGIN

Known Issues