This guide will focus on Debian/Ubuntu-like systems - however, it works very similar on e.g. Fedora and friends.
- python3
- python3-pip
- virtualenvwrapper
- gettext
- git
- curl
- nodejs (in an up-to-date version)
- nginx / apache webserver
- optionally: a database like postgresql / mariadb
Create and switch to user (as root
or using sudo
)
adduser aplus
su aplus
cd
git clone https://github.com/liqd/adhocracy-plus.git
cd adhocracy-plus
git checkout release
mkvirtualenv --python=/usr/bin/python3 aplus
Note: you won't need the --python
part when using a recent distribution.
npm install
npm run build:prod
pip install -r requirements.txt
export DJANGO_SETTINGS_MODULE=adhocracy-plus.config.settings.build
python manage.py compilemessages
python manage.py collectstatic
Create a config file at ~/adhocracy-plus/adhocracy-plus/config/settings/local.py
See the django-documentation for a comprehensive list of settings and config/settings/base.py
for pre-configured ones. The settings you will most likely want to set are:
# replace 'your.domain' with your desired domain
WAGTAILADMIN_BASE_URL = 'https://your.domain'
ALLOWED_HOSTS = [u'your.domain', u'localhost']
# database config - we recommend postgresql for production purposes
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': 'aplus-test-database',
}
}
# forward outgoing emails to a local email proxy
EMAIL_BACKEND='django.core.mail.backends.smtp.EmailBackend'
EMAIL_HOST='127.0.0.1'
# folder for user-uploads, directly served from the webserver (see nginx example below). Must be created manually.
MEDIA_ROOT='/home/aplus/aplus-media'
# replace the value below with some random value
SECRET_KEY = u'SOMESECRETKEY'
# some basic security settings for serving the website over https - see django docu
CSRF_COOKIE_SECURE=True
SECURE_PROXY_SSL_HEADER = ('HTTP_X_FORWARDED_PROTO', 'https')
SESSION_COOKIE_SECURE=True
SECURE_BROWSER_XSS_FILTER = True
SECURE_CONTENT_TYPE_NOSNIFF = True
SESSION_COOKIE_HTTPONLY = True
FILE_UPLOAD_PERMISSIONS = 0o644
# celery configuration
CELERY_BROKER_URL = "redis+socket://var/run/redis/redis.sock"
CELERY_RESULT_BACKEND = "redis+socket://var/run/redis/redis.sock"
CELERY_BROKER_CONNECTION_RETRY_ON_STARTUP = True
This will create all required tables via so-called migrations
python manage.py migrate
Try starting the server:
export DJANGO_SETTINGS_MODULE=adhocracy-plus.config.settings.production
python manage.py runserver
From another terminal on the same server:
curl localhost:8000
You should now get valid HTML output.
Cancel the server after testing via ctrl
+c
In order to start up the software as a regular system daemon, similar to a database or webserver, we need to create service files.
/etc/systemd/system/adhocracy-plus.service
:
[Unit]
Description=adhocracy+ server
After=network.target
[Service]
User=aplus
WorkingDirectory=/home/aplus/adhocracy-plus
ExecStart=/home/aplus/.virtualenvs/aplus/bin/gunicorn -e DJANGO_SETTINGS_MODULE=adhocracy-plus.config.settings.production --workers 4 --threads 2 -b 127.0.0.1:8000 -n adhocracy-plus adhocracy-plus.config.wsgi
Restart=always
RestartSec=3
StandardOutput=append:/var/log/adhocracy-plus/adhocracy-plus.log
StandardError=inherit
[Install]
WantedBy=default.target
/etc/systemd/system/adhocracy-plus-celery-worker.service
:
[Unit]
Description=adhocracy+ celery worker
After=network.target
[Service]
Type=forking
User=aplus
WorkingDirectory=/home/aplus/adhocracy-plus
ExecStart=/home/aplus/.virtualenvs/aplus/bin/celery --app adhocracy-plus worker
Restart=always
RestartSec=3
StandardOutput=append:/var/log/adhocracy-plus/adhocracy-plus-celery-worker.log
StandardError=inherit
[Install]
WantedBy=default.target
Depending on your celery configuration you will also need to start a message broker service like redis or rabbit-mq and configure celery accordingly in local.py
(see above). If you use redis and the default installation it should already be running, call service redis status
to check.
This will log all output to files in /var/log/adhocracy-plus/
. You will also need to create that folder before starting the service (as root
or using sudo
):
mkdir /var/log/adhocracy-plus
Load and start units (as root
or using sudo
):
systemctl daemon-reload
systemctl start adhocracy-plus
systemctl start adhocracy-plus-celery-worker
Enable autostart on boot:
systemctl enable adhocracy-plus
systemctl enable adhocracy-plus-celery-worker
Finally, we need to set up a proxy webserver which handles the communication with the outside world. The following example is a simple config for nginx
:
server {
listen 80;
listen [::]:80;
# for using https - see nginx docu
#listen 443 ssl http2;
#listen [::]:443 ssl http2;
server_name your.domain;
# forward traffic to adhocracy-plus
location / {
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header Host $http_host;
proxy_pass http://127.0.0.1:8000;
}
# serve media files directly, without going through adhocracy-plus.
# See MEDIA_ROOT in local.py
location /media {
alias /home/aplus/aplus-media;
}
# max upload size for images and documents
client_max_body_size 20m;
}
The website should now be reachable
You can now continue setting up the website in the django-admin
configuration page. Please also see the manual for a more comprehensive documentation.
su aplus
cd ~/adhocracy-plus
workon aplus
python manage.py createsuperuser
Visit http[s]://your.domain/django-admin
and log in with the user you just created.
In the sites
(german: Websites
) section, change the domain name of the existing site to your.domain
In the Organisations
section, add a new organization. For the moment, all you need is setting the name and adding you user to the Initiators
.
You can now visit http[s]://your.domain/
and select the organization from the user dropdown menu - it will bring you to the dashboard
. See the manual.
The landing page is managed via wagtail. You can find the settings at http[s]://your.domain/admin
.
systemctl stop adhocracy-plus
systemctl stop adhocracy-plus-celery-worker
su aplus
cd ~/adhocracy-plus
workon aplus
git pull
rm -rf static/*
npm install
npm run build:prod
pip install --upgrade -r requirements.txt
export DJANGO_SETTINGS_MODULE=adhocracy-plus.config.settings.build
python manage.py compilemessages
python manage.py collectstatic
python manage.py migrate
export DJANGO_SETTINGS_MODULE=adhocracy-plus.config.settings.production
python manage.py runserver
systemctl start adhocracy-plus
systemctl start adhocracy-plus-celery-worker