Skip to content

Commit

Permalink
Fixes #380 - Edited instructions for node installation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralf401
ralf401 committed Oct 19, 2023
1 parent 8bc3425 commit b2d6279
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 35 deletions.
12 changes: 9 additions & 3 deletions install/includes/nodejs/debian.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
.. code-block:: sh
# 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 curl
$ curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
$ apt install nodejs
$ apt install nodejs -y
12 changes: 9 additions & 3 deletions install/includes/nodejs/ubuntu.rst
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
.. code-block:: sh
# 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 curl
$ curl -fsSL https://deb.nodesource.com/setup_lts.x | bash -
$ apt install nodejs
$ apt install nodejs -y
56 changes: 28 additions & 28 deletions install/source.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,15 @@ Install from source

.. note::

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
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:

* :doc:`/install/package`
* :doc:`/install/docker-compose`

| **Administrative note**
| Please note that we only use ``sudo`` after direct user changes.
| Please note that we only use ``sudo`` after direct user changes.
In all other situations you can expect ``root`` being in charge.
.. hint::
Expand All @@ -30,7 +30,7 @@ Prerequisites
Software dependencies
---------------------

Please ensure that you already provided mentioned
Please ensure that you already provided mentioned
:doc:`Software requirements </prerequisites/software>`.

Add user
Expand All @@ -49,7 +49,7 @@ Step 1: Get the source

.. note::

Not all distributions ship ``wget`` and ``tar`` by default, you may need to
Not all distributions ship ``wget`` and ``tar`` by default, you may need to
install it manually.

.. include:: /install/source/include-get-the-source.rst
Expand All @@ -60,7 +60,7 @@ Step 2: Install dependencies
----------------------------

..
About this section: The RVM installation part uses definition list instead
About this section: The RVM installation part uses definition list instead
of field lists intentionally. It's supposed to safe width for better readability.
.. note::
Expand All @@ -69,8 +69,8 @@ Step 2: Install dependencies
detailed instructions.


Zammad requires specific ruby versions. Adapt the commands below if you install
older versions. A list of required versions can be found on the
Zammad requires specific ruby versions. Adapt the commands below if you install
older versions. A list of required versions can be found on the
:doc:`Software requirements </prerequisites/software>` page.

.. include:: /install/includes/postgres-installation.rst
Expand All @@ -85,8 +85,8 @@ older versions. A list of required versions can be found on the
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 libsqlite3-dev sqlite3 software-properties-common
$ apt-add-repository -y ppa:rael-gc/rvm
Expand All @@ -98,7 +98,7 @@ older versions. A list of required versions can be found on the

Install Ruby Environment
.. include:: source/include-rvm-install-ruby.rst

.. tab:: Debian

Install Node.js
Expand All @@ -107,11 +107,11 @@ older versions. A list of required versions can be found on the
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 libsqlite3-dev sqlite3
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -L https://get.rvm.io | bash -s stable
Expand All @@ -133,7 +133,7 @@ older versions. A list of required versions can be found on the
$ yum install patch autoconf automake bison bzip2 gcc-c++ libffi-devel libtool make patch readline-devel ruby sqlite-devel\
zlib-devel glibc-headers glibc-devel openssl-devel git imlib2 imlib2-devel
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -L https://get.rvm.io | bash -s stable
Expand All @@ -151,10 +151,10 @@ older versions. A list of required versions can be found on the
Install RVM
.. code-block:: sh
$ zypper install patch autoconf automake bison bzip2 gcc-c++ libffi-devel libtool make patch readline-devel sqlite3-devel\
$ zypper install patch autoconf automake bison bzip2 gcc-c++ libffi-devel libtool make patch readline-devel sqlite3-devel\
sqlite3 zlib-devel glibc-devel openssl-devel git imlib2 imlib2-devel gdbm-devel libyaml-devel
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
$ gpg --keyserver keyserver.ubuntu.com --recv-keys\
409B6B1796C275462A1703113804BB82D39DC0E3 7D2BAF1CF37B13E2069D6956105BD0E739499BDB
$ curl -L https://get.rvm.io | bash -s stable
Expand All @@ -166,15 +166,15 @@ older versions. A list of required versions can be found on the

.. tab:: other

Other systems than above mentioned are out of scope of this documentation.
Please check the `rvm documentation <https://rvm.io/rvm/install>`_ on how
to install rvm on your system.
Other systems than above mentioned are out of scope of this documentation.
Please check the `rvm documentation <https://rvm.io/rvm/install>`_ on how
to install rvm on your system.

Please also ensure to install ``nodejs``.

After that install the specific required ruby version.

| After installing bundler, rake and rails we'll need to install all required gems.
| After installing bundler, rake and rails we'll need to install all required gems.
| The command depends on the database server you are using.
.. include:: /install/includes/postgres-dependencies.rst
Expand All @@ -189,8 +189,8 @@ Step 3: Configure database settings
$ cp config/database/database.yml config/database.yml
$ vi config/database.yml
Here's a sample configuration to give you an idea on how your configuration
file could look like. Please also have a look at
Here's a sample configuration to give you an idea on how your configuration
file could look like. Please also have a look at
:doc:`/appendix/configure-database-server` for deeper details.

.. code-block:: yaml
Expand All @@ -204,14 +204,14 @@ file could look like. Please also have a look at
username: zammad
password: changeme
.. hint::
.. hint::

You can remove the ``password`` line if you enable socket based
You can remove the ``password`` line if you enable socket based
authentication!

.. hint::
.. hint::

If you want to use an existing database server that's not on the same
If you want to use an existing database server that's not on the same
machine, you can also use ``host`` and ``port`` to set that up.

.. include:: /install/source/include-chmod-database-yml.rst
Expand Down Expand Up @@ -277,7 +277,7 @@ You can start all services by hand or use systemd to start / stop Zammad.
.. tab:: the manual way

.. warning::
.. warning::

This method is not suitable for production use - you should avoid it.

Expand Down
2 changes: 1 addition & 1 deletion install/source/include-rvm-install-ruby.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
$ rvm install ruby-3.1.3
# Install bundler, rake and rails
$ rvm use 3.1.3
$ rvm use ruby-3.1.3
$ gem install bundler rake rails

0 comments on commit b2d6279

Please sign in to comment.