caFICteria-aaS/web/README.md
2024-12-02 18:40:31 +01:00

27 lines
1.5 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# caFICtería-aaS (web)
This is the [Django](https://www.djangoproject.com/) web that serves the daily menu data and other functionalities.
## 🔧 Environment Variables
| Name | Description |
|--------------------------|-------------|
| `DJANGO_DEBUG` (bool) | Whether to enable Django's debug mode. Leave it false in production. _(Default: False)_ |
| `DJANGO_ALLOWED_HOSTS` | Space-separated list of host/domain names that Django can serve. Not needed in debug mode (**otherwise is needed**). _(Default: "")_ |
| `DJANGO_SECRET_KEY` | The key to securing signed data. Must be randomly generated and kept secure. _(Default: "django-insecure-(krka)#p79n81tjf-)dy9f1!k^4*j&+qf5_eurt7)o%8%mr1ce")_ |
| `DJANGO_CSRF_TRUSTED_ORIGINS` | Space-separated list of trusted origins for unsafe requests. Not needed in debug mode, and when running on port 80/443. _(Default: "")_ |
| `MENU_HISTORY_FILE_PATH` | The place where the JSON file with the menu history is stored. _(Default: "/tmp/menu_history.json")_ |
_**Note🗒:**_ Booleans are only true when their value is the string "true" (not case sensitive)
_**Tip💡:**_ You can generate a secret key with `openssl rand -hex 32`
_**Tip💡:**_ You can check [Django's documentation](https://docs.djangoproject.com/en/5.1/) to better understand these variables
## 🐳 Building the Docker image
```bash
git clone https://git.peprolinbot.com/peprolinbot/caFICteria-aaS.git
cd caFICteria-aaS/web
docker build -t caficteria-web .
```