https://github.com/onaio/ansible-django

Use this role to install, configure, and manage Django
https://github.com/onaio/ansible-django

ansible ansible-django ansible-role ansible-roles django

Last synced: about 1 month ago
JSON representation

Use this role to install, configure, and manage Django

• Host: GitHub
• URL: https://github.com/onaio/ansible-django
• Owner: onaio
• License: apache-2.0
• Created: 2018-09-26T13:42:22.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-12-16T06:53:03.000Z (about 2 months ago)
• Last Synced: 2024-12-16T07:39:32.007Z (about 2 months ago)
• Topics: ansible, ansible-django, ansible-role, ansible-roles, django
• Language: Jinja
• Homepage:
• Size: 185 KB
• Stars: 5
• Watchers: 32
• Forks: 1
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ansible-django #

[![Build Status](https://github.com/onaio/ansible-django/workflows/CI/badge.svg)](https://github.com/onaio/ansible-django/actions?query=workflow%3ACI)

Use this role to install, configure, and manage [Django](https://www.djangoproject.com/).

This is a very simple and purist role for django installation.  We only install and configure:

- Django

- Celery (optional)

We intentionally consider the installation and configuration of databases, web servers, and other things as out of scope for this role.  Therefore, naturally this role is to be used in a playbook that installs and configures those other things.

Both `Django` and `celery` are installed and set up as `systemd` services.

## Role Variables ##

Some of the more important variables are briefly described below.  You can see all variables by looking at the `defaults/main.yml` file.

```yml

django_system_user: "django_app"  # name of the user that will own the django installation

django_python_apt_ppa: "ppa:deadsnakes/ppa" # The repository used to install python

django_python_version: "python3.8"  # the python version to use with pip commands

django_python_packages: # the python packages that would be required

  - "{{ django_python_version }}"

  - "{{ django_python_version }}-dev"

  - python3-pip

  - python3-distutils

  - python3-setuptools

django_pip_executable: "pip3" # Executable to use when running pip commands

django_git_url: "https://github.com/moshthepitt/django-template3.git"  # the git repo of your django app which we are installing

django_local_settings_path: "path to /local_settings.py"  # Path to the Django settings file

django_settings_module: "template3.settings"  # Django settings module

django_wsgi_module: "template3.wsgi:application"  # Django wsgi module

```

You can look at `tests/test.yml` for examples of how to use these variables.

### Django Settings ###

You can set any and all Django settings using the `django_settings` variable.

Here is a fairly simple example:

```yml

django_settings:

  BASE_DIR: "os.path.dirname(os.path.dirname(__file__))"

  SITE_ID: 1

  STATIC_ROOT: "'/var/www/static'"

  STATIC_URL: "'/static/'"

  MEDIA_ROOT: "'/var/www/media'"

  MEDIA_URL: "'/media/'"

  EMAIL_BACKEND: "'django.core.mail.backends.console.EmailBackend'"

  EMAIL_HOST: "'localhost'"

  EMAIL_PORT: "1025"

  DEFAULT_FROM_EMAIL: "'Hello World '"

  ALLOWED_HOSTS: "[]"

  DEBUG: True

```

As you may have noticed the `django_settings` takes `key: value` arguments of the Django settings variables that we know and love.

For example, to set Debug=True, you would do:

```yml

django_settings:

  DEBUG: True

```

To set up your database, you'd do:

```yml

django_settings:

  DATABASES: |

    {

      'default': {

          'ENGINE': 'django.db.backends.postgresql',

          'NAME': 'somedb',

          'USER': 'someuser',

          'PASSWORD': 'hunter2',

          'HOST': '127.0.0.1',

          'PORT': '5432',

      }

    }

```

## Testing ##

This project utilizes molecule for testing, the molecule tool can be installed by running `pip install 'molecule[docker]'` after which tests can run with `molecule test --all`

This project also comes with a Vagrantfile, which is a fast and easy alternative to test changes to the role, fire it up with `vagrant up`. _See [vagrant docs](https://docs.vagrantup.com/v2/) for getting setup with vagrant_

## License ##

Apache 2

## Authors ##

[Ona Engineering](https://ona.io)