diff --git a/README.md b/README.md index 7f2318d8a..912e6d18b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -== Welcome to Zammad +Welcome to Zammad +================= Zammad is a web based open source helpdesk/ticket system with many features to manage customer telephone calls and e-mails. It is distributed under the @@ -6,35 +7,48 @@ GNU AFFERO General Public License (AGPL) and tested on Linux, Solaris, AIX, Windows, FreeBSD, OpenBSD and Mac OS 10.x. Do you receive many e-mails and want to answer them with a team of agents? You're going to love Zammad! -== Feature List -* TBD 1 -* TBD 2 -== Getting Started +Getting Started +--------------- 1. Install Zammad on your system + +``` root@shell> cd /opt/ root@shell> tar -xzvf zammad-1.0.1.tar.gz root@shell> useradd zammad zammad@shell> su - zammad +``` 2. Install all dependencies + +``` zammad@shell> cd zammad zammad@shell> sudo gem install rails zammad@shell> vi Gemfile # enable libv8, execjs and therubyracer if needed! zammad@shell> sudo bundle install +``` 3. Configure your databases (if needed) + +``` zammad@shell> vi config/database.yml +```` 4. Initialize your database + +``` zammad@shell> export RAILS_ENV=production zammad@shell> rake db:migrate zammad@shell> rake db:seed +``` -5. Change directory to zammad (if needed) and start the web server: +5. Change directory to zammad (if needed) and start the web server: + +``` zammad@shell> rake assets:precompile zammad@shell> rails server +``` 6. Go to http://localhost:3000/#getting_started and you'll see: "Welcome to Zammad!", there you need to create your admin