CINXE.COM

<!DOCTYPE html> <html class="writer-html5" lang="en" > <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>Install from Source — Zammad System Documentation documentation</title> <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> <link rel="stylesheet" href="../_static/css/theme.css" type="text/css" /> <link rel="stylesheet" href="../_static/tabs.css" type="text/css" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/sphinx_rtd_theme.css" type="text/css" /> <link rel="stylesheet" href="https://media.readthedocs.org/css/readthedocs-doc-embed.css" type="text/css" /> <link rel="stylesheet" href="../_static/theme/theme_overrides.css" type="text/css" /> <link rel="shortcut icon" href="../_static/favicon.ico"/>  <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script> <script src="../_static/jquery.js"></script> <script src="../_static/underscore.js"></script> <script src="../_static/doctools.js"></script> <script src="../_static/js/versionwarning.js"></script> <script src="../_static/tabs.js"></script> <script src="../_static/theme/zammad_overrides.js"></script> <script src="../_static/js/theme.js"></script> <link rel="index" title="Index" href="../genindex.html" /> <link rel="search" title="Search" href="../search.html" /> <link rel="next" title="Set Up Elasticsearch" href="elasticsearch.html" /> <link rel="prev" title="Install on Kubernetes" href="kubernetes.html" /> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="zammad" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/install/source.html" /><meta name="readthedocs-http-status" content="200" /></head> <body class="wy-body-for-nav"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search" > <a href="../index.html" class="icon icon-home"> Zammad System Documentation <img src="../_static/zammad_logo_70x61@2x.png" class="logo" alt="Logo"/> </a> <div class="version"> latest </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="../search.html" method="get"> <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu"> About <ul> <li class="toctree-l1"><a class="reference internal" href="../about/zammad.html">Zammad</a></li> </ul> Prerequisites <ul> <li class="toctree-l1"><a class="reference internal" href="../prerequisites/software.html">Software</a></li> <li class="toctree-l1"><a class="reference internal" href="../prerequisites/hardware.html">Hardware</a></li> </ul> Installation & Update <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="package.html">Install with Package Manager</a></li> <li class="toctree-l1"><a class="reference internal" href="docker-compose.html">Install with Docker</a></li> <li class="toctree-l1"><a class="reference internal" href="kubernetes.html">Install on Kubernetes</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">Install from Source</a><ul> <li class="toctree-l2"><a class="reference internal" href="#prerequisites">Prerequisites</a><ul> <li class="toctree-l3"><a class="reference internal" href="#software-dependencies">Software Dependencies</a></li> <li class="toctree-l3"><a class="reference internal" href="#add-user">Add User</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#installation">Installation</a><ul> <li class="toctree-l3"><a class="reference internal" href="#step-1-get-the-source">Step 1: Get the Source</a></li> <li class="toctree-l3"><a class="reference internal" href="#step-2-install-dependencies">Step 2: Install Dependencies</a></li> <li class="toctree-l3"><a class="reference internal" href="#step-3-configure-database-settings">Step 3: Configure Database Settings</a></li> <li class="toctree-l3"><a class="reference internal" href="#step-4-initialize-your-database">Step 4: Initialize Your Database</a></li> <li class="toctree-l3"><a class="reference internal" href="#step-5-pre-compile-all-zammad-assets">Step 5: Pre-compile All Zammad Assets</a></li> <li class="toctree-l3"><a class="reference internal" href="#step-6-start-zammad-or-install-as-service">Step 6: Start Zammad or Install As Service</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#manage-services-of-zammad">Manage Services of Zammad</a></li> <li class="toctree-l2"><a class="reference internal" href="#firewall-selinux">Firewall & SELinux</a><ul> <li class="toctree-l3"><a class="reference internal" href="#selinux">SELinux</a></li> <li class="toctree-l3"><a class="reference internal" href="#firewall">Firewall</a></li> </ul> </li> <li class="toctree-l2"><a class="reference internal" href="#next-steps">Next Steps</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="elasticsearch.html">Set Up Elasticsearch</a></li> <li class="toctree-l1"><a class="reference internal" href="update.html">Updating Zammad</a></li> </ul> Getting started <ul> <li class="toctree-l1"><a class="reference internal" href="../getting-started/configure-webserver.html">Configure the Webserver</a></li> <li class="toctree-l1"><a class="reference internal" href="../getting-started/first-steps.html">First Steps</a></li> </ul> Migration <ul> <li class="toctree-l1"><a class="reference internal" href="../migration/index.html">Migrating to Zammad</a></li> </ul> Administration via ... <ul> <li class="toctree-l1"><a class="reference external" href="https://admin-docs.zammad.org/">Web-UI (admin documentation)</a></li> <li class="toctree-l1"><a class="reference internal" href="../admin/console.html">Console</a></li> </ul> Contributing / Development <ul> <li class="toctree-l1"><a class="reference internal" href="../contributing/start.html">Start</a></li> </ul> REST API <ul> <li class="toctree-l1"><a class="reference internal" href="../api/intro.html">Introduction</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/calendar.html">Calendar</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/checklist.html">Checklist Endpoints</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/generic-cti/index.html">Generic CTI</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/group.html">Group</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/notification.html">Online Notification</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/object.html">Object</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/organization.html">Organization</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/role.html">Roles</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/sla.html">Service-Level Agreements (SLA)</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/ticket.html">Ticket Endpoints</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/user.html">User</a></li> <li class="toctree-l1"><a class="reference internal" href="../api/user-access-token.html">User Access Token</a></li> </ul> Appendix <ul> <li class="toctree-l1"><a class="reference internal" href="../appendix/backup-and-restore/index.html">Backup and Restore</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/configure-env-vars.html">Configuration via Environment Variables</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/configure-database-server.html">Configure Database Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/migrate-to-postgresql.html">Migrate to PostgreSQL Server</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/privacy.html">Privacy & Data Retention</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/single-sign-on.html">Single Sign-On for Kerberos</a></li> <li class="toctree-l1"><a class="reference internal" href="../appendix/reporting-tools-thirdparty.html">Reporting Tools (Third party)</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" > <a href="../index.html">Zammad System Documentation</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="Page navigation"> <ul class="wy-breadcrumbs"> <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li> <li class="breadcrumb-item active">Install from Source</li> <li class="wy-breadcrumbs-aside"> <a href="../_sources/install/source.rst.txt" rel="nofollow"> View page source</a> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="install-from-source"> <h1>Install from Source<a class="headerlink" href="#install-from-source" title="Permalink to this headline">¶</a></h1> 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: <blockquote> <div><ul class="simple"> <li><a class="reference internal" href="package.html">Install with Package Manager</a></li> <li><a class="reference internal" href="docker-compose.html">Install with Docker</a></li> </ul> </div></blockquote> <div class="admonition note"> Note Please note that we only use <code class="docutils literal notranslate">sudo</code> after direct user changes. In all other situations you can expect <code class="docutils literal notranslate">root</code> being in charge. </div> <div class="admonition hint"> Hint 🔎 Looking for MacOS hints? You can find the developer documentation <a class="reference external" href="https://github.com/zammad/zammad/blob/develop/doc/developer_manual/development_environment/how-to-set-up-a-development-environment.md">here</a>. </div> <div class="section" id="prerequisites"> <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Permalink to this headline">¶</a></h2> <div class="section" id="software-dependencies"> <h3>Software Dependencies<a class="headerlink" href="#software-dependencies" title="Permalink to this headline">¶</a></h3> Please ensure that you already provided mentioned <a class="reference internal" href="../prerequisites/software.html">Software requirements</a>. </div> <div class="section" id="add-user"> <h3>Add User<a class="headerlink" href="#add-user" title="Permalink to this headline">¶</a></h3> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ useradd zammad -m -d /opt/zammad -s /bin/bash $ groupadd zammad </pre></div> </div> </div> </div> <div class="section" id="installation"> <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2> <div class="section" id="step-1-get-the-source"> <h3>Step 1: Get the Source<a class="headerlink" href="#step-1-get-the-source" title="Permalink to this headline">¶</a></h3> <div class="admonition note"> Note Not all distributions ship <code class="docutils literal notranslate">wget</code> and <code class="docutils literal notranslate">tar</code> by default, you may need to install it manually. </div> Get the latest stable release of Zammad <a class="reference external" href="https://ftp.zammad.com/zammad-latest.tar.gz">here</a>. This file will be updated whenever new bug-fixes are applied, so you can update from this URL regularly. <div class="highlight-sh notranslate"><div class="highlight"><pre>$ cd /opt $ wget https://ftp.zammad.com/zammad-latest.tar.gz $ tar -xzf zammad-latest.tar.gz --strip-components 1 -C zammad $ chown -R zammad:zammad zammad/ $ rm -f zammad-latest.tar.gz </pre></div> </div> </div> <div class="section" id="step-2-install-dependencies"> <h3>Step 2: Install Dependencies<a class="headerlink" href="#step-2-install-dependencies" title="Permalink to this headline">¶</a></h3> Zammad requires specific ruby versions. Adapt the commands below if you install older versions. A list of required versions can be found on the <a class="reference internal" href="../prerequisites/software.html">Software requirements</a> page. Please also make sure to have <code class="docutils literal notranslate">pnpm</code> installed, which is required for asset compilation. See <a class="reference external" href="https://pnpm.io/">pnpm.io</a> for more information. <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-0-0-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-0-0-0" name="0-0" role="tab" tabindex="0">Ubuntu / Debian</button><button aria-controls="panel-0-0-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-1" name="0-1" role="tab" tabindex="-1">CentOS</button><button aria-controls="panel-0-0-2" aria-selected="false" class="sphinx-tabs-tab" id="tab-0-0-2" name="0-2" role="tab" tabindex="-1">OpenSUSE / SLES</button></div><div aria-labelledby="tab-0-0-0" class="sphinx-tabs-panel" id="panel-0-0-0" name="0-0" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ apt update $ apt install postgresql postgresql-contrib $ systemctl start postgresql $ systemctl enable postgresql </pre></div> </div> </div><div aria-labelledby="tab-0-0-1" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-1" name="0-1" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ yum install postgresql-server postgresql-contrib $ postgresql-setup initdb $ systemctl start postgresql $ systemctl enable postgresql </pre></div> </div> </div><div aria-labelledby="tab-0-0-2" class="sphinx-tabs-panel" hidden="true" id="panel-0-0-2" name="0-2" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ zypper refresh $ zypper install postgresql postgresql-server postgresql-contrib # openSuSE 15 also requires: $ zypper install postgresql-server-devel $ systemctl start postgresql $ systemctl enable postgresql </pre></div> </div> </div></div> <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-1-1-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-1-1-0" name="1-0" role="tab" tabindex="0">Ubuntu</button><button aria-controls="panel-1-1-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-1" name="1-1" role="tab" tabindex="-1">Debian</button><button aria-controls="panel-1-1-2" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-2" name="1-2" role="tab" tabindex="-1">CentOS</button><button aria-controls="panel-1-1-3" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-3" name="1-3" role="tab" tabindex="-1">OpenSUSE</button><button aria-controls="panel-1-1-4" aria-selected="false" class="sphinx-tabs-tab" id="tab-1-1-4" name="1-4" role="tab" tabindex="-1">other</button></div><div aria-labelledby="tab-1-1-0" class="sphinx-tabs-panel" id="panel-1-1-0" name="1-0" role="tabpanel" tabindex="0"><dl> <dt>Install Node.js</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># see https://github.com/nodesource/distributions#debian-and-ubuntu-based-distributions # for detailed installation instructions. $ apt install -y ca-certificates curl gnupg $ mkdir -p /etc/apt/keyrings $ curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg $ NODE_MAJOR=20 echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list $ apt update $ apt install nodejs -y </pre></div> </div> </dd> <dt>Install RVM</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ 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 $ apt update $ apt install rvm </pre></div> </div> </dd> <dt>Set relevant Environment variables</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Set rails environment specific things $ echo "export RAILS_ENV=production" >> /opt/zammad/.bashrc $ echo "export RAILS_SERVE_STATIC_FILES=true" >> /opt/zammad/.bashrc $ echo "rvm --default use 3.2.3" >> /opt/zammad/.bashrc # Debian, CentOS & OpenSuSE $ echo "source /usr/local/rvm/scripts/rvm" >> /opt/zammad/.bashrc # Ubuntu $ echo "source /usr/share/rvm/scripts/rvm" >> /opt/zammad/.bashrc </pre></div> </div> </dd> <dt>Install Ruby Environment</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Add zammad user to RVM group $ usermod -a -G rvm zammad # Install Ruby 3.2.3 $ su - zammad $ rvm install ruby-3.2.3 # Install bundler, rake and rails $ rvm use ruby-3.2.3 $ gem install bundler rake rails </pre></div> </div> </dd> </dl> </div><div aria-labelledby="tab-1-1-1" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-1" name="1-1" role="tabpanel" tabindex="0"><dl> <dt>Install Node.js</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># see https://github.com/nodesource/distributions#debian-and-ubuntu-based-distributions # for detailed installation instructions. $ apt install -y ca-certificates curl gnupg $ mkdir -p /etc/apt/keyrings $ curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | sudo gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg $ NODE_MAJOR=20 echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_$NODE_MAJOR.x nodistro main" | sudo tee /etc/apt/sources.list.d/nodesource.list $ apt update $ apt install nodejs -y </pre></div> </div> </dd> <dt>Install RVM</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ 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\ 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB $ curl -L https://get.rvm.io | bash -s stable </pre></div> </div> </dd> <dt>Set relevant Environment variables</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Set rails environment specific things $ echo "export RAILS_ENV=production" >> /opt/zammad/.bashrc $ echo "export RAILS_SERVE_STATIC_FILES=true" >> /opt/zammad/.bashrc $ echo "rvm --default use 3.2.3" >> /opt/zammad/.bashrc # Debian, CentOS & OpenSuSE $ echo "source /usr/local/rvm/scripts/rvm" >> /opt/zammad/.bashrc # Ubuntu $ echo "source /usr/share/rvm/scripts/rvm" >> /opt/zammad/.bashrc </pre></div> </div> </dd> <dt>Install Ruby Environment</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Add zammad user to RVM group $ usermod -a -G rvm zammad # Install Ruby 3.2.3 $ su - zammad $ rvm install ruby-3.2.3 # Install bundler, rake and rails $ rvm use ruby-3.2.3 $ gem install bundler rake rails </pre></div> </div> </dd> </dl> </div><div aria-labelledby="tab-1-1-2" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-2" name="1-2" role="tabpanel" tabindex="0"><dl> <dt>Install Node.js</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ curl -fsSL https://rpm.nodesource.com/setup_lts.x | bash - </pre></div> </div> </dd> <dt>Install RVM</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ yum install epel-release $ yum install patch autoconf automake bison bzip2 gcc-c++ libffi-devel libtool make patch readline-devel ruby\ zlib-devel glibc-headers glibc-devel openssl-devel git imlib2 imlib2-devel $ gpg --keyserver keyserver.ubuntu.com --recv-keys\ 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB $ curl -L https://get.rvm.io | bash -s stable </pre></div> </div> </dd> <dt>Set relevant Environment variables</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Set rails environment specific things $ echo "export RAILS_ENV=production" >> /opt/zammad/.bashrc $ echo "export RAILS_SERVE_STATIC_FILES=true" >> /opt/zammad/.bashrc $ echo "rvm --default use 3.2.3" >> /opt/zammad/.bashrc # Debian, CentOS & OpenSuSE $ echo "source /usr/local/rvm/scripts/rvm" >> /opt/zammad/.bashrc # Ubuntu $ echo "source /usr/share/rvm/scripts/rvm" >> /opt/zammad/.bashrc </pre></div> </div> </dd> <dt>Install Ruby Environment</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Add zammad user to RVM group $ usermod -a -G rvm zammad # Install Ruby 3.2.3 $ su - zammad $ rvm install ruby-3.2.3 # Install bundler, rake and rails $ rvm use ruby-3.2.3 $ gem install bundler rake rails </pre></div> </div> </dd> </dl> </div><div aria-labelledby="tab-1-1-3" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-3" name="1-3" role="tabpanel" tabindex="0"><dl> <dt>Install Node.js</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ zypper install nodejs16 </pre></div> </div> </dd> <dt>Install RVM</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ zypper install patch autoconf automake bison bzip2 gcc-c++ libffi-devel libtool make patch readline-devel\ zlib-devel glibc-devel openssl-devel git imlib2 imlib2-devel gdbm-devel libyaml-devel $ gpg --keyserver keyserver.ubuntu.com --recv-keys\ 409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB $ curl -L https://get.rvm.io | bash -s stable </pre></div> </div> </dd> <dt>Set relevant Environment variables</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Set rails environment specific things $ echo "export RAILS_ENV=production" >> /opt/zammad/.bashrc $ echo "export RAILS_SERVE_STATIC_FILES=true" >> /opt/zammad/.bashrc $ echo "rvm --default use 3.2.3" >> /opt/zammad/.bashrc # Debian, CentOS & OpenSuSE $ echo "source /usr/local/rvm/scripts/rvm" >> /opt/zammad/.bashrc # Ubuntu $ echo "source /usr/share/rvm/scripts/rvm" >> /opt/zammad/.bashrc </pre></div> </div> </dd> <dt>Install Ruby Environment</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre># Add zammad user to RVM group $ usermod -a -G rvm zammad # Install Ruby 3.2.3 $ su - zammad $ rvm install ruby-3.2.3 # Install bundler, rake and rails $ rvm use ruby-3.2.3 $ gem install bundler rake rails </pre></div> </div> </dd> </dl> </div><div aria-labelledby="tab-1-1-4" class="sphinx-tabs-panel" hidden="true" id="panel-1-1-4" name="1-4" role="tabpanel" tabindex="0">Other systems than above mentioned are out of scope of this documentation. Please check the <a class="reference external" href="https://rvm.io/rvm/install">rvm documentation</a> on how to install rvm on your system. Please also ensure to install <code class="docutils literal notranslate">nodejs</code>. After that install the specific required ruby version. </div></div> <div class="line-block"> <div class="line">After installing bundler, rake and rails we’ll need to install all required gems.</div> <div class="line">The command depends on the database server you are using.</div> </div> <dl> <dt>Install PostgreSQL Dependencies</dt><dd><div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-2-2-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-2-2-0" name="2-0" role="tab" tabindex="0">Ubuntu / Debian</button><button aria-controls="panel-2-2-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-1" name="2-1" role="tab" tabindex="-1">CentOS</button><button aria-controls="panel-2-2-2" aria-selected="false" class="sphinx-tabs-tab" id="tab-2-2-2" name="2-2" role="tab" tabindex="-1">OpenSuSE</button></div><div aria-labelledby="tab-2-2-0" class="sphinx-tabs-panel" id="panel-2-2-0" name="2-0" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ apt install libpq-dev </pre></div> </div> </div><div aria-labelledby="tab-2-2-1" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-1" name="2-1" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ yum install postgresql-libs postgresql-devel </pre></div> </div> </div><div aria-labelledby="tab-2-2-2" class="sphinx-tabs-panel" hidden="true" id="panel-2-2-2" name="2-2" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ zypper install postgresql-devel </pre></div> </div> </div></div> </dd> <dt>Install Gems for Zammad</dt><dd><div class="highlight-sh notranslate"><div class="highlight"><pre>$ su - zammad $ bundle config set without "test development mysql" $ bundle install </pre></div> </div> </dd> </dl> </div> <div class="section" id="step-3-configure-database-settings"> <h3>Step 3: Configure Database Settings<a class="headerlink" href="#step-3-configure-database-settings" title="Permalink to this headline">¶</a></h3> <div class="admonition tip"> Tip 🤓 For easiest usage … If you provide your Zammad user with database creation permission, you can run <code class="docutils literal notranslate">db:create</code> in the following section. If you don’t want that, you’ll have to create the database manually. </div> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ cp config/database/database.yml config/database.yml $ vi config/database.yml </pre></div> </div> Here’s a sample configuration to give you an idea on how your configuration file could look like. Please also have a look at <a class="reference internal" href="../appendix/configure-database-server.html">Configure Database Server</a> for deeper details. <blockquote> <div><div class="highlight-yaml notranslate"><div class="highlight"><pre>production: adapter: postgresql database: zammad pool: 50 encoding: utf8 username: zammad password: changeme # You can remove this line if you enable socket based authentication! </pre></div> </div> </div></blockquote> <div class="admonition hint"> Hint If you want to use an existing database server that’s not on the same machine, you can also use <code class="docutils literal notranslate">host</code> and <code class="docutils literal notranslate">port</code> to set that up. </div> For security reasons, ensure that your database configuration is readable for the Zammad user only. <div class="highlight-sh notranslate"><div class="highlight"><pre>$ chmod 600 /opt/zammad/config/database.yml $ chown zammad:zammad /opt/zammad/config/database.yml </pre></div> </div> </div> <div class="section" id="step-4-initialize-your-database"> <h3>Step 4: Initialize Your Database<a class="headerlink" href="#step-4-initialize-your-database" title="Permalink to this headline">¶</a></h3> <div class="admonition warning"> Warning Ensure to do this as <code class="docutils literal notranslate">zammad</code> user in your Zammad directory! </div> <div class="admonition tip"> Tip 🤓 Avoid a restart … You can set the base URL of your Zammad installation by setting the <a class="reference internal" href="../appendix/configure-env-vars.html#http-type">ZAMMAD_HTTP_TYPE</a> and <a class="reference internal" href="../appendix/configure-env-vars.html#fqdn">ZAMMAD_FQDN</a> environment variables before initializing the database (see below). <div class="highlight-sh notranslate"><div class="highlight"><pre># Example for a base URL of https://zammad.example.com $ su - zammad $ export ZAMMAD_HTTP_TYPE=https $ export ZAMMAD_FQDN=zammad.example.com </pre></div> </div> </div> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ su - zammad $ rake db:create # SKIP IF you already created zammads database (see tip of step 3) $ rake db:migrate $ rake db:seed # Synchronize translations $ rails r "Locale.sync" $ rails r "Translation.sync" </pre></div> </div> </div> <div class="section" id="step-5-pre-compile-all-zammad-assets"> <h3>Step 5: Pre-compile All Zammad Assets<a class="headerlink" href="#step-5-pre-compile-all-zammad-assets" title="Permalink to this headline">¶</a></h3> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ rake assets:precompile </pre></div> </div> </div> <div class="section" id="step-6-start-zammad-or-install-as-service"> <h3>Step 6: Start Zammad or Install As Service<a class="headerlink" href="#step-6-start-zammad-or-install-as-service" title="Permalink to this headline">¶</a></h3> <div class="admonition note"> Note Run the following commands as <code class="docutils literal notranslate">root</code>. </div> You can start all services by hand or use systemd to start / stop Zammad. <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-3-3-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-3-3-0" name="3-0" role="tab" tabindex="0">systemd (recommended)</button><button aria-controls="panel-3-3-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-3-3-1" name="3-1" role="tab" tabindex="-1">the manual way</button></div><div aria-labelledby="tab-3-3-0" class="sphinx-tabs-panel" id="panel-3-3-0" name="3-0" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ cd /opt/zammad/script/systemd $ ./install-zammad-systemd-services.sh </pre></div> </div> </div><div aria-labelledby="tab-3-3-1" class="sphinx-tabs-panel" hidden="true" id="panel-3-3-1" name="3-1" role="tabpanel" tabindex="0"><div class="admonition warning"> Warning This method is not suitable for production use - you should avoid it. </div> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ rails s -p 3000 # application web server $ script/websocket-server.rb start # non blocking websocket server $ script/background-worker.rb start # generate overviews on demand, just send changed data to browser </pre></div> </div> <div class="admonition danger"> Danger ⚠️ Zammads background worker cannot run in daemon mode! </div> </div></div> </div> </div> <div class="section" id="manage-services-of-zammad"> <h2>Manage Services of Zammad<a class="headerlink" href="#manage-services-of-zammad" title="Permalink to this headline">¶</a></h2> In general Zammad uses three services - these can be (re)started & stopped with the parent <code class="docutils literal notranslate">zammad</code>. <div class="highlight-sh notranslate"><div class="highlight"><pre>$ # Zammad service to start all services at once $ systemctl (status|start|stop|restart) zammad $ # Zammads internal puma server (relevant for displaying the web app) $ systemctl (status|start|stop|restart) zammad-web $ # Zammads background worker - relevant for all delayed- and background jobs $ systemctl (status|start|stop|restart) zammad-worker $ # Zammads websocket server for session related information $ systemctl (status|start|stop|restart) zammad-websocket </pre></div> </div> </div> <div class="section" id="firewall-selinux"> <h2>Firewall & SELinux<a class="headerlink" href="#firewall-selinux" title="Permalink to this headline">¶</a></h2> Some parts of these steps may not apply to you, feel free to skip them! <div class="section" id="selinux"> <h3>SELinux<a class="headerlink" href="#selinux" title="Permalink to this headline">¶</a></h3> <div class="admonition note"> Note The commands below only work on Ubuntu, Debian and CentOS. If you use a different distribution, please have a look at their documentation. </div> <div class="highlight-sh notranslate"><div class="highlight"><pre>$ # Allow nginx or apache to access public files of Zammad and communicate $ sudo chcon -Rv --type=httpd_sys_content_t /opt/zammad/public/ $ sudo setsebool httpd_can_network_connect on -P $ sudo semanage fcontext -a -t httpd_sys_content_t /opt/zammad/public/ $ sudo restorecon -Rv /opt/zammad/public/ $ sudo chmod -R a+r /opt/zammad/public/ </pre></div> </div> </div> <div class="section" id="firewall"> <h3>Firewall<a class="headerlink" href="#firewall" title="Permalink to this headline">¶</a></h3> Ensure to open ports <code class="docutils literal notranslate">80</code> and <code class="docutils literal notranslate">443</code> (TCP & UDP) beside of the ports you need. Below you can find a few examples for different distributions. If you are using a different distribution, please have a look at their documentation. Please note that the examples below only cover the distribution’s default firewall. It may not cover your case. <div class="sphinx-tabs docutils container"> <div aria-label="Tabbed content" class="closeable" role="tablist"><button aria-controls="panel-4-4-0" aria-selected="true" class="sphinx-tabs-tab" id="tab-4-4-0" name="4-0" role="tab" tabindex="0">Ubuntu</button><button aria-controls="panel-4-4-1" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-1" name="4-1" role="tab" tabindex="-1">Debian</button><button aria-controls="panel-4-4-2" aria-selected="false" class="sphinx-tabs-tab" id="tab-4-4-2" name="4-2" role="tab" tabindex="-1">CentOS, RHEL, openSUSE, SLES</button></div><div aria-labelledby="tab-4-4-0" class="sphinx-tabs-panel" id="panel-4-4-0" name="4-0" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ # Open Port 80 and 443 on your Firewall $ sudo ufw allow 80 $ sudo ufw allow 443 $ sudo ufw reload </pre></div> </div> </div><div aria-labelledby="tab-4-4-1" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-1" name="4-1" role="tabpanel" tabindex="0"><div class="admonition warning"> Warning We’re covering <code class="docutils literal notranslate">nftables</code> in this part - iptables is discouraged starting from Debian 10 (Buster). Our example uses the <code class="docutils literal notranslate">input</code> chain, yours may be a different one! </div> Add the following lines to <code class="docutils literal notranslate">/etc/nftables.conf</code> or your specific rule file. Ensure to add these lines to your input-chain. <div class="highlight-default notranslate"><div class="highlight"><pre># Open Port 80 and 443 for Zammad sudo tcp dport { http, https } accept sudo udp dport { http, https } accept </pre></div> </div> The result should look like the following. Keep in mind that your environment could require different / more rules. <div class="highlight-default notranslate"><div class="highlight"><pre>#!/usr/local/sbin/nft -f flush ruleset table inet filter { chain input { type filter hook input priority 0; policy drop; ct state established,related accept tcp dport ssh log accept tcp dport { http, https } accept udp dport { http, https } accept } chain forward { type filter hook forward priority 0; policy accept; } chain output { type filter hook output priority 0; policy accept; } } </pre></div> </div> To load your new rules, simply run <code class="docutils literal notranslate">sudo systemctl reload nftables</code>. </div><div aria-labelledby="tab-4-4-2" class="sphinx-tabs-panel" hidden="true" id="panel-4-4-2" name="4-2" role="tabpanel" tabindex="0"><div class="highlight-sh notranslate"><div class="highlight"><pre>$ # Open Port 80 and 443 on your Firewall $ sudo firewall-cmd --zone=public --add-service=http --permanent $ sudo firewall-cmd --zone=public --add-service=https --permanent $ sudo firewall-cmd --reload </pre></div> </div> </div></div> </div> </div> <div class="section" id="next-steps"> <h2>Next Steps<a class="headerlink" href="#next-steps" title="Permalink to this headline">¶</a></h2> With this Zammad technically is ready to go. However, you’ll need to follow the following further steps to access Zammads Web-UI and getting started with it. <blockquote> <div><ol class="arabic simple"> <li><a class="reference internal" href="elasticsearch.html#configure-zammad-with-elasticsearch">Connect Zammad with Elasticsearch</a></li> <li><a class="reference internal" href="../getting-started/configure-webserver.html">Configure the Webserver</a></li> <li><a class="reference internal" href="../getting-started/first-steps.html">First Steps</a></li> <li>You may also find Zammads <a class="reference internal" href="../admin/console.html">Console</a> commands useful</li> </ol> </div></blockquote> If you expect usage with 5 agents or more you may also want to consider the following pages. <blockquote> <div><ul class="simple"> <li><a class="reference internal" href="../appendix/configure-env-vars.html#performance-tuning">Performance Tuning</a></li> <li><a class="reference internal" href="../appendix/configure-database-server.html">Configure Database Server</a></li> </ul> </div></blockquote> </div> </div> </div> </div> <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer"> <a href="kubernetes.html" class="btn btn-neutral float-left" title="Install on Kubernetes" accesskey="p" rel="prev"> Previous</a> <a href="elasticsearch.html" class="btn btn-neutral float-right" title="Set Up Elasticsearch" accesskey="n" rel="next">Next </a> </div> <hr/> <div role="contentinfo"> © Copyright 2024, Zammad. </div> Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script> jQuery(function () { SphinxRtdTheme.Navigation.enable(true); }); </script> </body> </html>