Commit f746592e authored by Abhilash Raj's avatar Abhilash Raj
Browse files

Update documentation to use sassc instead of ruby-sass.

Also, some changes about min Python version and min Django version.
parent 3562a9ef
Pipeline #236255936 passed with stage
in 1 minute and 13 seconds
......@@ -19,7 +19,7 @@ one of the following installations methods:
* Installing Mailman from distro packages:
* :ref:`debian-install`
* :ref:`debian-install`
* :ref:`virtualenv-install`, recommended for Production
......@@ -12,15 +12,16 @@ have Mailman 3 running on your machine.
Dependencies
------------
Python3.5+.
Mailman requires any version of Python > 3.5.
Python3.7+.
While Mailman supports any version of Python > 3.6, versions 3.7+ is
recommended.
MTA Setup
Mailman 3 in theory would support any MTA or mail server which can send
emails to Mailman over LMTP. Officially, there are configurations for
Postfix_, Exim4_, qmail_ and sendmail_. Mailman Core has a fairly elaborate
documentation on `setting up your MTA`_. Look below at `setting up mailman
core`_ to find out the location of configuration file ``mailman.cfg`` which
documentation on `setting up your MTA`_. Look below at :ref:`setup-install-core`
to find out the location of configuration file ``mailman.cfg`` which
is mentioned in the documentation above.
The Web Front-end is based on a Python web framework called Django_. For
......@@ -34,22 +35,20 @@ Sass compiler
etc. which CSS originally doesn't support. Hyperkitty uses this to generate
CSS styles.
You can either use the Ruby implementation or `C/C++ implementation
<http://sass-lang.com/libsass>`_. Please look at the `installation guide for
sass`_ to see how you can get one.
You can use the `C/C++ implementation <http://sass-lang.com/libsass>`_. Please
look at the `installation guide for sass`_ to see how you can get one.
For apt based systems::
$ sudo apt install ruby-sass
$ sudo apt install sassc
For yum based systems try::
$ sudo yum install rubygem-sass
$ sudo yum install sassc
or::
$ sudo dnf install rubygem-sass
$ sudo dnf install sassc
After installing this, you'd have to configure Django to use these
compilers. A basic configuration would look like::
......@@ -57,16 +56,12 @@ Sass compiler
# To be added to Django's settings.py
COMPRESS_PRECOMPILERS = (
('text/x-scss', 'sass -t compressed {infile} {outfile}'),
('text/x-sass', 'sass -t compressed {infile} {outfile}'),
('text/x-scss', 'sassc -t compressed {infile} {outfile}'),
('text/x-sass', 'sassc -t compressed {infile} {outfile}'),
)
You can replace ``sass`` above with whatever is the name of the binary
is. For the Ruby implementation it is generally ``sass``, for C/C++ it is
``sassc``.
Python development packages
python3 dev package. This is required for building postorius
python3 dev package. This is required for building Postorius
For Fedora the package is ``python3-devel``::
......@@ -94,8 +89,7 @@ Virtualenv setup
Virtualenv is Python's mechanism to create isoated runtime environments.
.. hint:: If you are not familiar with virtualenv, checkout the `user guide for
virtualenv`_.
.. hint:: If you are not familiar with virtualenv, checkout the `user guide for virtualenv`_.
1. Setup working directory:
......@@ -198,7 +192,7 @@ reference`_ for all available settings.
Exact commands would look something like this::
# Download and install the latest release of django.
(venv)$ pip install Django>=1.11
(venv)$ pip install Django>=2.2
# Clone the repo locally.
(venv)$ git clone https://gitlab.com/mailman/mailman-suite.git
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment