Skip to content

Commit

Permalink
Updated URLs to new URLs and fixed some styling
Browse files Browse the repository at this point in the history
Now with more Note and Warning windows.
  • Loading branch information
MrGeneration committed Dec 19, 2018
1 parent 54b3521 commit 5ddb3bc
Show file tree
Hide file tree
Showing 15 changed files with 52 additions and 47 deletions.
4 changes: 2 additions & 2 deletions api-intro.rst
Expand Up @@ -112,7 +112,7 @@ Search for tickets (for tickets with state new and open )::

curl -u test@zammad.com:test123 'https://xxx.zammad.com/api/v1/tickets/search?query=state:new%20OR%20state:open&limit=10&expand=true'

For more search examples see https://docs.zammad.org/en/latest/general-search.html
For more search examples regarding searching, please see `this page <https://user-docs.zammad.org/en/latest/advanced/search.html>`_ .

Create an new user::

Expand Down Expand Up @@ -172,7 +172,7 @@ Example::
Response Format (expanded)
==========================

If you want to retrieve expanded information for a request (e. g. the organization attribute), you just need to add an ```expand=true``` to the request URL.
If you want to retrieve expanded information for a request (e. g. the organization attribute), you just need to add an ``expand=true`` to the request URL.

Example::

Expand Down
2 changes: 1 addition & 1 deletion contributing-install-docker.rst
Expand Up @@ -6,7 +6,7 @@ Our Docker image is a **single container** based application designed to have Za

Please note that this is a non persistent storage container and **all Zammad data is lost** when you're stopping the container.

If you like to run Docker in production environment try our Docker-compose version: https://docs.zammad.org/en/latest/install-docker-compose.html
If you like to run Docker in production environment try our Docker-compose version: :ref:`install_docker_compose` .

Your Docker environment needs to be up and running.

Expand Down
2 changes: 1 addition & 1 deletion getting-started-first-steps.rst
Expand Up @@ -5,7 +5,7 @@ After installing Zammad, open http://localhost:3000 with your browser and follow

You can find further information about Zammad's configuration on our Admin-Documentation_ (for Zammad-Administration within the WebApp).

.. _Admin-Documentation: https://zammad-admin-documentation.readthedocs.io/en/latest/index.html
.. _Admin-Documentation: https://admin-docs.zammad.org/

Basically you need to do the following things:

Expand Down
6 changes: 3 additions & 3 deletions index.rst
Expand Up @@ -4,9 +4,9 @@ The Zammad documentation consists of three parts:

- Zammad system installation and configuration (this documentation)

- Zammad administration (http://zammad-admin-documentation.readthedocs.io/en/latest/index.html)
- Zammad administration (https://admin-docs.zammad.org)

- Zammad user documentation (http://zammad-user-documentation.readthedocs.io/en/latest/index.html)
- Zammad user documentation (https://user-docs.zammad.org)

This system documentation for Zammad is organized into a couple of sections:

Expand Down Expand Up @@ -82,7 +82,7 @@ This system documentation for Zammad is organized into a couple of sections:
:glob:
:caption: Administration via webfrontend

Admin-Documentation <https://zammad-admin-documentation.readthedocs.io/>
Admin-Documentation <https://admin-docs.zammad.org/>


.. _admin-console:
Expand Down
26 changes: 9 additions & 17 deletions install-centos.rst
@@ -1,31 +1,23 @@
Install on CentOS via RPM
*************************

Currently we support RHEL7 & CentOS7.
.. Note:: Currently we support RHEL7 & CentOS7.

Setup Elasticsearch
-------------------

Elasticsearch is a dependency of Zammad and needs to be provided before installing Zammad.
Please take a look at the following page: :ref:`install_elasticsearch` .

Add Zammad, Elasticsearch & epel-release RPM repos and install RPM
==================================================================

Add Zammad-Repo and Install Zammad
==================================

::

sudo yum -y install epel-release wget
sudo wget -O /etc/yum.repos.d/zammad.repo https://dl.packager.io/srv/zammad/zammad/stable/installer/el/7.repo

echo "[elasticsearch-5.x]
name=Elasticsearch repository for 5.x packages
baseurl=https://artifacts.elastic.co/packages/5.x/yum
gpgcheck=1
gpgkey=https://artifacts.elastic.co/GPG-KEY-elasticsearch
enabled=1
autorefresh=1
type=rpm-md" | sudo tee /etc/yum.repos.d/elasticsearch.repo

sudo yum -y install java elasticsearch
sudo systemctl daemon-reload
sudo systemctl enable elasticsearch
sudo systemctl start elasticsearch

sudo yum -y install zammad


Expand Down
9 changes: 5 additions & 4 deletions install-debian.rst
@@ -1,7 +1,7 @@
Install on Debian via DEB
*************************

Currently we support Debian 8 and 9
.. Note:: Currently we support Debian 8 and 9

Prerequisites
=============
Expand All @@ -12,7 +12,8 @@ Be sure to use an UTF-8 locale or PostgreSQL will not install.
Setup Elasticsearch
-------------------

https://docs.zammad.org/en/latest/install-elasticsearch.html
Elasticsearch is a dependency of Zammad and needs to be provided before installing Zammad.
Please take a look at the following page: :ref:`install_elasticsearch` .


Check locale
Expand Down Expand Up @@ -72,13 +73,13 @@ Go to http://localhost and you'll see:


Change your webserver configuration (non localhost connections):
=================
================================================================

Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.

nginx
--------
-----

*/etc/nginx/sites-enabled/zammad.conf*

Expand Down
4 changes: 4 additions & 0 deletions install-docker-compose.rst
@@ -1,6 +1,10 @@
.. _install_docker_compose:

Install with Docker-Compose
***************************

.. Warning:: We currently do not support Docker environments in productive use.

Docker is a container-based software framework for automating deployment of applications. Compose is a tool for defining and running multi-container Docker applications.
This repo is meant to be the starting point for somebody who likes to use dockerized multi-container Zammad in production.
The Zammad Docker image uses the stable branch of Zammad's Git repo.
Expand Down
6 changes: 4 additions & 2 deletions install-elasticsearch.rst
@@ -1,5 +1,7 @@
.. _install_elasticsearch:

Set up Elasticsearch
********************
====================

We use Elasticsearch for the awesome search in Zammad.

Expand All @@ -14,7 +16,7 @@ Install Elasticsearch and its Attachment plugin
===============================================

Generic install Elasticsearch 2.4 (mapper-attachments):
++++++++++++++++++++++++++++++++++
+++++++++++++++++++++++++++++++++++++++++++++++++++++++

* Download and install via https://www.elastic.co/downloads/elasticsearch (2.4.x)
* Install the Attachment plugin
Expand Down
3 changes: 2 additions & 1 deletion install-source.rst
Expand Up @@ -4,7 +4,8 @@ Install from source (generic)
Setup Elasticsearch
-------------------

https://docs.zammad.org/en/latest/install-elasticsearch.html
Elasticsearch is a dependency of Zammad and needs to be provided before installing Zammad.
Please take a look at the following page: :ref:`install_elasticsearch` .


1. Install Zammad on your system
Expand Down
14 changes: 9 additions & 5 deletions install-suse.rst
@@ -1,19 +1,23 @@
Install on SUSE via RPM
***********************

Currently we support SLES 12 and OpenSUSE 42.2
.. Note:: Currently we support SLES 12 and OpenSUSE with versions 42.2 and 42.3

.. Warning:: OpenSUSE LEAP 15.0 hasn't been tested yet, but should work as well.


Install dependencies
====================

Setup Elasticsearch
-------------------

https://docs.zammad.org/en/latest/install-elasticsearch.html
Elasticsearch is a dependency of Zammad and needs to be provided before installing Zammad.
Please take a look at the following page: :ref:`install_elasticsearch` .


On SLES12
---------
nginx on SLES12
---------------

::

Expand All @@ -40,7 +44,7 @@ Note: Make sure that the firewall is not blocking port 80 (configure firewall vi


Change your webserver configuration (non localhost connections):
=================
================================================================

Add your fully qualified domain name or public IP to server name directive in your web server configuration and restart your web server.
The installer will give you a hint where Zammad's web server config file is located.
Expand Down
6 changes: 2 additions & 4 deletions install-ubuntu.rst
Expand Up @@ -13,10 +13,8 @@ Be sure to use an UTF-8 locale or PostgreSQL will not install.
Setup Elasticsearch
-------------------

For installing and setting up elasticsearch for Zammad, please refer our guide_ .


.. _guide: https://docs.zammad.org/en/latest/install-elasticsearch.html#ubuntu-16-04-18-04
Elasticsearch is a dependency of Zammad and needs to be provided before installing Zammad.
Please take a look at the following page: :ref:`install_elasticsearch` .


Check locale
Expand Down
2 changes: 1 addition & 1 deletion install-update.rst
Expand Up @@ -4,7 +4,7 @@ Updating Zammad
Source update
=============

**Note: Please backup your Zammad instance before update!**
.. Note:: Please backup your Zammad instance before update!

1. Download Zammad to your system
---------------------------------
Expand Down
4 changes: 2 additions & 2 deletions migration-otrs.rst
Expand Up @@ -4,7 +4,7 @@ from OTRS
Install plugins on OTRS
=======================

**Note: Currently only passwords of OTRS >= 3.3 can be reused in Zammad! Passwords that were stored in another format than the default SHA2 are not possible to use. Users then have to use the password reset procedure.**
.. Note:: Currently only passwords of OTRS >= 3.3 can be reused in Zammad! Passwords that were stored in another format than the default SHA2 are not possible to use. Users then have to use the password reset procedure.

Install Znuny4OTRS-Repo
-----------------------
Expand Down Expand Up @@ -54,7 +54,7 @@ Import via Browser
After installing Zammad, open http://localhost:3000 with your browser and follow the installation wizard.
From there you're able to start the migration from OTRS.

See the Video at http://days.zammad.org/features/migrator
See the Video at `this site <https://days.zammad.org/features/migrator>`_ .


Import via command line
Expand Down
2 changes: 2 additions & 0 deletions prerequisites-hardware.rst
Expand Up @@ -16,3 +16,5 @@ For optimal performance up to 40 agents:
* 4 GB of RAM (+4 GB if you want to run Elasticsearch on the same server)

Of course at the end it depends on acutal load of concurent agents and data traffic.

.. Note:: We can't suggest any disk space recommendations, as this highly depends on how you work. Zammad will always try to recognize the same attachments and store it just once.
9 changes: 5 additions & 4 deletions prerequisites-software.rst
Expand Up @@ -22,12 +22,13 @@ You can choose between the following products:
* MariaDB 10.0+
* PostgreSQL 9.1+

Side note: We tend to recommend PostgreSQL. For the last 10 years we had the best experience with it.
.. Note:: We tend to recommend PostgreSQL. For the last 10 years we had the best experience with it.

Required configuration for MySQL/MariaDB:
.. Warning:: **Required configuration for MySQL/MariaDB:**

* Use UTF8 encoding. utf8mb4 for example will fail.
* Set ``max_allowed_packet`` to a value larger than the default of 4 MB (64 MB+ recommended).

* Use UTF8 encoding. utf8mb4 for example will fail.
* Set ``max_allowed_packet`` to a value larger than the default of 4 MB (64 MB+ recommended).

3. Reverse Proxy
================
Expand Down

0 comments on commit 5ddb3bc

Please sign in to comment.