Skip to content

Commit

Permalink
Fixes #582 - Added recommendation for hosted services
Browse files Browse the repository at this point in the history
---------

Co-authored-by: Martin Gruner <[email protected]>
  • Loading branch information
ralf401 and mgruner committed Nov 29, 2024
1 parent 368dd86 commit 2232441
Show file tree
Hide file tree
Showing 11 changed files with 60 additions and 26 deletions.
37 changes: 27 additions & 10 deletions about/zammad.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,34 @@
Zammad
======

Do you receive many emails and want to answer them with a team of agents?
Are you juggling countless customer inquiries across multiple channels?
Struggling to keep your support team on the same page? Or spending more time
managing your helpdesk than delivering exceptional support to your customers?

You're going to love Zammad_!
Zammad is your Swiss Army knife - a web-based, open-source helpdesk and
customer support platform packed with features to streamline customer
communication across channels like email, chat, telephone and social media.

Zammad is a web based open source helpdesk/customer support system with many
features to manage customer communication via several channels like telephone,
facebook, twitter, chat and emails.
It is distributed under version 3 of the GNU AFFERO General Public License
(GNU AGPLv3).
The Software
------------

The code is open source, and `available on GitHub`_!
The Zammad software is and will stay open source. You can find it on GitHub.
It is licensed under the GNU AGPLv3. The source code is
`available on GitHub <https://github.com/zammad/zammad>`_ and owned by the
`Zammad Foundation <https://zammad-foundation.org/>`_, which is independent
of commercial providers such as Zammad GmbH.

.. _Zammad: https://zammad.org/
.. _available on GitHub: https://github.com/zammad/zammad
The Company - Zammad GmbH
-------------------------

The development of Zammad is carried out by `Zammad GmbH <https://zammad.com/>`_
in collaboration with the community. Even the documentation you are looking at
is mainly written by Zammad employees. When we talk about "us" in this
documentation, we refer to the amazing
`Zammad team <https://zammad.com/en/company>`_ of people who love to create
open source software for you.

If you want to ensure the Zammad software has a bright and sustainable future,
consider becoming a Zammad customer!

.. include:: /install/includes/hosted-services.rst
2 changes: 2 additions & 0 deletions getting-started/configure-webserver.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Configure the Webserver
=======================

.. include:: /install/includes/hosted-services.rst

You can find current sample configuration files for your webserver within
``contrib/`` of your Zammad installation.

Expand Down
5 changes: 2 additions & 3 deletions install/docker-compose.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Install with Docker
===================

.. include:: /install/includes/hosted-services.rst

Zammad can be deployed using Docker-Compose. You can even use
graphical docker front ends like
`Portainer <https://www.portainer.io/>`_.
Expand All @@ -10,9 +12,6 @@ graphical docker front ends like
We do not provide support in terms of Docker (-Compose) or Portainer specific problems.
If you choose to run Zammad via Docker, support is only provided for the Zammad application.

In case you're not too familiar with Docker and the way it works, you may want
to stick with :doc:`the package installation </install/package/>` instead.

Prerequisites
-------------

Expand Down
3 changes: 1 addition & 2 deletions install/elasticsearch.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ Set Up Elasticsearch
Zammad's search function can be powered by Elasticsearch (which is **highly
recommended**).

If these manual steps aren't what you are looking for, consider a `hosted Zammad
setup <https://zammad.com/en/pricing>`_ or :doc:`deploy Zammad via Docker </install/docker-compose>`.
.. include:: /install/includes/hosted-services.rst

.. note:: Some steps may be required depending on your Elasticsearch version and
configuration. See remarks in the configuration steps below.
Expand Down
10 changes: 10 additions & 0 deletions install/includes/hosted-services.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
.. orphan
.. tip::

Are you tired of complex setup, configuration, backup and update tasks?
Let :doc:`us </about/zammad>` handle this stuff for you! 🚀

The easiest and often most cost-effective way to operate Zammad is our
`cloud service <https://zammad.com/en/pricing>`_. Give it a try with
a `free trial instance <https://zammad.com/en/getting-started>`_!
8 changes: 5 additions & 3 deletions install/kubernetes.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
Install on Kubernetes
=====================

.. include:: /install/includes/hosted-services.rst

You can find installation instructions
`in the documentation of our helm chart <https://github.com/zammad/zammad-helm/blob/main/zammad/README.md>`_.

.. hint::

We do not provide support in terms of Kubernetes specific problems.
If you choose to run Zammad via Kubernetes, support is only provided for the
Zammad application.

You can find installation instructions
`in the documentation of our helm chart <https://github.com/zammad/zammad-helm/blob/main/zammad/README.md>`_.
5 changes: 1 addition & 4 deletions install/package.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
Install with Package Manager
============================

This section describes the basic package installation of Zammad. If these
manual steps aren't what you are looking for, consider a `hosted Zammad
setup <https://zammad.com/en/pricing>`_ or
:doc:`deploy Zammad via Docker </install/docker-compose>`.
.. include:: /install/includes/hosted-services.rst

Prerequisites
-------------
Expand Down
10 changes: 6 additions & 4 deletions install/source.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Install from Source
===================

.. include:: /install/includes/hosted-services.rst

The source installation is the most difficult installation type of Zammad.
If you're not too experienced with Linux and all that, you may want to use
another installation type:
Expand Down Expand Up @@ -76,8 +78,8 @@ compilation. See `pnpm.io <https://pnpm.io/>`_ for more information.
Install RVM
.. code-block:: sh
$ apt install curl git patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev autotools-dev\
libxslt1-dev libyaml-0-2 autoconf automake libreadline-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev\
$ apt install curl git patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev autotools-dev\
libxslt1-dev libyaml-0-2 autoconf automake libreadline-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev\
pkg-config libffi-dev libimlib2-dev gawk software-properties-common
$ apt-add-repository -y ppa:rael-gc/rvm
Expand All @@ -98,8 +100,8 @@ compilation. See `pnpm.io <https://pnpm.io/>`_ for more information.
Install RVM
.. code-block:: sh
$ apt install curl git patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev autotools-dev\
libxslt1-dev libyaml-0-2 autoconf automake libreadline-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev\
$ apt install curl git patch build-essential bison zlib1g-dev libssl-dev libxml2-dev libxml2-dev autotools-dev\
libxslt1-dev libyaml-0-2 autoconf automake libreadline-dev libyaml-dev libtool libgmp-dev libgdbm-dev libncurses5-dev\
pkg-config libffi-dev libimlib2-dev gawk
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
Expand Down
2 changes: 2 additions & 0 deletions install/update.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Updating Zammad
===============

.. include:: /install/includes/hosted-services.rst

Before updating Zammad, we strongly recommend to take a look at our
`release notes`_. You can find information about features and fixes as well as
technical remarks and breaking changes.
Expand Down
2 changes: 2 additions & 0 deletions prerequisites/hardware.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Hardware
========

.. include:: /install/includes/hosted-services.rst

The hardware requirements to run Zammad effectively vary depending on several
factors, for example:

Expand Down
2 changes: 2 additions & 0 deletions prerequisites/software.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
Software
========

.. include:: /install/includes/hosted-services.rst

1. Client Requirements
----------------------

Expand Down

0 comments on commit 2232441

Please sign in to comment.