README.rdoc 1.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. == Welcome to Zammad
  2. Zammad is a web based open source helpdesk/ticket system with many features
  3. to manage customer telephone calls and e-mails. It is distributed under the
  4. GNU AFFERO General Public License (AGPL) and tested on Linux, Solaris, AIX,
  5. Windows, FreeBSD, OpenBSD and Mac OS 10.x. Do you receive many e-mails and
  6. want to answer them with a team of agents? You're going to love Zammad!
  7. == Feature List
  8. * TBD 1
  9. * TBD 2
  10. == Getting Started
  11. 1. Install Zammad on your system
  12. root@shell> cd /opt/
  13. root@shell> tar -xzvf zammad-1.0.1.tar.gz
  14. root@shell> useradd zammad
  15. zammad@shell> su - zammad
  16. 2. Install all dependencies
  17. zammad@shell> cd zammad
  18. zammad@shell> sudo gem install rails
  19. zammad@shell> vi Gemfile # enable libv8, execjs and therubyracer if needed!
  20. zammad@shell> sudo bundle install
  21. 3. Configure your databases (if needed)
  22. zammad@shell> vi config/database.yml
  23. 4. Initialize your database
  24. zammad@shell> export RAILS_ENV=production
  25. zammad@shell> rake db:migrate
  26. zammad@shell> rake db:seed
  27. 5. Change directory to <tt>zammad</tt> (if needed) and start the web server:
  28. zammad@shell> rake assets:precompile
  29. zammad@shell> rails server
  30. 6. Go to http://localhost:3000/#getting_started and you'll see:
  31. "Welcome to Zammad!", there you need to create your admin
  32. user and you need to invite other agents.
  33. * The Getting Started Guide: http://guides.zammad.org/getting_started.html