Update README.md
changed from rdoc to md
This commit is contained in:
parent
05e25cc522
commit
35d7ef072e
1 changed files with 20 additions and 6 deletions
26
README.md
26
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
|
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
|
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
|
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!
|
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
|
1. Install Zammad on your system
|
||||||
|
|
||||||
|
```
|
||||||
root@shell> cd /opt/
|
root@shell> cd /opt/
|
||||||
root@shell> tar -xzvf zammad-1.0.1.tar.gz
|
root@shell> tar -xzvf zammad-1.0.1.tar.gz
|
||||||
root@shell> useradd zammad
|
root@shell> useradd zammad
|
||||||
zammad@shell> su - zammad
|
zammad@shell> su - zammad
|
||||||
|
```
|
||||||
|
|
||||||
2. Install all dependencies
|
2. Install all dependencies
|
||||||
|
|
||||||
|
```
|
||||||
zammad@shell> cd zammad
|
zammad@shell> cd zammad
|
||||||
zammad@shell> sudo gem install rails
|
zammad@shell> sudo gem install rails
|
||||||
zammad@shell> vi Gemfile # enable libv8, execjs and therubyracer if needed!
|
zammad@shell> vi Gemfile # enable libv8, execjs and therubyracer if needed!
|
||||||
zammad@shell> sudo bundle install
|
zammad@shell> sudo bundle install
|
||||||
|
```
|
||||||
|
|
||||||
3. Configure your databases (if needed)
|
3. Configure your databases (if needed)
|
||||||
|
|
||||||
|
```
|
||||||
zammad@shell> vi config/database.yml
|
zammad@shell> vi config/database.yml
|
||||||
|
````
|
||||||
|
|
||||||
4. Initialize your database
|
4. Initialize your database
|
||||||
|
|
||||||
|
```
|
||||||
zammad@shell> export RAILS_ENV=production
|
zammad@shell> export RAILS_ENV=production
|
||||||
zammad@shell> rake db:migrate
|
zammad@shell> rake db:migrate
|
||||||
zammad@shell> rake db:seed
|
zammad@shell> rake db:seed
|
||||||
|
```
|
||||||
|
|
||||||
5. Change directory to <tt>zammad</tt> (if needed) and start the web server:
|
5. Change directory to zammad</tt> (if needed) and start the web server:
|
||||||
|
|
||||||
|
```
|
||||||
zammad@shell> rake assets:precompile
|
zammad@shell> rake assets:precompile
|
||||||
zammad@shell> rails server
|
zammad@shell> rails server
|
||||||
|
```
|
||||||
|
|
||||||
6. Go to http://localhost:3000/#getting_started and you'll see:
|
6. Go to http://localhost:3000/#getting_started and you'll see:
|
||||||
"Welcome to Zammad!", there you need to create your admin
|
"Welcome to Zammad!", there you need to create your admin
|
||||||
|
|
Loading…
Reference in a new issue