README.md 2.37 KB
Newer Older
Romain TORRENTE's avatar
Romain TORRENTE committed
1
2
3
4
5
6
7
8
9
# Affichage Dynamique (Digital Signage)
Application d'affichage dynamique utilisée sur le campus de l'INSA Lyon (LyonTech-la Doua)

## Env variables

```
ENV DATABASE_URL postgres://ad@db/ad
ENV SECRET_KEY ''
ENV DJANGO_ENV 'dev'
Corentin Berthier's avatar
Corentin Berthier committed
10
11
ENV MAILJET_API_KEY ''
ENV MAILJET_SECRET_KEY ''
Romain TORRENTE's avatar
Romain TORRENTE committed
12
ENV DEFAULT_FROM_EMAIL ''
Corentin Berthier's avatar
Corentin Berthier committed
13
ENV EMAIL_SUBJECT_PREFIX '[Affichage Dynamique]'
Romain Torrente's avatar
Romain Torrente committed
14
15
ENV DEFAULT_GROUP_PK 0 #Pk du groupe ajouté automatiquement à chaque nouveau inscrit
ENV ALLOWED_HOSTS "affichage.bde-insa-lyon.fr"
16
17
ENV HCAPTCHA_SITEKEY ''
ENV HCAPTCHA_SECRET ''
18
ENV API_EVENTS ''
Corentin Berthier's avatar
Corentin Berthier committed
19
ENV ADMIN_EMAIL ''
20
21
22
23
24
ENV SITE_URL "https://affichage.bde-insa-lyon.fr"
ENV CONTACT_MAIL ''
ENV MENTION_ROLE 'Président'
ENV MENTION_MAIL ''
ENV MENTION_PHONE ''
Romain TORRENTE's avatar
Romain TORRENTE committed
25
```
26
27
28
29
30
31
32
33
34
35
36
37
38
39

## Install

Juste use `docker-compose` command to set up the app. You can get HCaptcha key/secret by creating an account on their [site](https://www.hcaptcha.com/).

**Important** : if there is no user group yet, set `DEFAULT_GROUP_PK` to the value 0.

## Cron job command

If you have a doubt regarding the cron job that are executed, you can run `python3 manage.py crontab show` or `python3 manage.py crontab -l`.
If there is no crontab in response, you can run `python3 manage.py crontab add` to add them again, and then run the previous command to check if the cron job are active.
In case you cannot wait for the cron job to run, you can manually run it by getting the id of the cron job from `python3 manage.py crontab -l`, and then using `/usr/local/bin/python3 /app/manage.py crontab run <id>`


Romain TORRENTE's avatar
Romain TORRENTE committed
40
41
42
43
44
45
46
## Licence

[![GNU GPL v3.0](http://www.gnu.org/graphics/gplv3-127x51.png)](http://www.gnu.org/licenses/gpl.html)

```
AffichageDynamique - Open Source Digital Signage used in INSA Lyon School of Engineering (France).
Copyright (C) 2019 Romain TORRENTE
47
Copyright (C) 2021 SIA INSA Lyon
Romain TORRENTE's avatar
Romain TORRENTE committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.
```