Installation

Install from PyPI

  1. Install dependencies:

    Required packages on Ubuntu 18.04:

    sudo apt-get install python3-virtualenv python3.8 python3.8-dev gcc libffi-dev libkrb5-dev libffi6 libssl-dev libyaml-dev libsasl2-dev libldap2-dev default-libmysqlclient-dev sshpass git virtualenv
    

    Required packages on Ubuntu 20.04:

    sudo apt-get install python3-virtualenv python3.8 python3.8-dev gcc libffi-dev libkrb5-dev libffi7 libssl-dev libyaml-dev libsasl2-dev libldap2-dev default-libmysqlclient-dev sshpass git
    

    Required packages on Ubuntu 22.04:

    sudo apt-get install python3-virtualenv python3.10 python3.10-dev gcc libffi-dev libkrb5-dev libffi7 libssl-dev libyaml-dev libsasl2-dev libldap2-dev default-libmysqlclient-dev sshpass git
    

    Required packages on Debian 11 (as root user):

    apt-get install python3-virtualenv python3.9 python3.9-dev gcc libffi-dev libkrb5-dev libffi7 libssl-dev libyaml-dev libsasl2-dev libldap2-dev default-libmysqlclient-dev sshpass git
    

    Required packages on Red Hat/CentOS 7 (sqlite not supported):

    sudo yum install epel-release centos-release-scl-rh centos-release-scl
    sudo yum --enablerepo=centos-sclo-rh install rh-python38 rh-python38-python-devel gcc openssl-devel libyaml-devel krb5-devel krb5-libs openldap-devel mysql-devel git sshpass
    sudo /opt/rh/rh-python38/root/usr/bin/python -m pip install virtualenv
    

    Required packages on Red Hat/Alma/Rocky 8:

    sudo dnf install epel-release
    sudo dnf install python38-devel python3-virtualenv gcc openssl-devel libyaml krb5-devel krb5-libs openldap-devel mysql-devel git sshpass
    

    Note

    If your OS is not in the list of presented OS, but you understand the differences between these OS and yours, then you can adapt this list of packages to your platform. We dont tie environment to system package versions as much as possible.

  2. Install mysql-server:

    The following command is suitable for Debian and Ubuntu. If you have a different operation system, you can use official documentation.

    sudo apt-get install default-mysql-server
    

    Warning

    Do not use MySQL version less then 8.0.

  3. Create database in mysql with this commands:

    sudo -H mysql <<QUERY_INPUT
    # uncomment this string on old MariaDB/MySQL versions
    # SET @@global.innodb_large_prefix = 1;
    create user db_user identified by 'db_password';
    create database db_name default CHARACTER set utf8 default COLLATE utf8_general_ci;
    grant all on db_name.* to 'db_user';
    QUERY_INPUT
    

    Note

    You should do it on database host if you connect to remote server.

  4. Then, if you use mysql and you have set timezone different from “UTC” you should run next command:

    mysql_tzinfo_to_sql /usr/share/zoneinfo | sudo -H mysql mysql
    

    Note

    You should do it on database host if you connect to remote server.

  5. Create user:

    sudo useradd --user-group --create-home --shell /bin/bash polemarch
    

    Hint

    You can add this user to sudoers for easier installation process and support.

  6. Create virtualenv and activate it:

    # In some cases use sudo for first command.
    # For rhel/centos7 use:
    /opt/rh/rh-python38/root/usr/bin/python -m virtualenv /opt/polemarch
    # For Debian with Python 3.9:
    virtualenv --python=python3.9 /opt/polemarch
    # For Ubuntu 22.04 and other debian distributions with Python 3.10:
    virtualenv --python=python3.10 /opt/polemarch
    # For other distributions:
    virtualenv --python=python3.8 /opt/polemarch
    
    # Make required directories
    sudo mkdir -p /etc/polemarch
    sudo chown -R polemarch:polemarch /opt/polemarch /etc/polemarch
    sudo -u polemarch -i
    source /opt/polemarch/bin/activate
    

    Note

    If you have more then one Python version, recommended use Python 3.8 or newer for virtualenv.

  7. Install Polemarch:

    pip install -U polemarch[mysql]
    
  8. Edit config file:

    1. Create directory for log and pid files:

      mkdir /opt/polemarch/logs /opt/polemarch/pid
      
    2. Open /etc/polemarch/settings.ini, if it does not exist, create it. Polemarch uses config from this directory.

    3. The default database is SQLite3, but MySQL is recommended. Settings needed for correct work MySQL database:

      [database]
      engine = django.db.backends.mysql
      name = db_name
      user = db_user
      password = db_password
      
      [database.options]
      connect_timeout = 20
      init_command = SET sql_mode='STRICT_TRANS_TABLES', default_storage_engine=INNODB, NAMES 'utf8', CHARACTER SET 'utf8', SESSION collation_connection = 'utf8_unicode_ci'
      

      Note

      Set host and port settings if you connect to remote server.

      Warning

      If you are using MariaDB, make sure that your settings.ini config contains next line:

      [databases]
      databases_without_cte_support = default
      

      The problem is that the implementation of recursive queries in the MariaDB does not allow using it in a standard form. MySQL (since 8.0) works as expected.

    4. The default cache system is file based cache, but RedisCache is recommended. Settings needed for correct RedisCache work:

      [cache]
      backend = django.core.cache.backends.redis.RedisCache
      location = redis://127.0.0.1:6379/1
      
      [locks]
      backend = django.core.cache.backends.redis.RedisCache
      location = redis://127.0.0.1:6379/2
      

      Note

      Set host ip and port instead of 127.0.0.1:6379 if you connect to remote server.

    5. The default celery broker is file Celery broker, but Redis is recommended. Settings needed for correct Redis work:

      [rpc]
      connection = redis://127.0.0.1:6379/3
      heartbeat = 5
      concurrency = 8
      enable_worker = true
      

      Note

      Set host ip and port instead of 127.0.0.1:6379 if you connect to remote server.

      Hint

      Use RabbitMQ in case there can be a big network delay between the Polemarch nodes.

    6. For running Polemarch with worker, you need to create follow sections:

      [uwsgi]
      pidfile = /opt/polemarch/pid/polemarch.pid
      log_file = /opt/polemarch/logs/polemarch_web.log
      
      # Uncomment it for HTTPS:
      # [uvicorn]
      # ssl_keyfile = /etc/polemarch/polemarch.key
      # ssl_certfile = /etc/polemarch/polemarch.crt
      
      [worker]
      # output will be /opt/polemarch/logs/polemarch_worker.log
      logfile = /opt/polemarch/logs/{PROG_NAME}_worker.log
      # output will be /opt/polemarch/pid/polemarch_worker.pid
      pidfile = /opt/polemarch/pid/{PROG_NAME}_worker.pid
      loglevel = INFO
      

      Also if you need to set your own path for logfile or pidfile, different from the path from example, you can do it, but make sure, that user, which starts Polemarch has write-permissions for these directory and file. If you run it as root, we recommend to add in [uwsig] params uid and gid (read more).

      Tip

      More configuration settings you can find in Configuration manual.

  9. Make migrations:

    polemarchctl migrate
    

Note

The first time run this command, the first superuser admin will be created in the database with the same password. We recommend changing the user’s password immediately after the first login.

  1. Start Polemarch:

    polemarchctl webserver
    

Polemarch starts with web interface on port 8080.

If you need to restart Polemarch use following command:

polemarchctl webserver reload=/opt/polemarch/pid/polemarch.pid

If you use another directory for storing Polemarch pid file, use path to this file.

If you need to stop Polemarch use following command:

polemarchctl webserver stop=/opt/polemarch/pid/polemarch.pid

If you use another directory for storing Polemarch pid file, use path to this file.

Install from docker

Run image

For run Polemarch docker image use command:

docker run -d --name polemarch --restart always -v /opt/polemarch/projects:/projects -v /opt/polemarch/hooks:/hooks -p 8080:8080 vstconsulting/polemarch

Using this command download official docker image and run it with default settings. Dont use default SQLite installation with filecache in production.

Ensure, that /opt/polemarch/projects and /opt/polemarch/hooks has uid/gid 1000/1000 as owner. Polemarch will be run with web interface on port 8080

Settings

Main section

  • DEBUG - status of debug mode. Default value: false.

  • DJANGO_LOG_LEVEL - log level. Default value: WARNING.

  • TIMEZONE - timezone. Default value: UTC.

Database section

Setup database connection via django-environ: environ.Env.db_url.

For example for mysql, DATABASE_URL = 'mysql://user:password@host:port/dbname'. Read more about django-environ in the official django-environ documentation.

Cache

For cache environment variables you can also use django-environ - environ.Env.cache_url. For example for redis, CACHE_URL = redis://host:port/dbname.

RPC section

  • POLEMARCH_RPC_ENGINE - connection to rpc service. If not set used as tmp-dir.

  • POLEMARCH_RPC_RESULT_BACKEND - connection to rpc results service. Default as engine.

  • POLEMARCH_RPC_HEARTBEAT - Timeout for RPC. Default value: 5.

  • POLEMARCH_RPC_CONCURRENCY - Number of concurrently tasks. Default value: 4.

Web section

  • POLEMARCH_WEB_REST_PAGE_LIMIT - Limit elements in answer, when send REST request. Default value: 1000.

UWSGI section

  • POLEMARCH_UWSGI_PROCESSES - number of uwsgi processes. Default value: 4.

Other settings

If you set WORKER to ENABLE state, uwsgi run worker as daemon.

If you set SECRET_KEY, value of SECRET_KEY variable would be written to secret

Examples

Run latest version of Polemarch in docker and connect to MySQL on server, using django-environ:

docker run -d --name polemarch --restart always -v /opt/polemarch/projects:/projects -v /opt/polemarch/hooks:/hooks --env DATABASE_URL=mysql://polemarch:polemarch@polemarch_db:3306/polemarch -p 8080:8080 vstconsulting/polemarch

Run Polemarch with Memcache and RabbitMQ and SQLite3. Polemarch log-level=INFO, secret-key=mysecretkey

docker run -d --name polemarch --restart always -v /opt/polemarch/projects:/projects -v /opt/polemarch/hooks:/hooks --env POLEMARCH_RPC_ENGINE=amqp://polemarch:polemarch@rabbitmq-server:5672/polemarch --env CACHE_URL=memcache://memcached-server:11211/ --env POLEMARCH_LOG_LEVEL=INFO --env SECRET_KEY=mysecretkey -p 8080:8080 vstconsulting/polemarch

Also you can use .env file with all variable you want use on run docker:

docker run -d --name polemarch --restart always -v /opt/polemarch/projects:/projects -v /opt/polemarch/hooks:/hooks --env-file /path/to/file -p 8080:8080 vstconsulting/polemarch

Run from the sources with docker-compose (PoleMarch+MySQL+Redis):

export DOCKER_BUILDKIT=1
export COMPOSE_DOCKER_CLI_BUILD=1
docker-compose up -d --build

Quickstart

After you install Polemarch by instructions above you can use it without any further configuration. Interface is pretty intuitive and common for any web application. Read more in GUI workflow.

Default installation is suitable for most simple and common cases, but Polemarch is highly configurable system. If you need something more advanced (scalability, dedicated DB, custom cache, logging or directories) you can always configure Polemarch like it is said in Configuration manual.

Backup

Regular uploading of backups is a guarantee of the reliability of the application. We recommend use SQL backup or copy database.

There are examples of SQL backup for MySQL and PostgreSQL below.

Making backup in MySQL:

shell> mysqldump dbname > dump.sql

Here dbname is the name of your database, dump.sql is the file, where all SQL backup statements will be saved.

Uploading of backup in MySQL:

shell> mysqladmin create dbname
shell> mysql dbname < dump.sql

Making backup in PostgreSQL:

pg_dump dbname > dump.sql

Uploading of backup in PostgreSQL:

createdb dbname
psql dbname < dump.sql

Update

Before updating of package of any type it is strongly recommended to stop all services and create backup for safety.

Update from any old version

  1. Firstly, we strongly recommend you to create a database backup and to stop all Polemarch services for safety.

  2. Secondly, if you are updating from 0.x.y to 1.x.y, you need to update you current 0.x.y version to 1.0.0 version.

  3. Then update to the latest version. If you don’t know how to do it, look “Install from PyPI”.

Migrate

Migrations are Django’s way of propagating changes you make to your models (adding a field, deleting a model, etc.) into your database schema. They’re designed to be mostly automatic, but you need to know when to make migrations, when to run them, and the common problems you might run into.

To run a migrate command you should run follow code:

polemarchctl migrate

Create superuser

A superuser is the user, who has all permissions.

To create a superuser account use the follow command:

polemarchctl createsuperuser

This command prompts for all required user’s options.

Change password

To change password use the follow command:

polemarchctl changepassword [<username>]

It prompts you to enter a new password twice for the given user. If the entries are identical, this immediately becomes the new password. If you do not supply a user, the command will attempt to change the password of user whose username matches the current user.