https://github.com/zeropsio/recipe-django

Zerops w/ Django
https://github.com/zeropsio/recipe-django

Last synced: 3 months ago
JSON representation

Zerops w/ Django

• Host: GitHub
• URL: https://github.com/zeropsio/recipe-django
• Owner: zeropsio
• License: mit
• Created: 2024-06-07T14:26:49.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-04-03T08:01:04.000Z (about 1 year ago)
• Last Synced: 2025-04-14T18:12:12.790Z (about 1 year ago)
• Language: Python
• Size: 65.4 KB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Zerops x Django

[Django](https://www.djangoproject.com/) is a high-level Python web framework that encourages rapid development and clean, pragmatic design. This recipe aims to showcase few advanced Django concepts and how to integrate them with [Zerops](https://zerops.io), all through a simple file upload demo application.

![django](https://github.com/zeropsio/recipe-shared-assets/blob/main/covers/svg/cover-django.svg)




## Deploy on Zerops

You can either click the deploy button to deploy directly on Zerops, or manually copy the [import yaml](https://github.com/zeropsio/recipe-django/blob/main/zerops-project-import.yml) to the import dialog in the Zerops app.

[![Deploy on Zerops](https://github.com/zeropsio/recipe-shared-assets/blob/main/deploy-button/green/deploy-button.svg)](https://app.zerops.io/recipe/django)




## Recipe features

- **Load balanced** Django web app running on **Zerops Python** service

- Served by production-ready application server **[Gunicorn](https://gunicorn.org/)**

- Zerops **PostgreSQL 16** service as database

- Zerops **Object Storage** (S3 compatible) service as file system

- Automatic Django **database migrations**, **static files collection** and **superuser seeding**

- Utilization of Zerops built-in **environment variables** system

- Logs accessible through Zerops GUI

- **[Mailpit](https://github.com/axllent/mailpit)** as **SMTP mock server**

- **[Adminer](https://www.adminer.org)** for **quick database management** tool

- Unlocked development experience:

  - Access to database and mail mock through Zerops project VPN (`zcli vpn up`)

  - Prepared `.env.dist` file (`cp .env.dist .env` and change ***** secrets found in Zerops GUI)




## Production vs. development

Base of the recipe is ready for production, the difference comes down to:

- Use highly available version of the PostgreSQL database (change `mode` from `NON_HA` to `HA` in recipe YAML, `db` service section)

- Use at least two containers for Django service to achieve high reliability and resilience (add `minContainers: 2` in recipe YAML, `app` service section)

- Use production-ready third-party SMTP server instead of Mailpit (change `MAIL_` secret variables in recipe YAML `app` service)

- Since the Django app will run behind our HTTP balancer proxy, add your domain/subdomains to `recipe/settings.py` `CSRF_TRUSTED_ORIGINS` setting or add `APP_DOMAIN` secret variable (in recipe YAML, `app` service section)

- Disable public access to Adminer or remove it altogether (remove service `adminer` from recipe YAML)







## Changes made over the default installation

If you want to modify your existing Django app to efficiently run on Zerops, these are the general steps we took:

- Add [zerops.yml](https://github.com/zeropsio/recipe-django/blob/main/zerops.yml) to your repository, our example includes idempotent migrations, static files collection and optimized build process

- Run `pip install django-storages` and change storage settings section in your `project/settings.py` to support S3 compatible Object Storage file system (more info [here](https://django-storages.readthedocs.io/en/latest/backends/amazon-S3.html))

- Utilize Zerops [environment variables](https://github.com/zeropsio/recipe-django/blob/main/zerops.yml#L18-L32) and [secrets](https://github.com/zeropsio/recipe-django/blob/main/zerops-project-import.yml#L12-L15) to set up S3 for file system, database access, mailer and trusted hosts to work with reverse proxy load balancer

- Add init commands for your deployments to [migrate database and collect static images](https://github.com/zeropsio/recipe-django/blob/main/zerops.yml#L34-L39)







Need help setting your project up? Join [Zerops Discord community](https://discord.com/invite/WDvCZ54).