• Tutorials
    • Introductory tutorials
      • 1. Get started
        • 1.1. Create your account
        • 1.2. Install the Divio CLI package
        • 1.3. Log in
        • 1.4. Add your public SSH key to the Control Panel
        • 1.5. Set up Docker
      • 2. Set up a new project
        • 2.1. Set up a project in the Cloud
        • 2.2. Replicate it locally
        • 2.3. Control your project and see its console
      • 3. Add new applications
        • 3.1. Add a package to the project directory
        • 3.2. Configure the project
        • 3.3. Migrate the database
        • 3.4. Deploy the project
        • 3.5. Add a package via pip
      • 4. Configure an application
        • 4.1. Add django-debug-toolbar to requirements.in
        • 4.2. Configure settings.py
        • 4.3. Configure urls.py
        • 4.4. See the results
      • 5. Package an addon (installation)
        • 5.1. Register the addon
        • 5.2. Add the packaging files
        • 5.3. Build the project with the new addon
      • 6. Package an addon (configuration)
        • 6.1. Add the addon to settings
        • 6.2. Create an aldryn_config.py file
        • 6.3. Configure settings.py
        • 6.4. Configure urls.py
      • 7. Package an addon (deployment)
        • 7.1. Add a field to the configuration form
        • 7.2. Add the remaining packaging files
        • 7.3. Validate and upload the addon
        • 7.4. Install the addon in a Cloud project
        • 7.5. Manage the addon via the Control Panel
    • Standalone tutorials
      • Create a custom Boilerplate
        • Set up a new project to work in
        • Add a Foundation frontend
        • Create the Boilerplate package
        • Create a Boilerplate on Divio Cloud
        • Test your Boilerplate
        • Update your Boilerplate
      • Migrate a project to Divio Cloud
        • Set the project up locally
        • Dump database to a JSON file (if required)
        • Migrate to Divio Cloud
        • Deploy the new Divio Cloud project
  • How-to guides
    • Setting up a project and its environment
      • Install system packages
      • Install Python dependencies
        • List your dependencies
        • Process the list
      • Set up Sass CSS compilation
        • What we want to do
        • Building this into the Dockerfile
        • Further frontend development
        • Using Boilerplates for quicker project creation
      • Configure Celery
        • Add Celery to your project
        • Configure Celery for the local server
        • Run the local project
        • Testing
        • Environment variables
      • Configure Django settings
        • Inserting an item at a particular position
        • Manipulating more complex settings
      • Migrate an existing project to Divio Cloud
        • Initial project setup
        • Check addon versions
        • Set up the project locally
        • Migrate your existing code base
        • Configure settings
        • Importing content
        • Test the local site
        • Upload your changes back to the Divio Cloud
        • Upload your project to an independent version control repository
      • Add a Django application
        • Make the package available to the project
        • Configure the project
        • Migrate the database
        • Deploy the project
      • Set up password protection
        • How this works
    • Managing a project’s code
      • Configure Git hosting for your project
        • Set up external Git hosting
        • Options and special cases
        • Errors and what they mean
      • Use Git to manage your project
        • Basic Git operations
        • Excluded directories
      • Pin all of your project's Python dependencies
        • Compile requirements.txt
        • Re-compile when required
    • Managing a project’s resources
      • Interact with your project’s database
        • Interact with the local database
        • Interact with the Cloud database
        • Usage examples for common basic operations
      • Interact with your project’s media storage
        • Interact with your project’s Cloud S3 storage
        • Use Divio tools for local access to Cloud storage
        • Storage ACLs (Access Control Lists)
    • Working with addons
      • Package an application as an addon
        • Register the addon
        • Add the packaging files
        • Add configuration
        • Check the addon
        • Upload the addon
      • Update an existing addon
        • Choose a local project to work with
        • Uninstall the addon locally if necessary
        • Clone the addon repository to addons-dev
        • Run divio project develop
        • Work on the code
        • Push your changes
        • Upload the new addon version
        • Test it on the Control Panel
        • Place the new version in the appropriate channel
    • Working in the local development environment
      • Log in to a local Django project
      • Run the local server in Live mode
    • Going live and maintaining performance
      • Go-live checklist
        • Check your subscription plan
        • Dependencies
        • DEBUG mode
        • Domains
        • Environment variables
        • Serving configuration
        • Other settings
        • Deployment
        • After deployment
      • Fine-tune uWSGI server performance
        • Monitoring and profiling
        • Aldryn Django settings
    • Troubleshooting
      • Debug Cloud deployment problems
        • Debugging checklist
        • Decision tree
      • Identify and resolve a dependency conflict
        • Identify the conflict
        • Identify the problem requirement
        • Identify where the requirement comes from
        • Repeat the process
        • How to prevent this from happening again
  • Technical reference
    • Divio software components
      • The Divio application
        • Controls
        • First run
        • The Divio Shell
      • Divio CLI
        • divio-cli command reference
      • The Cloud and local shells
        • Using a Cloud shell
        • The local shell
      • The .aldryn file
    • Docker commands and configuration
      • Docker commands
        • The docker-compose command
        • The docker command
      • The Dockerfile
        • How the Dockerfile is automatically populated
      • The docker-compose.yml file
    • Python/Django application configuration
      • The settings.py file
        • Addon-configured settings
        • Manually-configured settings
      • Application configuration with aldryn_config.py
        • The aldryn_config.py file
        • Managing settings
        • Adding form fields for user-configuration of the Addon
        • Custom field validation
      • Application configuration with environment variables
        • Cloud (Live and Test) environments
        • Local environment
        • Environment variables and Django settings
        • Where and when environment variables are applied
        • Commonly-used environment variables
      • uWSGI configuration
    • Coding in Divio Cloud applications
      • Working with your project’s media storage in Python applications
        • Introduction
        • Working with our storage backends in Django
        • Loading media files into your applications’ pages
        • Storage speed and performance
      • Caching in Divio Cloud applications
        • Caching options
        • Caching in django CMS
      • Sending email in Divio Cloud applications
        • Configuration
        • Usage, testing and troubleshooting
    • Key Divio Cloud addons
      • Aldryn Django (core Django)
        • Control Panel options
        • Environment variable/settings.py options
      • Aldryn SSO (authentication)
        • Login methods
        • Test site protection
        • Aldryn SSO configuration options
      • Aldryn Addons (addon integration)
        • Aldryn Addons configuration options
    • Quick reference
      • Local commands cheatsheet
        • Project resource management
        • Running the local server
        • Working inside the containerised environment
        • Docker management
  • Background information
    • Our infrastructure
      • Divio Cloud overview
        • Divio Cloud infrastructure
        • Divio Cloud projects
        • Docker on Divio Cloud
      • Backend services
        • Media storage and delivery
        • Celery
      • Redirects
        • Protocol redirects
        • Domain name redirects
        • Language redirects
        • 301 Permanent vs 302 Temporary redirects
      • Python packaging on Divio Cloud
    • Projects
      • Anatomy of a Divio Cloud project
        • Docker-related files
        • Directories
        • The project build process
      • Version control
        • Project repository branches
      • Boilerplates
        • Boilerplates
        • Our built-in Boilerplates
        • How Boilerplates work
      • Multi-site projects on Divio Cloud
        • Fully supported Django Multisite+ option
        • DIY implementation
        • Logging in to multi-site instances
        • Switching between sites in a local multi-site project
    • Addons
      • Anatomy of a Divio Cloud addon
        • Basic file structure
        • aldryn_config.py
        • addon.json
        • setup.py
      • Addon configuration overview
        • Environment variable, setting or Addon configuration field?
    • Docker
      • Docker basics
        • Docker on Macintosh and Windows
        • Key components
        • Glossary
Developer Handbook
Divio
  • Docs  » 
  • How-to guides

How-to guides¶

Setting up a project and its environment¶

  • Install system packages
  • Install Python dependencies
  • Set up Sass CSS compilation
  • Configure Celery
  • Configure Django settings
  • Migrate an existing project to Divio Cloud
  • Add a Django application
  • Set up password protection

Managing a project’s code¶

  • Configure Git hosting for your project
  • Use Git to manage your project
  • Pin all of your project's Python dependencies

Managing a project’s resources¶

  • Interact with your project’s database
  • Interact with your project’s media storage

Working with addons¶

  • Package an application as an addon
  • Update an existing addon

Working in the local development environment¶

  • Log in to a local Django project
  • Run the local server in Live mode

Going live and maintaining performance¶

  • Go-live checklist
  • Fine-tune uWSGI server performance

Troubleshooting¶

  • Debug Cloud deployment problems
  • Identify and resolve a dependency conflict
Next Previous

© Copyright 2017-2019, Divio AG. Revision c78a6740.

Edit on GitHub

Documentation v: latest
Versions
latest
Downloads
pdf
html