diff --git a/README.md b/README.md index e5738b326..6f35d88d9 100644 --- a/README.md +++ b/README.md @@ -9,50 +9,8 @@ twitter, chat and e-mails. It is distributed under the GNU AFFERO General Public You're going to love Zammad! -Getting Started ---------------- +Install & Getting Started +------------------------- -1. Install Zammad on your system -``` - root@shell> cd /opt/ - root@shell> tar -xzf zammad-1.0.1.tar.gz - root@shell> useradd zammad - zammad@shell> su - zammad -``` +Have a look @ the Zammad documetnation @ https://zammad.org/documentation -2. Install all dependencies -``` - zammad@shell> cd zammad - zammad@shell> gem install bundler - - # For PostgreSQL (note, the option says "without ... mysql") - zammad@shell> bundle install --without test development mysql - - # For MySQL (note, the option says "without ... postgres") - zammad@shell> bundle install --without test development postgres -``` - -3. Configure your databases -``` - zammad@shell> cp config/database.yml.dist config/database.yml - zammad@shell> vi config/database.yml -``` - -4. Initialize your database -``` - zammad@shell> export RAILS_ENV=production - zammad@shell> rake db:create - zammad@shell> rake db:migrate - zammad@shell> rake db:seed -``` - -5. Change directory to zammad (if needed) and start the web server: -``` - zammad@shell> rake assets:precompile - zammad@shell> rails s -p 3000 # application web server - zammad@shell> script/websocket-server.rb start # non blocking websocket server - zammad@shell> script/scheduler.rb start # generate overviews on demand, just send changed data to browser -``` - -6. Go to http://localhost:3000/#getting_started and you'll see: - "Welcome to Zammad!", there you need to create your admin user and you need to invite other agents. diff --git a/README_Install_Debian_Ubuntu.md b/README_Install_Debian_Ubuntu.md deleted file mode 100644 index 03cb304c3..000000000 --- a/README_Install_Debian_Ubuntu.md +++ /dev/null @@ -1,55 +0,0 @@ -# Installation on Debian 7, 8 / Ubuntu 16.04 Server -## With Nginx & MySQL - -### Prerequisites -* apt-get install curl git-core patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev sqlite3 libsqlite3-dev autotools-dev libxslt1-dev libyaml-0-2 autoconf automake libreadline6-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev pkg-config libffi-dev libmysqlclient-dev mysql-server nginx gawk - -### Add User -* useradd zammad -m -d /opt/zammad -s /bin/bash -* echo "export RAILS_ENV=production" >> /opt/zammad/.bashrc - -### Create MySQL User zammad (for Debian: upgrade MySQL to v5.6+ before, see: http://dev.mysql.com/downloads/repo/apt/) -* mysql --defaults-extra-file=/etc/mysql/debian.cnf -e "CREATE USER 'zammad'@'localhost' IDENTIFIED BY 'Your_Pass_Word!'; GRANT ALL PRIVILEGES ON zammad_prod.* TO 'zammad'@'localhost'; FLUSH PRIVILEGES;" - -### Get Zammad -* su zammad -* cd ~ -* wget https://ftp.zammad.com/zammad-latest.tar.gz -* tar -xzf zammad-latest.tar.gz -* exit - -### Create Nginx Config -* cp /opt/zammad/contrib/nginx/zammad.conf /etc/nginx/sites-available/zammad.conf -* vi /etc/nginx/sites-available/zammad.conf - * change servername "localhost" to your domain if your're not testing localy -* ln -s /etc/nginx/sites-available/zammad.conf /etc/nginx/sites-enabled/zammad.conf - -### Install Environnment -* su zammad -* cd ~ -* gpg --keyserver hkp://keys.gnupg.net --recv-keys 409B6B1796C275462A1703113804BB82D39DC0E3 -* curl -L https://get.rvm.io | bash -s stable -* source /opt/zammad/.rvm/scripts/rvm -* echo "source /opt/zammad/.rvm/scripts/rvm" >> /opt/zammad/.bashrc -* echo "rvm --default use 2.3.1" >> /opt/zammad/.bashrc -* rvm install 2.3.1 -* gem install bundler - -### Install Zammad -* bundle install --without test development postgres -* cp config/database.yml.dist config/database.yml -* vi config/database.yml - * insert mysql user, pass & host -* rake db:create -* rake db:migrate -* rake db:seed -* rake assets:precompile - -### Start Zammad -* rails s -p 3000 &>> log/zammad.log & -* script/websocket-server.rb start &>> log/zammad.log & -* script/scheduler.rb start &>> log/zammad.log & - -### Restart nginx as root -* exit -* systemctl restart nginx diff --git a/README_Install_Mac.md b/README_Install_Mac.md deleted file mode 100644 index ea62bc5fc..000000000 --- a/README_Install_Mac.md +++ /dev/null @@ -1,57 +0,0 @@ -Installation on Mac OS 10.8 for development -=========================================== - -Prerequisites ------------- -* Install Xcode from the App Store, open it -> Xcode menu > Preferences > Downloads -> install command line tools - -````shell - curl -L https://get.rvm.io | bash -s stable --ruby - source ~/.rvm/scripts/rvm -```` -* start new shell -> ruby -v - -Get Zammad ----------- - -````shell - test -d ~/zammad/ || mkdir ~/zammad - cd ~/zammad/ - curl -L -O https://ftp.zammad.com/zammad-latest.tar.bz2 | tar -xj -```` - -Install Zammad --------------- - -````shell - cd zammad-latest - bundle install - sudo ln -s /usr/local/mysql/lib/libmysqlclient.18.dylib /usr/lib/libmysqlclient.18.dylib # if needed! - rake db:create - rake db:migrate - rake db:seed -```` - -Database connect --------------- - -````shell - cd zammad-latest - cp config/database.yml.dist config/database.yml - rake db:create - rake db:migrate - rake db:seed -```` - -Start Zammad ------------- - -````shell - puma -p 3000 # application web server - script/websocket-server.rb start # non blocking websocket server - script/scheduler.rb start # generate overviews on demand, just send changed data to browser -```` - -Start init page ---------------- -* http://localhost:3000/#getting_started diff --git a/README_elasticsearch.md b/README_elasticsearch.md deleted file mode 100644 index 71e8fa9c5..000000000 --- a/README_elasticsearch.md +++ /dev/null @@ -1,35 +0,0 @@ -# Setup a Elasticsearch - -* Install Elasticsearch - https://www.elastic.co/downloads/elasticsearch (2.4.x) - -* Install attachment plugin - cd /usr/share/elasticsearch - bin/plugin install mapper-attachments - -* Configure elasticsearch - /etc/sysconfig/elasticsearch - ES_HEAP_SIZE=2g - - /etc/elasticsearch/elasticsearch.yml - http.max_content_length: 500mb - -* Configure Zammad - - * rails r "Setting.set('es_url', 'http://127.0.0.1:9200')" - - # optional - es with http basic auth - * rails r "Setting.set('es_user', 'elasticsearch')" - * rails r "Setting.set('es_password', 'zammad')" - - # optional - extra es index name space - * rails r "Setting.set('es_index', Socket.gethostname + '_zammad')" - - # optional - ignore certain file extentions - * rails r "Setting.set('es_attachment_ignore', [ '.png', '.jpg', '.jpeg', '.mpeg', '.mpg', '.mov', '.bin', '.exe', '.box', '.mbox' ] )" - - # optional - max attachment size which is used by es, default is 50 mb - * rails r "Setting.set('es_attachment_max_size_in_mb', 50)" - -* Create elastic search indexes - * rake searchindex:rebuild # drop/create/reload