Compare commits
4 Commits
fix/oauth2
...
centos9-su
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
af9d8c2849 | ||
|
|
6b4302b566 | ||
|
|
d9ced63e99 | ||
|
|
b13cdbf0ba |
2
.github/ISSUE_TEMPLATE.md
vendored
2
.github/ISSUE_TEMPLATE.md
vendored
@@ -1,7 +1,7 @@
|
|||||||
# Impacted versions
|
# Impacted versions
|
||||||
|
|
||||||
* Distribution: Debian / Ubuntu / Centos
|
* Distribution: Debian / Ubuntu / Centos
|
||||||
* Codename: Jessie / Trusty / Centos 7 / ...
|
* Codename: Jessie / Trusty / Centos 9 Stream / ...
|
||||||
* Arch: 32 Bits / 64 Bits
|
* Arch: 32 Bits / 64 Bits
|
||||||
* Database: PostgreSQL / MySQL
|
* Database: PostgreSQL / MySQL
|
||||||
|
|
||||||
|
|||||||
60
.github/workflows/installer.yml
vendored
Normal file
60
.github/workflows/installer.yml
vendored
Normal file
@@ -0,0 +1,60 @@
|
|||||||
|
name: Modoboa installer
|
||||||
|
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [ master ]
|
||||||
|
pull_request:
|
||||||
|
branches: [ master ]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
strategy:
|
||||||
|
matrix:
|
||||||
|
python-version: [3.7, 3.8, 3.9]
|
||||||
|
fail-fast: false
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Set up Python ${{ matrix.python-version }}
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: ${{ matrix.python-version }}
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install -r test-requirements.txt
|
||||||
|
- name: Run tests
|
||||||
|
if: ${{ matrix.python-version != '3.9' }}
|
||||||
|
run: |
|
||||||
|
python tests.py
|
||||||
|
- name: Run tests and coverage
|
||||||
|
if: ${{ matrix.python-version == '3.9' }}
|
||||||
|
run: |
|
||||||
|
coverage run tests.py
|
||||||
|
- name: Upload coverage result
|
||||||
|
if: ${{ matrix.python-version == '3.9' }}
|
||||||
|
uses: actions/upload-artifact@v2
|
||||||
|
with:
|
||||||
|
name: coverage-results
|
||||||
|
path: .coverage
|
||||||
|
|
||||||
|
coverage:
|
||||||
|
needs: test
|
||||||
|
runs-on: ubuntu-latest
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v2
|
||||||
|
- name: Set up Python
|
||||||
|
uses: actions/setup-python@v2
|
||||||
|
with:
|
||||||
|
python-version: '3.9'
|
||||||
|
- name: Install dependencies
|
||||||
|
run: |
|
||||||
|
pip install codecov
|
||||||
|
- name: Download coverage results
|
||||||
|
uses: actions/download-artifact@v2
|
||||||
|
with:
|
||||||
|
name: coverage-results
|
||||||
|
- name: Report coverage
|
||||||
|
run: |
|
||||||
|
coverage report
|
||||||
|
codecov
|
||||||
3
.gitignore
vendored
3
.gitignore
vendored
@@ -55,3 +55,6 @@ docs/_build/
|
|||||||
|
|
||||||
# PyBuilder
|
# PyBuilder
|
||||||
target/
|
target/
|
||||||
|
|
||||||
|
# PyCharm
|
||||||
|
.idea/
|
||||||
|
|||||||
15
.travis.yml
15
.travis.yml
@@ -1,15 +0,0 @@
|
|||||||
sudo: false
|
|
||||||
language: python
|
|
||||||
cache: pip
|
|
||||||
python:
|
|
||||||
- "2.7"
|
|
||||||
- "3.4"
|
|
||||||
|
|
||||||
before_install:
|
|
||||||
- pip install -r test-requirements.txt
|
|
||||||
|
|
||||||
script:
|
|
||||||
- coverage run tests.py
|
|
||||||
|
|
||||||
after_success:
|
|
||||||
- codecov
|
|
||||||
56
README.rst
56
README.rst
@@ -1,7 +1,7 @@
|
|||||||
modoboa-installer
|
modoboa-installer
|
||||||
=================
|
=================
|
||||||
|
|
||||||
|travis| |codecov|
|
|workflow| |codecov|
|
||||||
|
|
||||||
An installer which deploy a complete mail server based on Modoboa.
|
An installer which deploy a complete mail server based on Modoboa.
|
||||||
|
|
||||||
@@ -11,11 +11,12 @@ An installer which deploy a complete mail server based on Modoboa.
|
|||||||
|
|
||||||
* Debian Buster (10) / Bullseye (11)
|
* Debian Buster (10) / Bullseye (11)
|
||||||
* Ubuntu Bionic Beaver (18.04) and upper
|
* Ubuntu Bionic Beaver (18.04) and upper
|
||||||
* CentOS 7
|
* CentOS 9 Stream
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
|
|
||||||
``/tmp`` partition must be mounted without the ``noexec`` option.
|
``/tmp`` partition must be mounted without the ``noexec`` option.
|
||||||
|
Centos 7 support has been depreceated since modoboa requires python 3.7>=.
|
||||||
|
|
||||||
.. note::
|
.. note::
|
||||||
|
|
||||||
@@ -92,6 +93,54 @@ You can activate it as follows::
|
|||||||
|
|
||||||
It will automatically install latest versions of modoboa and its plugins.
|
It will automatically install latest versions of modoboa and its plugins.
|
||||||
|
|
||||||
|
Backup mode
|
||||||
|
------------
|
||||||
|
|
||||||
|
An experimental backup mode is available.
|
||||||
|
|
||||||
|
.. warning::
|
||||||
|
|
||||||
|
You must keep the original configuration file, i.e. the one used for
|
||||||
|
the installation. Otherwise, you will need to recreate it manually with the right information!
|
||||||
|
|
||||||
|
You can start the process as follows::
|
||||||
|
|
||||||
|
$ sudo ./run.py --backup <your domain>
|
||||||
|
|
||||||
|
Then follow the step on the console.
|
||||||
|
|
||||||
|
There is also a non-interactive mode:
|
||||||
|
|
||||||
|
1. Silent mode
|
||||||
|
|
||||||
|
Command::
|
||||||
|
|
||||||
|
$ sudo ./run.py --silent-backup <your domain>
|
||||||
|
|
||||||
|
This mode will run silently. When executed, it will create
|
||||||
|
/modoboa_backup/ and each time you execute it, it will create a new
|
||||||
|
backup directory with current date and time.
|
||||||
|
|
||||||
|
You can supply a custom path if needed::
|
||||||
|
|
||||||
|
$ sudo ./run.py --silent-backup --backup-path /path/of/backup/directory <your domain>
|
||||||
|
|
||||||
|
If you want to disable emails backup, disable dovecot in the
|
||||||
|
configuration file (set enabled to False).
|
||||||
|
|
||||||
|
This can be useful for larger instance.
|
||||||
|
|
||||||
|
Restore mode
|
||||||
|
------------
|
||||||
|
|
||||||
|
An experimental restore mode is available.
|
||||||
|
|
||||||
|
You can start the process as follows::
|
||||||
|
|
||||||
|
$ sudo ./run.py --restore /path/to/backup/directory/ <your domain>
|
||||||
|
|
||||||
|
Then wait for the process to finish.
|
||||||
|
|
||||||
Change the generated hostname
|
Change the generated hostname
|
||||||
-----------------------------
|
-----------------------------
|
||||||
|
|
||||||
@@ -135,7 +184,6 @@ modify the following settings::
|
|||||||
Change the ``email`` setting to a valid value since it will be used
|
Change the ``email`` setting to a valid value since it will be used
|
||||||
for account recovery.
|
for account recovery.
|
||||||
|
|
||||||
.. |travis| image:: https://travis-ci.org/modoboa/modoboa-installer.png?branch=master
|
.. |workflow| image:: https://github.com/modoboa/modoboa-installer/workflows/Modoboa%20installer/badge.svg
|
||||||
:target: https://travis-ci.org/modoboa/modoboa-installer
|
|
||||||
.. |codecov| image:: http://codecov.io/github/modoboa/modoboa-installer/coverage.svg?branch=master
|
.. |codecov| image:: http://codecov.io/github/modoboa/modoboa-installer/coverage.svg?branch=master
|
||||||
:target: http://codecov.io/github/modoboa/modoboa-installer?branch=master
|
:target: http://codecov.io/github/modoboa/modoboa-installer?branch=master
|
||||||
|
|||||||
@@ -1,6 +1,8 @@
|
|||||||
import random
|
import random
|
||||||
import string
|
import string
|
||||||
|
|
||||||
|
from .constants import DEFAULT_BACKUP_DIRECTORY
|
||||||
|
|
||||||
|
|
||||||
def make_password(length=16):
|
def make_password(length=16):
|
||||||
"""Create a random password."""
|
"""Create a random password."""
|
||||||
@@ -210,7 +212,7 @@ ConfigDictTemplate = [
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"option": "max_servers",
|
"option": "max_servers",
|
||||||
"default": "1",
|
"default": "2",
|
||||||
},
|
},
|
||||||
{
|
{
|
||||||
"option": "dbname",
|
"option": "dbname",
|
||||||
@@ -439,4 +441,13 @@ ConfigDictTemplate = [
|
|||||||
|
|
||||||
]
|
]
|
||||||
},
|
},
|
||||||
|
{
|
||||||
|
"name": "backup",
|
||||||
|
"values": [
|
||||||
|
{
|
||||||
|
"option": "default_path",
|
||||||
|
"default": DEFAULT_BACKUP_DIRECTORY
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
]
|
]
|
||||||
|
|||||||
1
modoboa_installer/constants.py
Normal file
1
modoboa_installer/constants.py
Normal file
@@ -0,0 +1 @@
|
|||||||
|
DEFAULT_BACKUP_DIRECTORY = "./modoboa_backup/"
|
||||||
@@ -42,7 +42,7 @@ class PostgreSQL(Database):
|
|||||||
default_port = 5432
|
default_port = 5432
|
||||||
packages = {
|
packages = {
|
||||||
"deb": ["postgresql", "postgresql-server-dev-all"],
|
"deb": ["postgresql", "postgresql-server-dev-all"],
|
||||||
"rpm": ["postgresql-server", "postgresql-devel"]
|
"rpm": ["postgresql-server", "postgresql-server-devel", "postgresql"]
|
||||||
}
|
}
|
||||||
service = "postgresql"
|
service = "postgresql"
|
||||||
|
|
||||||
@@ -54,19 +54,7 @@ class PostgreSQL(Database):
|
|||||||
"""Install database if required."""
|
"""Install database if required."""
|
||||||
name, version = utils.dist_info()
|
name, version = utils.dist_info()
|
||||||
if "CentOS" in name:
|
if "CentOS" in name:
|
||||||
if version.startswith("7"):
|
initdb_cmd = "postgresql-setup --initdb"
|
||||||
# Install newer version of postgres in this case
|
|
||||||
package.backend.install(
|
|
||||||
"https://download.postgresql.org/pub/repos/yum/"
|
|
||||||
"reporpms/EL-7-x86_64/pgdg-redhat-repo-latest.noarch.rpm"
|
|
||||||
)
|
|
||||||
self.packages["rpm"] = [
|
|
||||||
"postgresql10-server", "postgresql10-devel"]
|
|
||||||
self.service = "postgresql-10"
|
|
||||||
initdb_cmd = "/usr/pgsql-10/bin/postgresql-10-setup initdb"
|
|
||||||
cfgfile = "/var/lib/pgsql/10/data/pg_hba.conf"
|
|
||||||
else:
|
|
||||||
initdb_cmd = "postgresql-setup initdb"
|
|
||||||
cfgfile = "/var/lib/pgsql/data/pg_hba.conf"
|
cfgfile = "/var/lib/pgsql/data/pg_hba.conf"
|
||||||
package.backend.install_many(self.packages[package.backend.FORMAT])
|
package.backend.install_many(self.packages[package.backend.FORMAT])
|
||||||
utils.exec_cmd(initdb_cmd)
|
utils.exec_cmd(initdb_cmd)
|
||||||
@@ -146,6 +134,15 @@ class PostgreSQL(Database):
|
|||||||
self.dbhost, self.dbport, dbname, dbuser, path)
|
self.dbhost, self.dbport, dbname, dbuser, path)
|
||||||
utils.exec_cmd(cmd, sudo_user=self.dbuser)
|
utils.exec_cmd(cmd, sudo_user=self.dbuser)
|
||||||
|
|
||||||
|
def dump_database(self, dbname, dbuser, dbpassword, path):
|
||||||
|
"""Dump DB to SQL file."""
|
||||||
|
# Reset pgpass since we backup multiple db (different secret set)
|
||||||
|
self._pgpass_done = False
|
||||||
|
self._setup_pgpass(dbname, dbuser, dbpassword)
|
||||||
|
cmd = "pg_dump -h {} -d {} -U {} -O -w > {}".format(
|
||||||
|
self.dbhost, dbname, dbuser, path)
|
||||||
|
utils.exec_cmd(cmd, sudo_user=self.dbuser)
|
||||||
|
|
||||||
|
|
||||||
class MySQL(Database):
|
class MySQL(Database):
|
||||||
|
|
||||||
@@ -258,6 +255,12 @@ class MySQL(Database):
|
|||||||
self.dbhost, self.dbport, dbuser, dbpassword, dbname, path)
|
self.dbhost, self.dbport, dbuser, dbpassword, dbname, path)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
def dump_database(self, dbname, dbuser, dbpassword, path):
|
||||||
|
"""Dump DB to SQL file."""
|
||||||
|
cmd = "mysqldump -h {} -u {} -p{} {} > {}".format(
|
||||||
|
self.dbhost, dbuser, dbpassword, dbname, path)
|
||||||
|
utils.exec_cmd(cmd, sudo_user=self.dbuser)
|
||||||
|
|
||||||
|
|
||||||
def get_backend(config):
|
def get_backend(config):
|
||||||
"""Return appropriate backend."""
|
"""Return appropriate backend."""
|
||||||
|
|||||||
@@ -82,17 +82,27 @@ class RPMPackage(Package):
|
|||||||
|
|
||||||
def __init__(self, dist_name):
|
def __init__(self, dist_name):
|
||||||
"""Initialize backend."""
|
"""Initialize backend."""
|
||||||
|
self.dist_name = dist_name
|
||||||
super(RPMPackage, self).__init__(dist_name)
|
super(RPMPackage, self).__init__(dist_name)
|
||||||
if "centos" in dist_name:
|
|
||||||
|
def prepare_system(self):
|
||||||
|
if "centos" in self.dist_name:
|
||||||
|
utils.exec_cmd("dnf config-manager --set-enabled crb")
|
||||||
self.install("epel-release")
|
self.install("epel-release")
|
||||||
|
self.update()
|
||||||
|
|
||||||
|
def update(self):
|
||||||
|
"""Update the database repo."""
|
||||||
|
utils.exec_cmd("dnf update -y --quiet")
|
||||||
|
|
||||||
def install(self, name):
|
def install(self, name):
|
||||||
"""Install a package."""
|
"""Install a package."""
|
||||||
utils.exec_cmd("yum install -y --quiet {}".format(name))
|
"""Need to add check for rrdtool, sendmail-milter, libmemcached and --enablerepo=crb"""
|
||||||
|
utils.exec_cmd("dnf install -y --quiet {}".format(name))
|
||||||
|
|
||||||
def install_many(self, names):
|
def install_many(self, names):
|
||||||
"""Install many packages."""
|
"""Install many packages."""
|
||||||
return utils.exec_cmd("yum install -y --quiet {}".format(" ".join(names)))
|
return utils.exec_cmd("dnf install -y --quiet {}".format(" ".join(names)))
|
||||||
|
|
||||||
def get_installed_version(self, name):
|
def get_installed_version(self, name):
|
||||||
"""Get installed package version."""
|
"""Get installed package version."""
|
||||||
|
|||||||
@@ -6,20 +6,49 @@ import sys
|
|||||||
from .. import utils
|
from .. import utils
|
||||||
|
|
||||||
|
|
||||||
def install(appname, config, upgrade):
|
def load_app_script(appname):
|
||||||
"""Install an application."""
|
"""Load module corresponding to the given appname."""
|
||||||
if (config.has_option(appname, "enabled") and
|
|
||||||
not config.getboolean(appname, "enabled")):
|
|
||||||
return
|
|
||||||
utils.printcolor("Installing {}".format(appname), utils.MAGENTA)
|
|
||||||
try:
|
try:
|
||||||
script = importlib.import_module(
|
script = importlib.import_module(
|
||||||
"modoboa_installer.scripts.{}".format(appname))
|
"modoboa_installer.scripts.{}".format(appname))
|
||||||
except ImportError:
|
except ImportError:
|
||||||
print("Unknown application {}".format(appname))
|
print("Unknown application {}".format(appname))
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
return script
|
||||||
|
|
||||||
|
|
||||||
|
def install(appname: str, config, upgrade: bool, archive_path: str):
|
||||||
|
"""Install an application."""
|
||||||
|
if (config.has_option(appname, "enabled") and
|
||||||
|
not config.getboolean(appname, "enabled")):
|
||||||
|
return
|
||||||
|
|
||||||
|
utils.printcolor("Installing {}".format(appname), utils.MAGENTA)
|
||||||
|
script = load_app_script(appname)
|
||||||
try:
|
try:
|
||||||
getattr(script, appname.capitalize())(config, upgrade).run()
|
getattr(script, appname.capitalize())(config, upgrade, archive_path).run()
|
||||||
except utils.FatalError as inst:
|
except utils.FatalError as inst:
|
||||||
utils.printcolor(u"{}".format(inst), utils.RED)
|
utils.error("{}".format(inst))
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
def backup(appname, config, path):
|
||||||
|
"""Backup an application."""
|
||||||
|
if (config.has_option(appname, "enabled") and
|
||||||
|
not config.getboolean(appname, "enabled")):
|
||||||
|
return
|
||||||
|
|
||||||
|
utils.printcolor("Backing up {}".format(appname), utils.MAGENTA)
|
||||||
|
script = load_app_script(appname)
|
||||||
|
try:
|
||||||
|
getattr(script, appname.capitalize())(config, False, False).backup(path)
|
||||||
|
except utils.FatalError as inst:
|
||||||
|
utils.error("{}".format(inst))
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
|
||||||
|
def restore_prep(restore):
|
||||||
|
"""Restore instance"""
|
||||||
|
script = importlib.import_module(
|
||||||
|
"modoboa_installer.scripts.restore")
|
||||||
|
getattr(script, "Restore")(restore)
|
||||||
|
|||||||
@@ -1,13 +1,12 @@
|
|||||||
"""Amavis related functions."""
|
"""Amavis related functions."""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
import platform
|
|
||||||
|
|
||||||
from .. import package
|
from .. import package
|
||||||
from .. import utils
|
from .. import utils
|
||||||
|
|
||||||
from . import base
|
from . import base
|
||||||
from . import install
|
from . import backup, install
|
||||||
|
|
||||||
|
|
||||||
class Amavis(base.Installer):
|
class Amavis(base.Installer):
|
||||||
@@ -22,7 +21,7 @@ class Amavis(base.Installer):
|
|||||||
"unrar-free",
|
"unrar-free",
|
||||||
],
|
],
|
||||||
"rpm": [
|
"rpm": [
|
||||||
"amavisd-new", "arj", "lz4", "lzop", "p7zip",
|
"amavis", "arj", "lz4", "lzop", "p7zip",
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
with_db = True
|
with_db = True
|
||||||
@@ -93,5 +92,25 @@ class Amavis(base.Installer):
|
|||||||
|
|
||||||
def post_run(self):
|
def post_run(self):
|
||||||
"""Additional tasks."""
|
"""Additional tasks."""
|
||||||
install("spamassassin", self.config, self.upgrade)
|
install("spamassassin", self.config, self.upgrade, self.archive_path)
|
||||||
install("clamav", self.config, self.upgrade)
|
install("clamav", self.config, self.upgrade, self.archive_path)
|
||||||
|
|
||||||
|
def custom_backup(self, path):
|
||||||
|
"""Backup custom configuration if any."""
|
||||||
|
if package.backend.FORMAT == "deb":
|
||||||
|
amavis_custom = f"{self.config_dir}/conf.d/99-custom"
|
||||||
|
if os.path.isfile(amavis_custom):
|
||||||
|
utils.copy_file(amavis_custom, path)
|
||||||
|
utils.success("Amavis custom configuration saved!")
|
||||||
|
backup("spamassassin", self.config, os.path.dirname(path))
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore custom config files."""
|
||||||
|
if package.backend.FORMAT != "deb":
|
||||||
|
return
|
||||||
|
amavis_custom_configuration = os.path.join(
|
||||||
|
self.archive_path, "custom/99-custom")
|
||||||
|
if os.path.isfile(amavis_custom_configuration):
|
||||||
|
utils.copy_file(amavis_custom_configuration, os.path.join(
|
||||||
|
self.config_dir, "conf.d"))
|
||||||
|
utils.success("Custom amavis configuration restored.")
|
||||||
|
|||||||
231
modoboa_installer/scripts/backup.py
Normal file
231
modoboa_installer/scripts/backup.py
Normal file
@@ -0,0 +1,231 @@
|
|||||||
|
"""Backup script for pre-installed instance."""
|
||||||
|
|
||||||
|
import os
|
||||||
|
import pwd
|
||||||
|
import shutil
|
||||||
|
import stat
|
||||||
|
import sys
|
||||||
|
import datetime
|
||||||
|
|
||||||
|
from .. import database
|
||||||
|
from .. import utils
|
||||||
|
from ..constants import DEFAULT_BACKUP_DIRECTORY
|
||||||
|
|
||||||
|
|
||||||
|
class Backup:
|
||||||
|
"""
|
||||||
|
Backup structure ( {optional} ):
|
||||||
|
{{backup_directory}}
|
||||||
|
||
|
||||||
|
||--> installer.cfg
|
||||||
|
||--> custom
|
||||||
|
|--> { (copy of) /etc/amavis/conf.d/99-custom }
|
||||||
|
|--> { (copy of) /etc/postfix/custom_whitelist.cidr }
|
||||||
|
|--> { (copy of) dkim directory }
|
||||||
|
|--> {dkim.pem}...
|
||||||
|
|--> { (copy of) radicale home_dir }
|
||||||
|
||--> databases
|
||||||
|
|--> modoboa.sql
|
||||||
|
|--> { amavis.sql }
|
||||||
|
|--> { spamassassin.sql }
|
||||||
|
||--> mails
|
||||||
|
|--> vmails
|
||||||
|
"""
|
||||||
|
|
||||||
|
def __init__(self, config, silent_backup, backup_path, nomail):
|
||||||
|
self.config = config
|
||||||
|
self.backup_path = backup_path
|
||||||
|
self.nomail = nomail
|
||||||
|
self.silent_backup = silent_backup
|
||||||
|
|
||||||
|
def validate_path(self, path):
|
||||||
|
"""Check basic condition for backup directory."""
|
||||||
|
|
||||||
|
path_exists = os.path.exists(path)
|
||||||
|
|
||||||
|
if path_exists and os.path.isfile(path):
|
||||||
|
utils.printcolor(
|
||||||
|
"Error, you provided a file instead of a directory!", utils.RED)
|
||||||
|
return False
|
||||||
|
|
||||||
|
if not path_exists:
|
||||||
|
if not self.silent_backup:
|
||||||
|
create_dir = input(
|
||||||
|
f"\"{path}\" doesn't exist, would you like to create it? [Y/n]\n").lower()
|
||||||
|
|
||||||
|
if self.silent_backup or (not self.silent_backup and create_dir.startswith("y")):
|
||||||
|
pw = pwd.getpwnam("root")
|
||||||
|
utils.mkdir_safe(path, stat.S_IRWXU |
|
||||||
|
stat.S_IRWXG, pw[2], pw[3])
|
||||||
|
else:
|
||||||
|
utils.printcolor(
|
||||||
|
"Error, backup directory not present.", utils.RED
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
if len(os.listdir(path)) != 0:
|
||||||
|
if not self.silent_backup:
|
||||||
|
delete_dir = input(
|
||||||
|
"Warning: backup directory is not empty, it will be purged if you continue... [Y/n]\n").lower()
|
||||||
|
|
||||||
|
if self.silent_backup or (not self.silent_backup and delete_dir.startswith("y")):
|
||||||
|
try:
|
||||||
|
os.remove(os.path.join(path, "installer.cfg"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
shutil.rmtree(os.path.join(path, "custom"),
|
||||||
|
ignore_errors=False)
|
||||||
|
shutil.rmtree(os.path.join(path, "mails"), ignore_errors=False)
|
||||||
|
shutil.rmtree(os.path.join(path, "databases"),
|
||||||
|
ignore_errors=False)
|
||||||
|
else:
|
||||||
|
utils.printcolor(
|
||||||
|
"Error: backup directory not clean.", utils.RED
|
||||||
|
)
|
||||||
|
return False
|
||||||
|
|
||||||
|
self.backup_path = path
|
||||||
|
|
||||||
|
pw = pwd.getpwnam("root")
|
||||||
|
for dir in ["custom/", "databases/"]:
|
||||||
|
utils.mkdir_safe(os.path.join(self.backup_path, dir),
|
||||||
|
stat.S_IRWXU | stat.S_IRWXG, pw[2], pw[3])
|
||||||
|
return True
|
||||||
|
|
||||||
|
def set_path(self):
|
||||||
|
"""Setup backup directory."""
|
||||||
|
if self.silent_backup:
|
||||||
|
if self.backup_path is None:
|
||||||
|
if self.config.has_option("backup", "default_path"):
|
||||||
|
path = self.config.get("backup", "default_path")
|
||||||
|
else:
|
||||||
|
path = DEFAULT_BACKUP_DIRECTORY
|
||||||
|
date = datetime.datetime.now().strftime("%m_%d_%Y_%H_%M")
|
||||||
|
path = os.path.join(path, f"backup_{date}")
|
||||||
|
self.validate_path(path)
|
||||||
|
else:
|
||||||
|
if not self.validate_path(self.backup_path):
|
||||||
|
utils.printcolor(
|
||||||
|
f"Path provided: {self.backup_path}", utils.BLUE)
|
||||||
|
sys.exit(1)
|
||||||
|
else:
|
||||||
|
user_value = None
|
||||||
|
while user_value == "" or user_value is None or not self.validate_path(user_value):
|
||||||
|
utils.printcolor(
|
||||||
|
"Enter backup path (it must be an empty directory)", utils.MAGENTA)
|
||||||
|
utils.printcolor("CTRL+C to cancel", utils.MAGENTA)
|
||||||
|
user_value = utils.user_input("-> ")
|
||||||
|
|
||||||
|
def config_file_backup(self):
|
||||||
|
utils.copy_file("installer.cfg", self.backup_path)
|
||||||
|
|
||||||
|
def mail_backup(self):
|
||||||
|
if self.nomail:
|
||||||
|
utils.printcolor(
|
||||||
|
"Skipping mail backup, no-mail argument provided", utils.MAGENTA)
|
||||||
|
return
|
||||||
|
|
||||||
|
utils.printcolor("Backing up mails", utils.MAGENTA)
|
||||||
|
|
||||||
|
home_path = self.config.get("dovecot", "home_dir")
|
||||||
|
|
||||||
|
if not os.path.exists(home_path) or os.path.isfile(home_path):
|
||||||
|
utils.printcolor("Error backing up Email, provided path "
|
||||||
|
f" ({home_path}) seems not right...", utils.RED)
|
||||||
|
|
||||||
|
else:
|
||||||
|
dst = os.path.join(self.backup_path, "mails/")
|
||||||
|
|
||||||
|
if os.path.exists(dst):
|
||||||
|
shutil.rmtree(dst)
|
||||||
|
|
||||||
|
shutil.copytree(home_path, dst)
|
||||||
|
utils.printcolor("Mail backup complete!", utils.GREEN)
|
||||||
|
|
||||||
|
def custom_config_backup(self):
|
||||||
|
"""
|
||||||
|
Custom config :
|
||||||
|
- DKIM keys: {{keys_storage_dir}}
|
||||||
|
- Radicale collection (calendat, contacts): {{home_dir}}
|
||||||
|
- Amavis : /etc/amavis/conf.d/99-custom
|
||||||
|
- Postwhite : /etc/postwhite.conf
|
||||||
|
Feel free to suggest to add others!
|
||||||
|
"""
|
||||||
|
utils.printcolor(
|
||||||
|
"Backing up some custom configuration...", utils.MAGENTA)
|
||||||
|
|
||||||
|
custom_path = os.path.join(
|
||||||
|
self.backup_path, "custom")
|
||||||
|
|
||||||
|
# DKIM Key
|
||||||
|
if (self.config.has_option("opendkim", "enabled") and
|
||||||
|
self.config.getboolean("opendkim", "enabled")):
|
||||||
|
dkim_keys = self.config.get(
|
||||||
|
"opendkim", "keys_storage_dir", fallback="/var/lib/dkim")
|
||||||
|
if os.path.isdir(dkim_keys):
|
||||||
|
shutil.copytree(dkim_keys, os.path.join(custom_path, "dkim"))
|
||||||
|
utils.printcolor(
|
||||||
|
"DKIM keys saved!", utils.GREEN)
|
||||||
|
|
||||||
|
# Radicale Collections
|
||||||
|
if (self.config.has_option("radicale", "enabled") and
|
||||||
|
self.config.getboolean("radicale", "enabled")):
|
||||||
|
radicale_backup = os.path.join(self.config.get(
|
||||||
|
"radicale", "home_dir", fallback="/srv/radicale"), "collections")
|
||||||
|
if os.path.isdir(radicale_backup):
|
||||||
|
shutil.copytree(radicale_backup, os.path.join(
|
||||||
|
custom_path, "radicale"))
|
||||||
|
utils.printcolor("Radicale files saved", utils.GREEN)
|
||||||
|
|
||||||
|
# AMAVIS
|
||||||
|
if (self.config.has_option("amavis", "enabled") and
|
||||||
|
self.config.getboolean("amavis", "enabled")):
|
||||||
|
amavis_custom = "/etc/amavis/conf.d/99-custom"
|
||||||
|
if os.path.isfile(amavis_custom):
|
||||||
|
utils.copy_file(amavis_custom, custom_path)
|
||||||
|
utils.printcolor(
|
||||||
|
"Amavis custom configuration saved!", utils.GREEN)
|
||||||
|
|
||||||
|
# POSTWHITE
|
||||||
|
if (self.config.has_option("postwhite", "enabled") and
|
||||||
|
self.config.getboolean("postwhite", "enabled")):
|
||||||
|
postswhite_custom = "/etc/postwhite.conf"
|
||||||
|
if os.path.isfile(postswhite_custom):
|
||||||
|
utils.copy_file(postswhite_custom, custom_path)
|
||||||
|
utils.printcolor(
|
||||||
|
"Postwhite configuration saved!", utils.GREEN)
|
||||||
|
|
||||||
|
def database_backup(self):
|
||||||
|
"""Backing up databases"""
|
||||||
|
|
||||||
|
utils.printcolor("Backing up databases...", utils.MAGENTA)
|
||||||
|
|
||||||
|
self.database_dump("modoboa")
|
||||||
|
self.database_dump("amavis")
|
||||||
|
self.database_dump("spamassassin")
|
||||||
|
|
||||||
|
def database_dump(self, app_name):
|
||||||
|
|
||||||
|
dump_path = os.path.join(self.backup_path, "databases")
|
||||||
|
backend = database.get_backend(self.config)
|
||||||
|
|
||||||
|
if app_name == "modoboa" or (self.config.has_option(app_name, "enabled") and
|
||||||
|
self.config.getboolean(app_name, "enabled")):
|
||||||
|
dbname = self.config.get(app_name, "dbname")
|
||||||
|
dbuser = self.config.get(app_name, "dbuser")
|
||||||
|
dbpasswd = self.config.get(app_name, "dbpassword")
|
||||||
|
backend.dump_database(dbname, dbuser, dbpasswd,
|
||||||
|
os.path.join(dump_path, f"{app_name}.sql"))
|
||||||
|
|
||||||
|
def backup_completed(self):
|
||||||
|
utils.printcolor("Backup process done, your backup is available here:"
|
||||||
|
f"--> {self.backup_path}", utils.GREEN)
|
||||||
|
|
||||||
|
def run(self):
|
||||||
|
self.set_path()
|
||||||
|
self.config_file_backup()
|
||||||
|
self.mail_backup()
|
||||||
|
self.custom_config_backup()
|
||||||
|
self.database_backup()
|
||||||
|
self.backup_completed()
|
||||||
@@ -20,10 +20,11 @@ class Installer(object):
|
|||||||
with_db = False
|
with_db = False
|
||||||
config_files = []
|
config_files = []
|
||||||
|
|
||||||
def __init__(self, config, upgrade):
|
def __init__(self, config, upgrade: bool, archive_path: str):
|
||||||
"""Get configuration."""
|
"""Get configuration."""
|
||||||
self.config = config
|
self.config = config
|
||||||
self.upgrade = upgrade
|
self.upgrade = upgrade
|
||||||
|
self.archive_path = archive_path
|
||||||
if self.config.has_section(self.appname):
|
if self.config.has_section(self.appname):
|
||||||
self.app_config = dict(self.config.items(self.appname))
|
self.app_config = dict(self.config.items(self.appname))
|
||||||
self.dbengine = self.config.get("database", "engine")
|
self.dbengine = self.config.get("database", "engine")
|
||||||
@@ -53,6 +54,19 @@ class Installer(object):
|
|||||||
"""Return a schema to install."""
|
"""Return a schema to install."""
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
def get_sql_schema_from_backup(self):
|
||||||
|
"""Retrieve a dump path from a previous backup."""
|
||||||
|
utils.printcolor(
|
||||||
|
f"Trying to restore {self.appname} database from backup.",
|
||||||
|
utils.MAGENTA
|
||||||
|
)
|
||||||
|
database_backup_path = os.path.join(
|
||||||
|
self.archive_path, f"databases/{self.appname}.sql")
|
||||||
|
if os.path.isfile(database_backup_path):
|
||||||
|
utils.success(f"SQL dump found in backup for {self.appname}!")
|
||||||
|
return database_backup_path
|
||||||
|
return None
|
||||||
|
|
||||||
def get_file_path(self, fname):
|
def get_file_path(self, fname):
|
||||||
"""Return the absolute path of this file."""
|
"""Return the absolute path of this file."""
|
||||||
return os.path.abspath(
|
return os.path.abspath(
|
||||||
@@ -66,6 +80,10 @@ class Installer(object):
|
|||||||
return
|
return
|
||||||
self.backend.create_user(self.dbuser, self.dbpasswd)
|
self.backend.create_user(self.dbuser, self.dbpasswd)
|
||||||
self.backend.create_database(self.dbname, self.dbuser)
|
self.backend.create_database(self.dbname, self.dbuser)
|
||||||
|
schema = None
|
||||||
|
if self.archive_path:
|
||||||
|
schema = self.get_sql_schema_from_backup()
|
||||||
|
if not schema:
|
||||||
schema = self.get_sql_schema_path()
|
schema = self.get_sql_schema_path()
|
||||||
if schema:
|
if schema:
|
||||||
self.backend.load_sql_file(
|
self.backend.load_sql_file(
|
||||||
@@ -137,6 +155,20 @@ class Installer(object):
|
|||||||
dst = os.path.join(self.config_dir, dst)
|
dst = os.path.join(self.config_dir, dst)
|
||||||
utils.copy_from_template(src, dst, context)
|
utils.copy_from_template(src, dst, context)
|
||||||
|
|
||||||
|
def backup(self, path):
|
||||||
|
if self.with_db:
|
||||||
|
self._dump_database(path)
|
||||||
|
custom_backup_path = os.path.join(path, "custom")
|
||||||
|
self.custom_backup(custom_backup_path)
|
||||||
|
|
||||||
|
def custom_backup(self, path):
|
||||||
|
"""Override this method in subscripts to add custom backup content."""
|
||||||
|
pass
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore from a previous backup."""
|
||||||
|
pass
|
||||||
|
|
||||||
def get_daemon_name(self):
|
def get_daemon_name(self):
|
||||||
"""Return daemon name if defined."""
|
"""Return daemon name if defined."""
|
||||||
return self.daemon_name if self.daemon_name else self.appname
|
return self.daemon_name if self.daemon_name else self.appname
|
||||||
@@ -157,8 +189,17 @@ class Installer(object):
|
|||||||
self.setup_database()
|
self.setup_database()
|
||||||
self.install_config_files()
|
self.install_config_files()
|
||||||
self.post_run()
|
self.post_run()
|
||||||
|
if self.archive_path:
|
||||||
|
self.restore()
|
||||||
self.restart_daemon()
|
self.restart_daemon()
|
||||||
|
|
||||||
|
def _dump_database(self, backup_path: str):
|
||||||
|
"""Create a new database dump for this app."""
|
||||||
|
target_dir = os.path.join(backup_path, "databases")
|
||||||
|
target_file = os.path.join(target_dir, f"{self.appname}.sql")
|
||||||
|
self.backend.dump_database(
|
||||||
|
self.dbname, self.dbuser, self.dbpasswd, target_file)
|
||||||
|
|
||||||
def pre_run(self):
|
def pre_run(self):
|
||||||
"""Tasks to execute before the installer starts."""
|
"""Tasks to execute before the installer starts."""
|
||||||
pass
|
pass
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ class Clamav(base.Installer):
|
|||||||
packages = {
|
packages = {
|
||||||
"deb": ["clamav-daemon"],
|
"deb": ["clamav-daemon"],
|
||||||
"rpm": [
|
"rpm": [
|
||||||
"clamav", "clamav-update", "clamav-server", "clamav-server-systemd"
|
"clamav", "clamav-update", "clamd"
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
import glob
|
import glob
|
||||||
import os
|
import os
|
||||||
import pwd
|
import pwd
|
||||||
|
import shutil
|
||||||
|
|
||||||
from .. import database
|
from .. import database
|
||||||
from .. import package
|
from .. import package
|
||||||
@@ -26,7 +27,7 @@ class Dovecot(base.Installer):
|
|||||||
}
|
}
|
||||||
config_files = [
|
config_files = [
|
||||||
"dovecot.conf", "dovecot-dict-sql.conf.ext", "conf.d/10-ssl.conf",
|
"dovecot.conf", "dovecot-dict-sql.conf.ext", "conf.d/10-ssl.conf",
|
||||||
"conf.d/10-master.conf", "conf.d/20-lmtp.conf"]
|
"conf.d/10-master.conf", "conf.d/20-lmtp.conf", "conf.d/10-ssl-keys.try"]
|
||||||
with_user = True
|
with_user = True
|
||||||
|
|
||||||
def get_config_files(self):
|
def get_config_files(self):
|
||||||
@@ -58,9 +59,16 @@ class Dovecot(base.Installer):
|
|||||||
"""Additional variables."""
|
"""Additional variables."""
|
||||||
context = super(Dovecot, self).get_template_context()
|
context = super(Dovecot, self).get_template_context()
|
||||||
pw = pwd.getpwnam(self.user)
|
pw = pwd.getpwnam(self.user)
|
||||||
|
dovecot_package = {"deb": "dovecot-core", "rpm": "dovecot"}
|
||||||
|
ssl_protocol_parameter = "ssl_protocols"
|
||||||
|
if package.backend.get_installed_version(dovecot_package[package.backend.FORMAT]) > "2.3":
|
||||||
|
ssl_protocol_parameter = "ssl_min_protocol"
|
||||||
ssl_protocols = "!SSLv2 !SSLv3"
|
ssl_protocols = "!SSLv2 !SSLv3"
|
||||||
if package.backend.get_installed_version("openssl").startswith("1.1"):
|
if package.backend.get_installed_version("openssl").startswith("1.1") \
|
||||||
|
or package.backend.get_installed_version("openssl").startswith("3"):
|
||||||
ssl_protocols = "!SSLv3"
|
ssl_protocols = "!SSLv3"
|
||||||
|
if ssl_protocol_parameter == "ssl_min_protocol":
|
||||||
|
ssl_protocols = "TLSv1"
|
||||||
if "centos" in utils.dist_name():
|
if "centos" in utils.dist_name():
|
||||||
protocols = "protocols = imap lmtp sieve"
|
protocols = "protocols = imap lmtp sieve"
|
||||||
extra_protocols = self.config.get("dovecot", "extra_protocols")
|
extra_protocols = self.config.get("dovecot", "extra_protocols")
|
||||||
@@ -79,6 +87,7 @@ class Dovecot(base.Installer):
|
|||||||
"modoboa_dbpassword": self.config.get("modoboa", "dbpassword"),
|
"modoboa_dbpassword": self.config.get("modoboa", "dbpassword"),
|
||||||
"protocols": protocols,
|
"protocols": protocols,
|
||||||
"ssl_protocols": ssl_protocols,
|
"ssl_protocols": ssl_protocols,
|
||||||
|
"ssl_protocol_parameter": ssl_protocol_parameter,
|
||||||
"radicale_user": self.config.get("radicale", "user"),
|
"radicale_user": self.config.get("radicale", "user"),
|
||||||
"radicale_auth_socket_path": os.path.basename(
|
"radicale_auth_socket_path": os.path.basename(
|
||||||
self.config.get("dovecot", "radicale_auth_socket_path"))
|
self.config.get("dovecot", "radicale_auth_socket_path"))
|
||||||
@@ -125,3 +134,39 @@ class Dovecot(base.Installer):
|
|||||||
"service {} {} > /dev/null 2>&1".format(self.appname, action),
|
"service {} {} > /dev/null 2>&1".format(self.appname, action),
|
||||||
capture_output=False)
|
capture_output=False)
|
||||||
system.enable_service(self.get_daemon_name())
|
system.enable_service(self.get_daemon_name())
|
||||||
|
|
||||||
|
def backup(self, path):
|
||||||
|
"""Backup emails."""
|
||||||
|
home_dir = self.config.get("dovecot", "home_dir")
|
||||||
|
utils.printcolor("Backing up mails", utils.MAGENTA)
|
||||||
|
if not os.path.exists(home_dir) or os.path.isfile(home_dir):
|
||||||
|
utils.error("Error backing up emails, provided path "
|
||||||
|
f" ({home_dir}) seems not right...")
|
||||||
|
return
|
||||||
|
|
||||||
|
dst = os.path.join(path, "mails/")
|
||||||
|
if os.path.exists(dst):
|
||||||
|
shutil.rmtree(dst)
|
||||||
|
shutil.copytree(home_dir, dst)
|
||||||
|
utils.success("Mail backup complete!")
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore emails."""
|
||||||
|
home_dir = self.config.get("dovecot", "home_dir")
|
||||||
|
mail_dir = os.path.join(self.archive_path, "mails/")
|
||||||
|
if len(os.listdir(mail_dir)) > 0:
|
||||||
|
utils.success("Copying mail backup over dovecot directory.")
|
||||||
|
if os.path.exists(home_dir):
|
||||||
|
shutil.rmtree(home_dir)
|
||||||
|
shutil.copytree(mail_dir, home_dir)
|
||||||
|
# Resetting permission for vmail
|
||||||
|
for dirpath, dirnames, filenames in os.walk(home_dir):
|
||||||
|
shutil.chown(dirpath, self.user, self.user)
|
||||||
|
for filename in filenames:
|
||||||
|
shutil.chown(os.path.join(dirpath, filename),
|
||||||
|
self.user, self.user)
|
||||||
|
else:
|
||||||
|
utils.printcolor(
|
||||||
|
"It seems that emails were not backed up, skipping restoration.",
|
||||||
|
utils.MAGENTA
|
||||||
|
)
|
||||||
|
|||||||
@@ -0,0 +1,6 @@
|
|||||||
|
# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
|
||||||
|
# dropping root privileges, so keep the key file unreadable by anyone but
|
||||||
|
# root. Included doc/mkcert.sh can be used to easily generate self-signed
|
||||||
|
# certificate, just make sure to update the domains in dovecot-openssl.cnf
|
||||||
|
ssl_cert = <%tls_cert_file
|
||||||
|
ssl_key = <%tls_key_file
|
||||||
@@ -5,12 +5,11 @@
|
|||||||
# SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>
|
# SSL/TLS support: yes, no, required. <doc/wiki/SSL.txt>
|
||||||
#ssl = yes
|
#ssl = yes
|
||||||
|
|
||||||
# PEM encoded X.509 SSL/TLS certificate and private key. They're opened before
|
# Workarround https://github.com/modoboa/modoboa/issues/2570
|
||||||
# dropping root privileges, so keep the key file unreadable by anyone but
|
# We try to load the key and pass if it fails
|
||||||
# root. Included doc/mkcert.sh can be used to easily generate self-signed
|
# Keys require root permissions, standard commands would be blocked
|
||||||
# certificate, just make sure to update the domains in dovecot-openssl.cnf
|
# because dovecot can't load these cert
|
||||||
ssl_cert = <%tls_cert_file
|
!include_try /etc/dovecot/conf.d/10-ssl-keys.try
|
||||||
ssl_key = <%tls_key_file
|
|
||||||
|
|
||||||
# If key file is password protected, give the password here. Alternatively
|
# If key file is password protected, give the password here. Alternatively
|
||||||
# give it when starting dovecot with -p parameter. Since this file is often
|
# give it when starting dovecot with -p parameter. Since this file is often
|
||||||
@@ -41,7 +40,7 @@ ssl_key = <%tls_key_file
|
|||||||
#ssl_parameters_regenerate = 168
|
#ssl_parameters_regenerate = 168
|
||||||
|
|
||||||
# SSL protocols to use
|
# SSL protocols to use
|
||||||
ssl_protocols = %ssl_protocols
|
%ssl_protocol_parameter = %ssl_protocols
|
||||||
|
|
||||||
|
|
||||||
# SSL ciphers to use
|
# SSL ciphers to use
|
||||||
|
|||||||
@@ -30,7 +30,7 @@ INSTANCE=%{instance_path}
|
|||||||
*/30 * * * * root $PYTHON $INSTANCE/manage.py modo check_mx
|
*/30 * * * * root $PYTHON $INSTANCE/manage.py modo check_mx
|
||||||
|
|
||||||
# Public API communication
|
# Public API communication
|
||||||
0 * * * * root $PYTHON $INSTANCE/manage.py communicate_with_public_api
|
%{minutes} %{hours} * * * root $PYTHON $INSTANCE/manage.py communicate_with_public_api
|
||||||
|
|
||||||
# Generate DKIM keys (they will belong to the user running this job)
|
# Generate DKIM keys (they will belong to the user running this job)
|
||||||
%{opendkim_enabled}* * * * * %{opendkim_user} umask 077 && $PYTHON $INSTANCE/manage.py modo manage_dkim_keys
|
%{opendkim_enabled}* * * * * %{opendkim_user} umask 077 && $PYTHON $INSTANCE/manage.py modo manage_dkim_keys
|
||||||
|
|||||||
@@ -3,6 +3,7 @@
|
|||||||
import json
|
import json
|
||||||
import os
|
import os
|
||||||
import pwd
|
import pwd
|
||||||
|
import random
|
||||||
import shutil
|
import shutil
|
||||||
import stat
|
import stat
|
||||||
import sys
|
import sys
|
||||||
@@ -219,6 +220,7 @@ class Modoboa(base.Installer):
|
|||||||
context = super(Modoboa, self).get_template_context()
|
context = super(Modoboa, self).get_template_context()
|
||||||
extensions = self.config.get("modoboa", "extensions")
|
extensions = self.config.get("modoboa", "extensions")
|
||||||
extensions = extensions.split()
|
extensions = extensions.split()
|
||||||
|
random_hour = random.randint(0, 6)
|
||||||
context.update({
|
context.update({
|
||||||
"sudo_user": (
|
"sudo_user": (
|
||||||
"uwsgi" if package.backend.FORMAT == "rpm" else context["user"]
|
"uwsgi" if package.backend.FORMAT == "rpm" else context["user"]
|
||||||
@@ -228,6 +230,8 @@ class Modoboa(base.Installer):
|
|||||||
"radicale_enabled": (
|
"radicale_enabled": (
|
||||||
"" if "modoboa-radicale" in extensions else "#"),
|
"" if "modoboa-radicale" in extensions else "#"),
|
||||||
"opendkim_user": self.config.get("opendkim", "user"),
|
"opendkim_user": self.config.get("opendkim", "user"),
|
||||||
|
"minutes": random.randint(1, 59),
|
||||||
|
"hours" : f"{random_hour},{random_hour+12}"
|
||||||
})
|
})
|
||||||
return context
|
return context
|
||||||
|
|
||||||
|
|||||||
@@ -26,7 +26,7 @@ class Nginx(base.Installer):
|
|||||||
"app_instance_path": (
|
"app_instance_path": (
|
||||||
self.config.get(app, "instance_path")),
|
self.config.get(app, "instance_path")),
|
||||||
"uwsgi_socket_path": (
|
"uwsgi_socket_path": (
|
||||||
Uwsgi(self.config, self.upgrade).get_socket_path(app))
|
Uwsgi(self.config, self.upgrade, self.restore).get_socket_path(app))
|
||||||
})
|
})
|
||||||
return context
|
return context
|
||||||
|
|
||||||
|
|||||||
@@ -2,6 +2,7 @@
|
|||||||
|
|
||||||
import os
|
import os
|
||||||
import pwd
|
import pwd
|
||||||
|
import shutil
|
||||||
import stat
|
import stat
|
||||||
|
|
||||||
from .. import database
|
from .. import database
|
||||||
@@ -46,7 +47,7 @@ class Opendkim(base.Installer):
|
|||||||
stat.S_IROTH | stat.S_IXOTH,
|
stat.S_IROTH | stat.S_IXOTH,
|
||||||
target[1], target[2]
|
target[1], target[2]
|
||||||
)
|
)
|
||||||
super(Opendkim, self).install_config_files()
|
super().install_config_files()
|
||||||
|
|
||||||
def get_template_context(self):
|
def get_template_context(self):
|
||||||
"""Additional variables."""
|
"""Additional variables."""
|
||||||
@@ -81,13 +82,11 @@ class Opendkim(base.Installer):
|
|||||||
"""Additional tasks.
|
"""Additional tasks.
|
||||||
Check linux distribution (package deb, rpm), to adapt
|
Check linux distribution (package deb, rpm), to adapt
|
||||||
to config file location and syntax.
|
to config file location and syntax.
|
||||||
- update opendkim isocket port config
|
- update opendkim isocket port config for Debian based distro
|
||||||
- make sure opendkim starts after db service started
|
- make sure opendkim starts after db service started
|
||||||
"""
|
"""
|
||||||
if package.backend.FORMAT == "deb":
|
if package.backend.FORMAT == "deb":
|
||||||
params_file = "/etc/default/opendkim"
|
params_file = "/etc/default/opendkim"
|
||||||
else:
|
|
||||||
params_file = "/etc/opendkim.conf"
|
|
||||||
pattern = r"s/^(SOCKET=.*)/#\1/"
|
pattern = r"s/^(SOCKET=.*)/#\1/"
|
||||||
utils.exec_cmd(
|
utils.exec_cmd(
|
||||||
"perl -pi -e '{}' {}".format(pattern, params_file))
|
"perl -pi -e '{}' {}".format(pattern, params_file))
|
||||||
@@ -109,3 +108,24 @@ class Opendkim(base.Installer):
|
|||||||
"s/^After=(.*)$/After=$1 {}/".format(dbservice))
|
"s/^After=(.*)$/After=$1 {}/".format(dbservice))
|
||||||
utils.exec_cmd(
|
utils.exec_cmd(
|
||||||
"perl -pi -e '{}' /lib/systemd/system/opendkim.service".format(pattern))
|
"perl -pi -e '{}' /lib/systemd/system/opendkim.service".format(pattern))
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore keys."""
|
||||||
|
dkim_keys_backup = os.path.join(
|
||||||
|
self.archive_path, "custom/dkim")
|
||||||
|
if os.path.isdir(dkim_keys_backup):
|
||||||
|
for file in os.listdir(dkim_keys_backup):
|
||||||
|
file_path = os.path.join(dkim_keys_backup, file)
|
||||||
|
if os.path.isfile(file_path):
|
||||||
|
utils.copy_file(file_path, self.config.get(
|
||||||
|
"opendkim", "keys_storage_dir", fallback="/var/lib/dkim"))
|
||||||
|
utils.success("DKIM keys restored from backup")
|
||||||
|
|
||||||
|
def custom_backup(self, path):
|
||||||
|
"""Backup DKIM keys."""
|
||||||
|
storage_dir = self.config.get(
|
||||||
|
"opendkim", "keys_storage_dir", fallback="/var/lib/dkim")
|
||||||
|
if os.path.isdir(storage_dir):
|
||||||
|
shutil.copytree(storage_dir, os.path.join(path, "dkim"))
|
||||||
|
utils.printcolor(
|
||||||
|
"DKIM keys saved!", utils.GREEN)
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ from .. import package
|
|||||||
from .. import utils
|
from .. import utils
|
||||||
|
|
||||||
from . import base
|
from . import base
|
||||||
from . import install
|
from . import backup, install
|
||||||
|
|
||||||
|
|
||||||
class Postfix(base.Installer):
|
class Postfix(base.Installer):
|
||||||
@@ -34,17 +34,6 @@ class Postfix(base.Installer):
|
|||||||
|
|
||||||
def install_packages(self):
|
def install_packages(self):
|
||||||
"""Preconfigure postfix package installation."""
|
"""Preconfigure postfix package installation."""
|
||||||
if "centos" in utils.dist_name():
|
|
||||||
config = configparser.ConfigParser()
|
|
||||||
with open("/etc/yum.repos.d/CentOS-Base.repo") as fp:
|
|
||||||
config.read_file(fp)
|
|
||||||
config.set("centosplus", "enabled", "1")
|
|
||||||
config.set("centosplus", "includepkgs", "postfix-*")
|
|
||||||
config.set("base", "exclude", "postfix-*")
|
|
||||||
config.set("updates", "exclude", "postfix-*")
|
|
||||||
with open("/etc/yum.repos.d/CentOS-Base.repo", "w") as fp:
|
|
||||||
config.write(fp)
|
|
||||||
|
|
||||||
package.backend.preconfigure(
|
package.backend.preconfigure(
|
||||||
"postfix", "main_mailer_type", "select", "No configuration")
|
"postfix", "main_mailer_type", "select", "No configuration")
|
||||||
super(Postfix, self).install_packages()
|
super(Postfix, self).install_packages()
|
||||||
@@ -97,4 +86,8 @@ class Postfix(base.Installer):
|
|||||||
utils.exec_cmd("postalias {}".format(aliases_file))
|
utils.exec_cmd("postalias {}".format(aliases_file))
|
||||||
|
|
||||||
# Postwhite
|
# Postwhite
|
||||||
install("postwhite", self.config, self.upgrade)
|
install("postwhite", self.config, self.upgrade, self.archive_path)
|
||||||
|
|
||||||
|
def backup(self, path):
|
||||||
|
"""Launch postwhite backup."""
|
||||||
|
backup("postwhite", self.config, path)
|
||||||
|
|||||||
@@ -45,8 +45,26 @@ class Postwhite(base.Installer):
|
|||||||
"""Additionnal tasks."""
|
"""Additionnal tasks."""
|
||||||
install_dir = "/usr/local/bin"
|
install_dir = "/usr/local/bin"
|
||||||
self.install_from_archive(SPF_TOOLS_REPOSITORY, install_dir)
|
self.install_from_archive(SPF_TOOLS_REPOSITORY, install_dir)
|
||||||
postw_dir = self.install_from_archive(
|
self.postw_dir = self.install_from_archive(
|
||||||
POSTWHITE_REPOSITORY, install_dir)
|
POSTWHITE_REPOSITORY, install_dir)
|
||||||
utils.copy_file(os.path.join(postw_dir, "postwhite.conf"), "/etc")
|
postw_bin = os.path.join(self.postw_dir, "postwhite")
|
||||||
postw_bin = os.path.join(postw_dir, "postwhite")
|
|
||||||
utils.exec_cmd("{} /etc/postwhite.conf".format(postw_bin))
|
utils.exec_cmd("{} /etc/postwhite.conf".format(postw_bin))
|
||||||
|
|
||||||
|
def custom_backup(self, path):
|
||||||
|
"""Backup custom configuration if any."""
|
||||||
|
postswhite_custom = "/etc/postwhite.conf"
|
||||||
|
if os.path.isfile(postswhite_custom):
|
||||||
|
utils.copy_file(postswhite_custom, path)
|
||||||
|
utils.printcolor(
|
||||||
|
"Postwhite configuration saved!", utils.GREEN)
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore config files."""
|
||||||
|
postwhite_backup_configuration = os.path.join(
|
||||||
|
self.archive_path, "custom/postwhite.conf")
|
||||||
|
if os.path.isfile(postwhite_backup_configuration):
|
||||||
|
utils.copy_file(postwhite_backup_configuration, self.config_dir)
|
||||||
|
utils.success("postwhite.conf restored from backup")
|
||||||
|
else:
|
||||||
|
utils.copy_file(
|
||||||
|
os.path.join(self.postw_dir, "postwhite.conf"), self.config_dir)
|
||||||
|
|||||||
@@ -1,6 +1,7 @@
|
|||||||
"""Radicale related tasks."""
|
"""Radicale related tasks."""
|
||||||
|
|
||||||
import os
|
import os
|
||||||
|
import shutil
|
||||||
import stat
|
import stat
|
||||||
|
|
||||||
from .. import package
|
from .. import package
|
||||||
@@ -25,7 +26,7 @@ class Radicale(base.Installer):
|
|||||||
|
|
||||||
def __init__(self, *args, **kwargs):
|
def __init__(self, *args, **kwargs):
|
||||||
"""Get configuration."""
|
"""Get configuration."""
|
||||||
super(Radicale, self).__init__(*args, **kwargs)
|
super().__init__(*args, **kwargs)
|
||||||
self.venv_path = self.config.get("radicale", "venv_path")
|
self.venv_path = self.config.get("radicale", "venv_path")
|
||||||
|
|
||||||
def _setup_venv(self):
|
def _setup_venv(self):
|
||||||
@@ -70,7 +71,18 @@ class Radicale(base.Installer):
|
|||||||
stat.S_IROTH | stat.S_IXOTH,
|
stat.S_IROTH | stat.S_IXOTH,
|
||||||
0, 0
|
0, 0
|
||||||
)
|
)
|
||||||
super(Radicale, self).install_config_files()
|
super().install_config_files()
|
||||||
|
|
||||||
|
def restore(self):
|
||||||
|
"""Restore collections."""
|
||||||
|
radicale_backup = os.path.join(
|
||||||
|
self.archive_path, "custom/radicale")
|
||||||
|
if os.path.isdir(radicale_backup):
|
||||||
|
restore_target = os.path.join(self.home_dir, "collections")
|
||||||
|
if os.path.isdir(restore_target):
|
||||||
|
shutil.rmtree(restore_target)
|
||||||
|
shutil.copytree(radicale_backup, restore_target)
|
||||||
|
utils.success("Radicale collections restored from backup")
|
||||||
|
|
||||||
def post_run(self):
|
def post_run(self):
|
||||||
"""Additional tasks."""
|
"""Additional tasks."""
|
||||||
@@ -81,3 +93,12 @@ class Radicale(base.Installer):
|
|||||||
system.enable_service(daemon_name)
|
system.enable_service(daemon_name)
|
||||||
utils.exec_cmd("service {} stop".format(daemon_name))
|
utils.exec_cmd("service {} stop".format(daemon_name))
|
||||||
utils.exec_cmd("service {} start".format(daemon_name))
|
utils.exec_cmd("service {} start".format(daemon_name))
|
||||||
|
|
||||||
|
def custom_backup(self, path):
|
||||||
|
"""Backup collections."""
|
||||||
|
radicale_backup = os.path.join(self.config.get(
|
||||||
|
"radicale", "home_dir", fallback="/srv/radicale"), "collections")
|
||||||
|
if os.path.isdir(radicale_backup):
|
||||||
|
shutil.copytree(radicale_backup, os.path.join(
|
||||||
|
path, "radicale"))
|
||||||
|
utils.printcolor("Radicale files saved", utils.GREEN)
|
||||||
|
|||||||
26
modoboa_installer/scripts/restore.py
Normal file
26
modoboa_installer/scripts/restore.py
Normal file
@@ -0,0 +1,26 @@
|
|||||||
|
import os
|
||||||
|
import sys
|
||||||
|
from .. import utils
|
||||||
|
|
||||||
|
|
||||||
|
class Restore:
|
||||||
|
def __init__(self, restore):
|
||||||
|
"""
|
||||||
|
Restoring pre-check (backup integriety)
|
||||||
|
REQUIRED : modoboa.sql
|
||||||
|
OPTIONAL : mails/, custom/, amavis.sql, spamassassin.sql
|
||||||
|
Only checking required
|
||||||
|
"""
|
||||||
|
|
||||||
|
if not os.path.isdir(restore):
|
||||||
|
utils.printcolor(
|
||||||
|
"Provided path is not a directory !", utils.RED)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
modoba_sql_file = os.path.join(restore, "databases/modoboa.sql")
|
||||||
|
if not os.path.isfile(modoba_sql_file):
|
||||||
|
utils.printcolor(
|
||||||
|
modoba_sql_file + " not found, please check your backup", utils.RED)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
# Everything seems alright here, proceeding...
|
||||||
@@ -59,11 +59,7 @@ class Spamassassin(base.Installer):
|
|||||||
"""Additional tasks."""
|
"""Additional tasks."""
|
||||||
amavis_user = self.config.get("amavis", "user")
|
amavis_user = self.config.get("amavis", "user")
|
||||||
pw = pwd.getpwnam(amavis_user)
|
pw = pwd.getpwnam(amavis_user)
|
||||||
utils.exec_cmd(
|
install("razor", self.config, self.upgrade, self.archive_path)
|
||||||
"pyzor --homedir {} discover".format(pw[5]),
|
|
||||||
sudo_user=amavis_user, login=False
|
|
||||||
)
|
|
||||||
install("razor", self.config, self.upgrade)
|
|
||||||
if utils.dist_name() in ["debian", "ubuntu"]:
|
if utils.dist_name() in ["debian", "ubuntu"]:
|
||||||
utils.exec_cmd(
|
utils.exec_cmd(
|
||||||
"perl -pi -e 's/^CRON=0/CRON=1/' /etc/cron.daily/spamassassin")
|
"perl -pi -e 's/^CRON=0/CRON=1/' /etc/cron.daily/spamassassin")
|
||||||
|
|||||||
@@ -17,7 +17,7 @@ class Uwsgi(base.Installer):
|
|||||||
appname = "uwsgi"
|
appname = "uwsgi"
|
||||||
packages = {
|
packages = {
|
||||||
"deb": ["uwsgi", "uwsgi-plugin-python3"],
|
"deb": ["uwsgi", "uwsgi-plugin-python3"],
|
||||||
"rpm": ["uwsgi", "uwsgi-plugin-python36"],
|
"rpm": ["uwsgi", "uwsgi-plugin-python3"],
|
||||||
}
|
}
|
||||||
|
|
||||||
def get_socket_path(self, app):
|
def get_socket_path(self, app):
|
||||||
@@ -29,10 +29,7 @@ class Uwsgi(base.Installer):
|
|||||||
def get_template_context(self, app):
|
def get_template_context(self, app):
|
||||||
"""Additionnal variables."""
|
"""Additionnal variables."""
|
||||||
context = super(Uwsgi, self).get_template_context()
|
context = super(Uwsgi, self).get_template_context()
|
||||||
if package.backend.FORMAT == "deb":
|
|
||||||
uwsgi_plugin = "python3"
|
uwsgi_plugin = "python3"
|
||||||
else:
|
|
||||||
uwsgi_plugin = "python36"
|
|
||||||
context.update({
|
context.update({
|
||||||
"app_user": self.config.get(app, "user"),
|
"app_user": self.config.get(app, "user"),
|
||||||
"app_venv_path": self.config.get(app, "venv_path"),
|
"app_venv_path": self.config.get(app, "venv_path"),
|
||||||
|
|||||||
@@ -97,7 +97,7 @@ class LetsEncryptCertificate(CertificateBackend):
|
|||||||
self.config.has_option("nginx", "enabled") and
|
self.config.has_option("nginx", "enabled") and
|
||||||
self.config.getboolean("nginx", "enabled")
|
self.config.getboolean("nginx", "enabled")
|
||||||
):
|
):
|
||||||
if name == "ubuntu" or name.startswith("debian"):
|
if name == "ubuntu" or name.startswith("debian") or ("Centos" in name and version.startswith("9")):
|
||||||
package.backend.install("python3-certbot-nginx")
|
package.backend.install("python3-certbot-nginx")
|
||||||
|
|
||||||
def generate_cert(self):
|
def generate_cert(self):
|
||||||
|
|||||||
@@ -2,10 +2,13 @@
|
|||||||
|
|
||||||
import contextlib
|
import contextlib
|
||||||
import datetime
|
import datetime
|
||||||
|
import getpass
|
||||||
import glob
|
import glob
|
||||||
import os
|
import os
|
||||||
|
import pwd
|
||||||
import random
|
import random
|
||||||
import shutil
|
import shutil
|
||||||
|
import stat
|
||||||
import string
|
import string
|
||||||
import subprocess
|
import subprocess
|
||||||
import sys
|
import sys
|
||||||
@@ -107,6 +110,13 @@ def mkdir(path, mode, uid, gid):
|
|||||||
os.chown(path, uid, gid)
|
os.chown(path, uid, gid)
|
||||||
|
|
||||||
|
|
||||||
|
def mkdir_safe(path, mode, uid, gid):
|
||||||
|
"""Create a directory. Safe way (-p)"""
|
||||||
|
if not os.path.exists(path):
|
||||||
|
os.makedirs(os.path.abspath(path), mode)
|
||||||
|
mkdir(path, mode, uid, gid)
|
||||||
|
|
||||||
|
|
||||||
def make_password(length=16):
|
def make_password(length=16):
|
||||||
"""Create a random password."""
|
"""Create a random password."""
|
||||||
return "".join(
|
return "".join(
|
||||||
@@ -163,19 +173,32 @@ def copy_from_template(template, dest, context):
|
|||||||
fp.write(ConfigFileTemplate(buf).substitute(context))
|
fp.write(ConfigFileTemplate(buf).substitute(context))
|
||||||
|
|
||||||
|
|
||||||
def check_config_file(dest, interactive=False, upgrade=False):
|
def check_config_file(dest, interactive=False, upgrade=False, backup=False, restore=False):
|
||||||
"""Create a new installer config file if needed."""
|
"""Create a new installer config file if needed."""
|
||||||
|
is_present = True
|
||||||
if os.path.exists(dest):
|
if os.path.exists(dest):
|
||||||
return
|
return is_present
|
||||||
if upgrade:
|
if upgrade:
|
||||||
printcolor(
|
printcolor(
|
||||||
"You cannot upgrade an existing installation without a "
|
"You cannot upgrade an existing installation without a "
|
||||||
"configuration file.", RED)
|
"configuration file.", RED)
|
||||||
sys.exit(1)
|
sys.exit(1)
|
||||||
|
elif backup:
|
||||||
|
is_present = False
|
||||||
|
printcolor(
|
||||||
|
"Your configuration file hasn't been found. A new one will be generated. "
|
||||||
|
"Please edit it with correct password for the databases !", RED)
|
||||||
|
elif restore:
|
||||||
|
printcolor(
|
||||||
|
"You cannot restore an existing installation without a "
|
||||||
|
f"configuration file. (file : {dest} has not been found...", RED)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
printcolor(
|
printcolor(
|
||||||
"Configuration file {} not found, creating new one."
|
"Configuration file {} not found, creating new one."
|
||||||
.format(dest), YELLOW)
|
.format(dest), YELLOW)
|
||||||
gen_config(dest, interactive)
|
gen_config(dest, interactive)
|
||||||
|
return is_present
|
||||||
|
|
||||||
|
|
||||||
def has_colours(stream):
|
def has_colours(stream):
|
||||||
@@ -203,6 +226,16 @@ def printcolor(message, color):
|
|||||||
print(message)
|
print(message)
|
||||||
|
|
||||||
|
|
||||||
|
def error(message):
|
||||||
|
"""Print error message."""
|
||||||
|
printcolor(message, RED)
|
||||||
|
|
||||||
|
|
||||||
|
def success(message):
|
||||||
|
"""Print success message."""
|
||||||
|
printcolor(message, GREEN)
|
||||||
|
|
||||||
|
|
||||||
def convert_version_to_int(version):
|
def convert_version_to_int(version):
|
||||||
"""Convert a version string to an integer."""
|
"""Convert a version string to an integer."""
|
||||||
number_bits = (8, 8, 16)
|
number_bits = (8, 8, 16)
|
||||||
@@ -307,3 +340,62 @@ def gen_config(dest, interactive=False):
|
|||||||
|
|
||||||
with open(dest, "w") as configfile:
|
with open(dest, "w") as configfile:
|
||||||
config.write(configfile)
|
config.write(configfile)
|
||||||
|
|
||||||
|
# Set file owner to running user and group, and set config file permission to 600
|
||||||
|
current_username = getpass.getuser()
|
||||||
|
current_user = pwd.getpwnam(current_username)
|
||||||
|
os.chown(dest, current_user[2], current_user[3])
|
||||||
|
os.chmod(dest, stat.S_IRUSR | stat.S_IWUSR)
|
||||||
|
|
||||||
|
|
||||||
|
def validate_backup_path(path: str, silent_mode: bool):
|
||||||
|
"""Check if provided backup path is valid or not."""
|
||||||
|
path_exists = os.path.exists(path)
|
||||||
|
if path_exists and os.path.isfile(path):
|
||||||
|
printcolor(
|
||||||
|
"Error, you provided a file instead of a directory!", RED)
|
||||||
|
return None
|
||||||
|
|
||||||
|
if not path_exists:
|
||||||
|
if not silent_mode:
|
||||||
|
create_dir = input(
|
||||||
|
f"\"{path}\" doesn't exist, would you like to create it? [Y/n]\n"
|
||||||
|
).lower()
|
||||||
|
|
||||||
|
if silent_mode or (not silent_mode and create_dir.startswith("y")):
|
||||||
|
pw = pwd.getpwnam("root")
|
||||||
|
mkdir_safe(path, stat.S_IRWXU | stat.S_IRWXG, pw[2], pw[3])
|
||||||
|
else:
|
||||||
|
printcolor(
|
||||||
|
"Error, backup directory not present.", RED
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
if len(os.listdir(path)) != 0:
|
||||||
|
if not silent_mode:
|
||||||
|
delete_dir = input(
|
||||||
|
"Warning: backup directory is not empty, it will be purged if you continue... [Y/n]\n").lower()
|
||||||
|
|
||||||
|
if silent_mode or (not silent_mode and delete_dir.startswith("y")):
|
||||||
|
try:
|
||||||
|
os.remove(os.path.join(path, "installer.cfg"))
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
shutil.rmtree(os.path.join(path, "custom"),
|
||||||
|
ignore_errors=False)
|
||||||
|
shutil.rmtree(os.path.join(path, "mails"), ignore_errors=False)
|
||||||
|
shutil.rmtree(os.path.join(path, "databases"),
|
||||||
|
ignore_errors=False)
|
||||||
|
else:
|
||||||
|
printcolor(
|
||||||
|
"Error: backup directory not clean.", RED
|
||||||
|
)
|
||||||
|
return None
|
||||||
|
|
||||||
|
backup_path = path
|
||||||
|
pw = pwd.getpwnam("root")
|
||||||
|
for dir in ["custom/", "databases/"]:
|
||||||
|
mkdir_safe(os.path.join(backup_path, dir),
|
||||||
|
stat.S_IRWXU | stat.S_IRWXG, pw[2], pw[3])
|
||||||
|
return backup_path
|
||||||
|
|||||||
153
run.py
153
run.py
@@ -3,6 +3,8 @@
|
|||||||
"""An installer for Modoboa."""
|
"""An installer for Modoboa."""
|
||||||
|
|
||||||
import argparse
|
import argparse
|
||||||
|
import datetime
|
||||||
|
import os
|
||||||
try:
|
try:
|
||||||
import configparser
|
import configparser
|
||||||
except ImportError:
|
except ImportError:
|
||||||
@@ -10,6 +12,7 @@ except ImportError:
|
|||||||
import sys
|
import sys
|
||||||
|
|
||||||
from modoboa_installer import compatibility_matrix
|
from modoboa_installer import compatibility_matrix
|
||||||
|
from modoboa_installer import constants
|
||||||
from modoboa_installer import package
|
from modoboa_installer import package
|
||||||
from modoboa_installer import scripts
|
from modoboa_installer import scripts
|
||||||
from modoboa_installer import ssl
|
from modoboa_installer import ssl
|
||||||
@@ -17,6 +20,19 @@ from modoboa_installer import system
|
|||||||
from modoboa_installer import utils
|
from modoboa_installer import utils
|
||||||
|
|
||||||
|
|
||||||
|
PRIMARY_APPS = [
|
||||||
|
"amavis",
|
||||||
|
"modoboa",
|
||||||
|
"automx",
|
||||||
|
"radicale",
|
||||||
|
"uwsgi",
|
||||||
|
"nginx",
|
||||||
|
"opendkim",
|
||||||
|
"postfix",
|
||||||
|
"dovecot"
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
def installation_disclaimer(args, config):
|
def installation_disclaimer(args, config):
|
||||||
"""Display installation disclaimer."""
|
"""Display installation disclaimer."""
|
||||||
hostname = config.get("general", "hostname")
|
hostname = config.get("general", "hostname")
|
||||||
@@ -45,6 +61,60 @@ def upgrade_disclaimer(config):
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def backup_disclaimer():
|
||||||
|
"""Display backup disclamer. """
|
||||||
|
utils.printcolor(
|
||||||
|
"Your mail server will be backed up locally.\n"
|
||||||
|
" !! You should really transfer the backup somewhere else...\n"
|
||||||
|
" !! Custom configuration (like for postfix) won't be saved.", utils.BLUE)
|
||||||
|
|
||||||
|
|
||||||
|
def restore_disclaimer():
|
||||||
|
"""Display restore disclamer. """
|
||||||
|
utils.printcolor(
|
||||||
|
"You are about to restore a previous installation of Modoboa.\n"
|
||||||
|
"If a new version has been released in between, please update your database!",
|
||||||
|
utils.BLUE)
|
||||||
|
|
||||||
|
|
||||||
|
def backup_system(config, args):
|
||||||
|
"""Launch backup procedure."""
|
||||||
|
backup_disclaimer()
|
||||||
|
backup_path = None
|
||||||
|
if args.silent_backup:
|
||||||
|
if not args.backup_path:
|
||||||
|
if config.has_option("backup", "default_path"):
|
||||||
|
path = config.get("backup", "default_path")
|
||||||
|
else:
|
||||||
|
path = constants.DEFAULT_BACKUP_DIRECTORY
|
||||||
|
date = datetime.datetime.now().strftime("%m_%d_%Y_%H_%M")
|
||||||
|
path = os.path.join(path, f"backup_{date}")
|
||||||
|
else:
|
||||||
|
path = args.backup_path
|
||||||
|
backup_path = utils.validate_backup_path(path, args.silent_backup)
|
||||||
|
if not backup_path:
|
||||||
|
utils.printcolor(f"Path provided: {path}", utils.BLUE)
|
||||||
|
return
|
||||||
|
else:
|
||||||
|
user_value = None
|
||||||
|
while not user_value or not backup_path:
|
||||||
|
utils.printcolor(
|
||||||
|
"Enter backup path (it must be an empty directory)",
|
||||||
|
utils.MAGENTA
|
||||||
|
)
|
||||||
|
utils.printcolor("CTRL+C to cancel", utils.MAGENTA)
|
||||||
|
user_value = utils.user_input("-> ")
|
||||||
|
if not user_value:
|
||||||
|
continue
|
||||||
|
backup_path = utils.validate_backup_path(user_value, args.silent_backup)
|
||||||
|
|
||||||
|
# Backup configuration file
|
||||||
|
utils.copy_file(args.configfile, backup_path)
|
||||||
|
# Backup applications
|
||||||
|
for app in PRIMARY_APPS:
|
||||||
|
scripts.backup(app, config, backup_path)
|
||||||
|
|
||||||
|
|
||||||
def main(input_args):
|
def main(input_args):
|
||||||
"""Install process."""
|
"""Install process."""
|
||||||
parser = argparse.ArgumentParser()
|
parser = argparse.ArgumentParser()
|
||||||
@@ -72,16 +142,52 @@ def main(input_args):
|
|||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
"--beta", action="store_true", default=False,
|
"--beta", action="store_true", default=False,
|
||||||
help="Install latest beta release of Modoboa instead of the stable one")
|
help="Install latest beta release of Modoboa instead of the stable one")
|
||||||
|
parser.add_argument(
|
||||||
|
"--backup-path", type=str, metavar="path",
|
||||||
|
help="To use with --silent-backup, you must provide a valid path")
|
||||||
|
parser.add_argument(
|
||||||
|
"--backup", action="store_true", default=False,
|
||||||
|
help="Backing up interactively previously installed instance"
|
||||||
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
"--silent-backup", action="store_true", default=False,
|
||||||
|
help="For script usage, do not require user interaction "
|
||||||
|
"backup will be saved at ./modoboa_backup/Backup_M_Y_d_H_M if --backup-path is not provided")
|
||||||
|
parser.add_argument(
|
||||||
|
"--restore", type=str, metavar="path",
|
||||||
|
help="Restore a previously backup up modoboa instance on a NEW machine. "
|
||||||
|
"You MUST provide backup directory"
|
||||||
|
)
|
||||||
parser.add_argument("domain", type=str,
|
parser.add_argument("domain", type=str,
|
||||||
help="The main domain of your future mail server")
|
help="The main domain of your future mail server")
|
||||||
args = parser.parse_args(input_args)
|
args = parser.parse_args(input_args)
|
||||||
|
|
||||||
if args.debug:
|
if args.debug:
|
||||||
utils.ENV["debug"] = True
|
utils.ENV["debug"] = True
|
||||||
utils.printcolor("Welcome to Modoboa installer!\n", utils.GREEN)
|
|
||||||
utils.check_config_file(args.configfile, args.interactive, args.upgrade)
|
# Restore prep
|
||||||
|
is_restoring = False
|
||||||
|
if args.restore is not None:
|
||||||
|
is_restoring = True
|
||||||
|
args.configfile = os.path.join(args.restore, args.configfile)
|
||||||
|
if not os.path.exists(args.configfile):
|
||||||
|
utils.error(
|
||||||
|
"Installer configuration file not found in backup!"
|
||||||
|
)
|
||||||
|
sys.exit(1)
|
||||||
|
|
||||||
|
utils.success("Welcome to Modoboa installer!\n")
|
||||||
|
is_config_file_available = utils.check_config_file(
|
||||||
|
args.configfile, args.interactive, args.upgrade, args.backup, is_restoring)
|
||||||
|
|
||||||
|
if not is_config_file_available and (
|
||||||
|
args.upgrade or args.backup or args.silent_backup):
|
||||||
|
utils.error("No config file found.")
|
||||||
|
return
|
||||||
|
|
||||||
if args.stop_after_configfile_check:
|
if args.stop_after_configfile_check:
|
||||||
return
|
return
|
||||||
|
|
||||||
config = configparser.ConfigParser()
|
config = configparser.ConfigParser()
|
||||||
with open(args.configfile) as fp:
|
with open(args.configfile) as fp:
|
||||||
config.read_file(fp)
|
config.read_file(fp)
|
||||||
@@ -91,11 +197,20 @@ def main(input_args):
|
|||||||
config.set("dovecot", "domain", args.domain)
|
config.set("dovecot", "domain", args.domain)
|
||||||
config.set("modoboa", "version", args.version)
|
config.set("modoboa", "version", args.version)
|
||||||
config.set("modoboa", "install_beta", str(args.beta))
|
config.set("modoboa", "install_beta", str(args.beta))
|
||||||
|
|
||||||
|
if args.backup or args.silent_backup:
|
||||||
|
backup_system(config, args)
|
||||||
|
return
|
||||||
|
|
||||||
# Display disclaimer python 3 linux distribution
|
# Display disclaimer python 3 linux distribution
|
||||||
if not args.upgrade:
|
if args.upgrade:
|
||||||
installation_disclaimer(args, config)
|
|
||||||
else:
|
|
||||||
upgrade_disclaimer(config)
|
upgrade_disclaimer(config)
|
||||||
|
elif args.restore:
|
||||||
|
restore_disclaimer()
|
||||||
|
scripts.restore_prep(args.restore)
|
||||||
|
else:
|
||||||
|
installation_disclaimer(args, config)
|
||||||
|
|
||||||
# Show concerned components
|
# Show concerned components
|
||||||
components = []
|
components = []
|
||||||
for section in config.sections():
|
for section in config.sections():
|
||||||
@@ -115,27 +230,29 @@ def main(input_args):
|
|||||||
utils.printcolor(
|
utils.printcolor(
|
||||||
"The process can be long, feel free to take a coffee "
|
"The process can be long, feel free to take a coffee "
|
||||||
"and come back later ;)", utils.BLUE)
|
"and come back later ;)", utils.BLUE)
|
||||||
utils.printcolor("Starting...", utils.GREEN)
|
utils.success("Starting...")
|
||||||
package.backend.prepare_system()
|
package.backend.prepare_system()
|
||||||
package.backend.install_many(["sudo", "wget"])
|
package.backend.install_many(["sudo", "wget"])
|
||||||
ssl_backend = ssl.get_backend(config)
|
ssl_backend = ssl.get_backend(config)
|
||||||
if ssl_backend and not args.upgrade:
|
if ssl_backend and not args.upgrade:
|
||||||
ssl_backend.generate_cert()
|
ssl_backend.generate_cert()
|
||||||
scripts.install("amavis", config, args.upgrade)
|
for appname in PRIMARY_APPS:
|
||||||
scripts.install("modoboa", config, args.upgrade)
|
scripts.install(appname, config, args.upgrade, args.restore)
|
||||||
scripts.install("automx", config, args.upgrade)
|
if package.backend.FORMAT == "deb":
|
||||||
scripts.install("radicale", config, args.upgrade)
|
|
||||||
scripts.install("uwsgi", config, args.upgrade)
|
|
||||||
scripts.install("nginx", config, args.upgrade)
|
|
||||||
scripts.install("opendkim", config, args.upgrade)
|
|
||||||
scripts.install("postfix", config, args.upgrade)
|
|
||||||
scripts.install("dovecot", config, args.upgrade)
|
|
||||||
system.restart_service("cron")
|
system.restart_service("cron")
|
||||||
|
else:
|
||||||
|
system.restart_service("crond")
|
||||||
package.backend.restore_system()
|
package.backend.restore_system()
|
||||||
utils.printcolor(
|
if not args.restore:
|
||||||
|
utils.success(
|
||||||
"Congratulations! You can enjoy Modoboa at https://{} (admin:password)"
|
"Congratulations! You can enjoy Modoboa at https://{} (admin:password)"
|
||||||
.format(config.get("general", "hostname")),
|
.format(config.get("general", "hostname"))
|
||||||
utils.GREEN)
|
)
|
||||||
|
else:
|
||||||
|
utils.success(
|
||||||
|
"Restore complete! You can enjoy Modoboa at https://{} (same credentials as before)"
|
||||||
|
.format(config.get("general", "hostname"))
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
if __name__ == "__main__":
|
if __name__ == "__main__":
|
||||||
|
|||||||
Reference in New Issue
Block a user