documentation on how to use systemctl (or service)

Puppet deploys a service unit file so EVA can be started at boot time and logs go the journal instead of some logfile at some opaque location

README.md

@@ -1,61 +1,79 @@
-# eva
+# eva
-
+
-A simple tool for on- and offboarding people in a mid sized organisation.
+A simple tool for on- and offboarding people in a mid sized organisation.
-
+
-"EVA" is an german acronym for "Eintritt, Veränderung, Austritt",
+"EVA" is an german acronym for "Eintritt, Veränderung, Austritt",
-meaning "Onboarding, Change, Offboarding"
+meaning "Onboarding, Change, Offboarding"
-
+
-# development
+# development
-
+
-- install gettext for instance via "apt install gettext" for translations
+- install gettext for instance via `apt install gettext` for translations
-
+- set up a virtual environment with virtualenvwrapper or some other environment managing tool
-- set up a virtual environment with virtualenvwrapper or some other
+- use this environment and do
-environment managing tool
+```
-
+pip install django django-multiselectfield django-formtools django-allauth
-- use this environment and do
+```
-
+- clone this repository
-    pip install django django-multiselectfield django-formtools django-allauth
+- `ln -sr eva/settings_development.py eva/settings.py`
-
+- initialise your database with `python manage.py migrate`
-- clone this repository
+- start your development server with `python manage.py runserver`
-
+
-- ln -sr eva/settings_development.py eva/settings.py
+# oauth
-
+
-- initialise your database with
+- You need to add oauth information in the django backend via .../admin in "Social Accounts"
-
+
-    python manage.py migrate
+# production
-
+
-- start your development server with
+- you can use gunicorn as server for example instead of the django development server.
-
+- we use whitenoise for serving static files
-    python manage.py runserver
+- we still use the development SQLITE database from django
-
+
-# oauth
+do the following in the project main directory:
-
+```
-- You need to add oauth information in the django backend via .../admin in "Social Accounts"
+  ln -sr eva/settings_production.py eva/settings.py
-
+```
-# production
+edit /secrets.json to contain something similar to
-
+```
-- you can use gunicorn as server for example instead of the django development server.
+  {
-
+    "SECRET_KEY": "THIS IS ANOTHER SECRET!"
-- we use whitenoise for serving static files
+  }
-
+```
-- we still use the development SQLITE database from django
+run the following commands:
-
+```
-do the following in the project main directory:
+  python3 manage.py migrate
-
+  python3 manage.py collectstatic
-  ln -sr eva/settings_production.py eva/settings.py
+  django-admin compilemessages
-
+```
-edit /secrets.json to contain something similar to
+
-
+As root create a file `/etc/systemd/system` (it's already deployed by puppet when the corresponding manifest is applied):
-  {
+
-    "SECRET_KEY": "THIS IS ANOTHER SECRET!"
+```
-  }
+# /etc/systemd/system/eva.service
-
+#
-run the following commands:
+
-
+[Unit]
-  python3 manage.py migrate
+Description=gunicorn EVA daemon
-  python3 manage.py collectstatic
+After=network.target
-  django-admin compilemessages
+
-
+[Service]
-server starts with
+Type=simple
-
+User=eva
-  export PYTHONUNBUFFERED=TRUE; nohup gunicorn --forwarded-allow-ips="*" -b '0:8000' eva.wsgi &> logfile &
+Group=eva
+RuntimeDirectory=eva
+WorkingDirectory=/home/eva/eva
+Environment=PYTHONUNBUFFERED=TRUE
+ExecStart=/usr/bin/gunicorn  --forwarded-allow-ips='*' -b '0:8000' eva.wsgi
+ExecReload=/bin/kill -s HUP $MAINPID
+KillMode=mixed
+TimeoutStopSec=5
+PrivateTmp=true
+
+[Install]
+WantedBy=multi-user.target
+```
+
+Adapt the paths in the file accordingly. Then, still as root, run:
+```
+systemctl enable --now eva.service
+```
+This enables the service to start at boot time and starts it immediately now. The daemon logs to the journal. You can see the last 10 lines by running `systemctl status eva.service` or the whole log by running `journalctl -u eva.service`. The usual switches to manipulate that output are available.

eva/settings_development.py

@@ -65,8 +65,7 @@ MIDDLEWARE = [
     'django.contrib.auth.middleware.AuthenticationMiddleware',
     'django.contrib.messages.middleware.MessageMiddleware',
     'django.middleware.clickjacking.XFrameOptionsMiddleware',
-    'allauth.account.middleware.AccountMiddleware'
+]
-    ]
 
 ROOT_URLCONF = 'eva.urls'
 

evapp/forms.py

@@ -29,7 +29,7 @@ class PersonalForm(EvaForm):
 
     class Meta:
         model = Employee
-        fields = ['firstname', 'lastname', 'department', 'team', 'add_to_wikimediade',]
+        fields = ['firstname', 'lastname', 'department', 'team', ]
 
 class WorkingForm(EvaForm):
 
@@ -48,11 +48,17 @@ class WorkingForm(EvaForm):
 
 class ITForm(EvaForm):
 
+    def clean(self):
+        data = self.cleaned_data
+        if data['vendor'] == 'MAC' and data['os'] != 'MOS':
+            raise ValidationError('Ein MAC sollte Mac OS installiert haben')
+        return data
+
     class Meta:
         model = Employee
         fields = [
-            'framework', 'os', 'keyboard', 'mobile', 'landline',
+            'vendor', 'os', 'keyboard', 'screen', 'mobile', 'comment',
-            'comment', 'language', 'accounts', 'lists', 'rebu2go' ]
+            'language', 'accounts', 'lists', 'rebu2go' ]
 
 class OfficeForm(EvaForm):
     class Meta:

evapp/migrations/0001_initial.py

@@ -20,7 +20,6 @@ class Migration(migrations.Migration):
                 ('lastname', models.CharField(max_length=50, verbose_name='Nachname')),
                 ('department', models.CharField(choices=[('PROG', 'Programme'), ('SOFT', 'Softwareentwicklung'), ('CENT', 'Central'), ('VOR', 'Vorstand')], max_length=5, verbose_name='Bereich')),
                 ('team', models.CharField(blank=True, max_length=20, null=True)),
-                ('add_to_wikimediade', models.BooleanField(default=False, verbose_name='Soll auf wikimedia.de irgendwo stehen?')),
                 ('firstdate_employment', models.DateField(null=True, verbose_name='Erster Arbeitstag')),
                 ('firstdate_presence', models.DateField(null=True, verbose_name='Erster Tag der Anwesenheit in der Geschäftsstelle')),
                 ('jobdescription_german', models.CharField(max_length=100, null=True, verbose_name='Stellenbezeichnung(deutsch)')),
@@ -31,10 +30,9 @@ class Migration(migrations.Migration):
                 ('os', models.CharField(choices=[('UBU', 'Ubuntu (Standard)'), ('WIN', 'Windows (bitte Begründung angeben)'), ('MOS', 'Mac OS (nur wenn Mac gewählt)')], default='UBU', max_length=3, verbose_name='Betriebssystem')),
                 ('screen', models.BooleanField(default=False, verbose_name='Zusätzlicher Monitor? Einer ist standard.')),
                 ('mobile', models.BooleanField(default=False, max_length=6, verbose_name='Diensttelefon (Handy)')),
-                ('landline', models.BooleanField(default=False, verbose_name='Festnetznummer (Sipgate)')),
                 ('keyboard', models.CharField(choices=[('DE', 'Deutsch'), ('US', 'USA'), ('OT', 'Anderes (Bitte unten angeben)')], default='DE', max_length=2, verbose_name='Tastaturlayout')),
                 ('comment', models.TextField(blank=True, max_length=500, null=True, verbose_name='zusätzliche IT-Anforderungen')),
-                ('language', models.CharField(choices=[('GER', 'Deutsch'), ('ENG', 'English')], default='GER', max_length=3, verbose_name='Sprache für Onboarding')),
+                ('language', models.CharField(choices=[('GER', 'Deutsch'), ('ENG', 'English')], default='GER', max_length=3, verbose_name='Sprache')),
                 ('accounts', multiselectfield.db.fields.MultiSelectField(blank=True, choices=[('OTRSWMDE', 'OTRS Ticketsystem'), ('CIVIC1', 'Civic CRM (allgemein)'), ('CIVIC2', 'Civic CRM (Mailings, impliziert allgemein)'), ('WEB', 'www.wikimedia.de (edit)'), ('BLOG', 'blog.wikimedia.de (edit)'), ('FORUM', 'forum.wikimedia.de')], max_length=37, null=True, verbose_name='Zusätzliche Accounts')),
                 ('lists', models.CharField(blank=True, max_length=100, null=True, verbose_name='Zusätzliche Mailinglisten')),
                 ('rebu2go', models.BooleanField(default=False, verbose_name='Rebu2Go-Zugang benötigt?')),

evapp/migrations/0006_remove_employee_vendor_employee_framework_and_more.py

@@ -1,32 +0,0 @@
-# Generated by Django 4.2.16 on 2024-11-26 09:10
-
-from django.db import migrations, models
-
-
-class Migration(migrations.Migration):
-
-    dependencies = [
-        ('evapp', '0005_alter_employee_accounts'),
-    ]
-
-    operations = [
-        migrations.RemoveField(
-            model_name='employee',
-            name='vendor',
-        ),
-        migrations.AddField(
-            model_name='employee',
-            name='framework',
-            field=models.CharField(blank=True, max_length=300, null=True, verbose_name='Möchten Sie vom Standard des Frameworks abweichen, und wenn ja, warum?'),
-        ),
-        migrations.AlterField(
-            model_name='employee',
-            name='add_to_wikimediade',
-            field=models.CharField(choices=[('NEIN', 'Nein'), ('JA', 'Ja')], default=True, max_length=5, verbose_name='Soll die Person bei Ansprechpartner*innen auf der WMDE-Webseite mit aufgenommen werden?'),
-        ),
-        migrations.AlterField(
-            model_name='employee',
-            name='os',
-            field=models.CharField(choices=[('FED', 'Fedora (Standard)'), ('WIN', 'Windows (bitte Begründung angeben)'), ('MOS', 'Mac OS (nur wenn Mac gewählt)'), ('UBU', 'Ubuntu')], default='FED', max_length=3, verbose_name='Betriebssystem'),
-        ),
-    ]

evapp/models.py

@@ -13,14 +13,14 @@ DEPARTMENT_CHOICES = {'COENG': _('Communitys & Engagement'),
                       'KOMAD': _('Kommunikation & Advocacy'),
                       'VOR': _('Vorstand'),}
 
-#VENDOR_CHOICES = {'STANDARD': 'Dell Latitude',
+VENDOR_CHOICES = {'STANDARD': 'Dell Latitude',
-#                'LENOVO': 'Lenovo Thinkpad',
+                 'LENOVO': 'Lenovo Thinkpad',
-#                'MAC': _('Mac (nur für Grafiker_innen)')}
+                 'MAC': _('Mac (nur für Grafiker_innen)')}
 
-OS_CHOICES = {'FED': 'Fedora (Standard)',
+OS_CHOICES = {'UBU': 'Ubuntu (Standard)',
               'WIN': _('Windows (bitte Begründung angeben)'),
-              'MOS': _('Mac OS (nur wenn Mac gewählt)'),
+              'MOS': _('Mac OS (nur wenn Mac gewählt)')}
-              'UBU': _('Ubuntu')}
+
 
 LANG_CHOICES = {'GER': 'Deutsch',
                 'ENG': 'English',}
@@ -41,9 +41,6 @@ TRANSPONDER_CHOICES = {'NORM': _('Allgemeiner Transponder'),
                        'SPECIAL': _('Besondere Schließungen (bitte angeben)'),
                        'NOTRANS': _('Kein Transponder'),}
 
-JANEIN_CHOICES = {'NEIN': ('Nein'),
-           'JA': _('Ja'),}
-
 class Employee(models.Model):
 
     # email adress of user. should not be necessary if we use openauth one day
@@ -55,7 +52,6 @@ class Employee(models.Model):
     # intern = models.BooleanField(verbose_name='Interne_r Mitarbeiter_in?', default=True)
     department = models.CharField(max_length=5, choices=DEPARTMENT_CHOICES.items(), verbose_name=_('Bereich'))
     team = models.CharField(max_length=50, null=True, blank=True) # TODO? better with choices?
-    add_to_wikimediade = models.CharField(max_length=5, choices=JANEIN_CHOICES.items(), verbose_name=_("Soll die Person bei Ansprechpartner*innen auf der WMDE-Webseite mit aufgenommen werden?"))
 
     # general work related stuff
     firstdate_employment = models.DateField(null=True, verbose_name=_("Erster Arbeitstag"))
@@ -66,16 +62,14 @@ class Employee(models.Model):
     desk = models.CharField(max_length=100, null=True, blank=True, verbose_name=_("Wo soll der Arbeitsplatz sein?"))
 
     # IT related stuff
-    #vendor = models.CharField(max_length=8, choices=VENDOR_CHOICES.items(), default='STANDARD', verbose_name=_('Hersteller'))
+    vendor = models.CharField(max_length=8, choices=VENDOR_CHOICES.items(), default='STANDARD', verbose_name=_('Hersteller'))
-    framework = models.CharField(max_length=300, null=True, blank=True, verbose_name=_("Möchten Sie vom Standard des Frameworks (Laptop) abweichen, und wenn ja, warum?"))
+    os = models.CharField(max_length=3, choices=OS_CHOICES.items(), default='UBU', verbose_name=_('Betriebssystem'))
-    os = models.CharField(max_length=3, choices=OS_CHOICES.items(), default='FED', verbose_name=_('Betriebssystem'))
+    screen = models.BooleanField(default=False, verbose_name=_('Zusätzlicher Monitor? Einer ist standard.'))
-    #screen = models.BooleanField(default=False, verbose_name=_('Zusätzlicher Monitor? Einer ist standard.'))
     mobile = models.BooleanField(max_length=6, default=False, verbose_name=_('Diensttelefon (Handy)'))
-    landline = models.BooleanField(default = False, verbose_name=_('Festnetznummer (Sipgate)'))
     # sim = models.BooleanField(default=False, verbose_name="Mobilfunkvertrag")
     keyboard = models.CharField(max_length=2, choices=KEYBOARD_CHOICES.items(), default='DE', verbose_name=_("Tastaturlayout"))
     comment = models.TextField(max_length=500, null=True, blank=True, verbose_name=_("zusätzliche IT-Anforderungen"))
-    language = models.CharField(max_length=3, choices=LANG_CHOICES.items(), default="GER", verbose_name=_("Sprache für Onboarding"))
+    language = models.CharField(max_length=3, choices=LANG_CHOICES.items(), default="GER", verbose_name=_("Sprache"))
     accounts = MultiSelectField(choices=ACCOUNT_CHOICES.items(), max_length=40, null=True, blank=True, verbose_name=_("Zusätzliche Accounts"))
     lists = models.CharField(max_length=100, null=True, blank=True, verbose_name=_("Zusätzliche Mailinglisten"))
     rebu2go = models.BooleanField(verbose_name=_("Rebu2Go-Zugang benötigt?"), default=False)

evapp/settings.py

@@ -9,7 +9,6 @@ BASIC_DATA = ['firstname', 'lastname', 'firstdate_employment', 'firstdate_presen
               'jobdescription_german', 'jobdescription_english',]
 
 # for every department: 'MAIL' => mail adress, 'DATA': additional fields to include
-# also one copy with all fields to the person filling the form.
 MAILS = {
             'IT': {
                 'MAIL': 'wmde-it@wikimedia.de',
@@ -29,7 +28,7 @@ MAILS = {
             'KOMM': {
                 'MAIL': 'presse@wikimedia.de',
                 'DATA': [
-                    'department', 'team', 'add_to_wikimediade'
+                    'department', 'team',
                 ],
             },
             'CENTRAL': {
@@ -44,18 +43,16 @@ MAILS = {
                     'department', 'team', 'language',
                 ]
             },
+            'DIRECTORAT': {
+                'MAIL': 'ricarda.busse@wikimedia.de',
+                'DATA': [
+                    'team', 'department', 'language',
+                ]
+            },
             'FINANCE': {
                 'MAIL': 'claudia.langrock@wikimedia.de',
                 'DATA': [
                     'rebu2go'
                 ]
-            },
-            'SUBMITTER': {
-                'MAIL': 'submitter@wikimedia.de',
-                'DATA': [
-                    'department', 'team', 'add_to_wikimediade', 'remote', 'desk', 'vendor',
-                    'os', 'screen', 'mobile', 'landline', 'keyboard', 'comment', 'language',
-                    'accounts', 'lists', 'rebu2go', 'transponder', 'special', 'post_office_box'
-                ]
             }
         }

evapp/views.py

@@ -12,8 +12,8 @@ from django.conf import settings
 from django.contrib.auth.mixins import LoginRequiredMixin
 from django.utils.translation import gettext_lazy as _
 
-from .models import Employee, DEPARTMENT_CHOICES, OS_CHOICES, \
+from .models import Employee, DEPARTMENT_CHOICES, OS_CHOICES, VENDOR_CHOICES, \
-                    LANG_CHOICES, ACCOUNT_CHOICES, TRANSPONDER_CHOICES, KEYBOARD_CHOICES, JANEIN_CHOICES
+                    LANG_CHOICES, ACCOUNT_CHOICES, TRANSPONDER_CHOICES, KEYBOARD_CHOICES
 from .forms import PersonalForm, WorkingForm, ITForm, OfficeForm, DummyForm,\
                    ChangeForm, TYPE_CHOICES
 from .settings import MAILS, EVA_MAIL, BASIC_DATA, ONLY_ONBOARDING
@@ -141,29 +141,21 @@ class EvaFormView(LoginRequiredMixin, CookieWizardView):
         context = {'data': self.beautify_data(newdata), 'contact': contact}
         firstname = data['firstname']
         lastname = data['lastname']
-        firstday = data['firstdate_employment']
         try:
              mail_template = get_template(f'evapp/department_mail.txt')
              if settings.MAILTEST:
                  send_mail(
-                 f'EVA: Neuzugang {firstname} {lastname} {firstday} (MAILTEST)',
+                 f'EVA: Neuzugang {firstname} {lastname} (MAILTEST)',
                  mail_template.render(context),
                  EVA_MAIL,
-                 [EVA_MAIL],
+                 [EVA_MAIL, contact],
-                 fail_silently=False)
-             elif department != "SUBMITTER":
-                 send_mail(
-                 f'EVA: Neuzugang {firstname} {lastname} {firstday}',
-                 mail_template.render(context),
-                 EVA_MAIL,
-                 [MAILS[department]['MAIL']],
                  fail_silently=False)
              else:
                  send_mail(
-                 f'EVA: Neuzugang {firstname} {lastname} {firstday}',
+                 f'EVA: Neuzugang {firstname} {lastname}',
                  mail_template.render(context),
                  EVA_MAIL,
-                 [contact],
+                 [MAILS[department]['MAIL'], contact],
                  fail_silently=False)
         except BadHeaderError as error:
             print(error)