"Fossies" - the Fresh Open Source Software Archive

Member "redmine-4.1.1/doc/INSTALL" (6 Apr 2020, 3794 Bytes) of package /linux/www/redmine-4.1.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "INSTALL": 4.1.0_vs_4.1.1.

    1 == Redmine installation
    2 
    3 Redmine - project management software
    4 Copyright (C) 2006-2019  Jean-Philippe Lang
    5 http://www.redmine.org/
    6 
    7 
    8 == Requirements
    9 
   10 * Ruby 2.3, 2.4, 2.5, 2.6
   11 * RubyGems
   12 * Bundler >= 1.5.0
   13 
   14 * A database:
   15   * MySQL (tested with MySQL 5.7)
   16   * PostgreSQL (tested with PostgreSQL 9.5)
   17   * SQLite3 (tested with SQLite 3.11)
   18   * SQLServer (tested with SQLServer 2012)
   19 
   20 Optional:
   21 * SCM binaries (e.g. svn, git...), for repository browsing (must be
   22   available in PATH)
   23 * ImageMagick (to enable Gantt export to png images)
   24 
   25 == Installation
   26 
   27 1. Uncompress the program archive
   28 
   29 2. Create an empty utf8 encoded database: "redmine" for example
   30 
   31 3. Configure the database parameters in config/database.yml
   32    for the "production" environment (default database is MySQL)
   33 
   34 4. Install the required gems by running:
   35      bundle install --without development test
   36 
   37    If ImageMagick is not installed on your system, you should skip the
   38    installation of the rmagick gem using:
   39      bundle install --without development test rmagick
   40 
   41    Only the gems that are needed by the adapters you've specified in your
   42    database configuration file are actually installed (eg. if your
   43    config/database.yml uses the 'mysql2' adapter, then only the mysql2 gem
   44    will be installed). Don't forget to re-run `bundle install` when you
   45    change config/database.yml for using other database adapters.
   46 
   47    If you need to load some gems that are not required by Redmine core
   48    (eg. fcgi), you can create a file named Gemfile.local at the root of
   49    your redmine directory.
   50    It will be loaded automatically when running `bundle install`.
   51 
   52 5. Generate a session store secret
   53    
   54    Redmine stores session data in cookies by default, which requires
   55    a secret to be generated. Under the application main directory run:
   56      bundle exec rake generate_secret_token
   57 
   58    Alternatively, you can store this secret in config/secrets.yml:
   59    http://guides.rubyonrails.org/upgrading_ruby_on_rails.html#config-secrets-yml
   60 
   61 6. Create the database structure
   62    
   63    Under the application main directory run:
   64      bundle exec rake db:migrate RAILS_ENV="production"
   65    
   66    It will create all the tables and an administrator account.
   67 
   68 7. Setting up permissions (Windows users have to skip this section)
   69    
   70    The user who runs Redmine must have write permission on the following
   71    subdirectories: files, log, tmp & public/plugin_assets.
   72    
   73    Assuming you run Redmine with a user named "redmine":
   74      sudo chown -R redmine:redmine files log tmp public/plugin_assets
   75      sudo chmod -R 755 files log tmp public/plugin_assets
   76 
   77 8. Test the installation by running the Puma web server
   78    
   79    Under the main application directory run:
   80      ruby bin/rails server -e production
   81    
   82    Once Puma has started, point your browser to http://localhost:3000/
   83    You should now see the application welcome page.
   84 
   85 9. Use the default administrator account to log in:
   86    login: admin
   87    password: admin
   88    
   89    Go to "Administration" to load the default configuration data (roles,
   90    trackers, statuses, workflow) and to adjust the application settings
   91 
   92 == SMTP server Configuration
   93 
   94 Copy config/configuration.yml.example to config/configuration.yml and
   95 edit this file to adjust your SMTP settings.
   96 Do not forget to restart the application after any change to this file.
   97 
   98 Please do not enter your SMTP settings in environment.rb.
   99 
  100 == References
  101 
  102 * http://www.redmine.org/wiki/redmine/RedmineInstall
  103 * http://www.redmine.org/wiki/redmine/EmailConfiguration
  104 * http://www.redmine.org/wiki/redmine/RedmineSettings
  105 * http://www.redmine.org/wiki/redmine/RedmineRepositories
  106 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
  107 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
  108 * http://www.redmine.org/wiki/redmine/RedmineLDAP