使用docker将django应用程序部署到heroku时在哪里运行collectstatic？

Posted 2023-02-24

【中文标题】使用docker将django应用程序部署到heroku时在哪里运行collectstatic？

【英文标题】：Where to run collectstatic when deploying django app to heroku using docker?

【发布时间】：2020-04-30 07:36:40

【问题描述】：

我正在使用 Docker 将 Django 应用程序部署到 Heroku。当我将RUN manage.py collectstatic --noinput 放入Dockerfile 时，它​​失败了，因为没有为环境变量DJANGO_SECRET_KEY 设置值。我的理解是，这是因为配置变量在构建期间不可用。

当我将 collectstatic 作为发布命令运行时，它可以正常工作，并成功复制静态文件。但是，当我点击应用程序 url 时，它返回 500 错误，因为找不到静态文件。我相信这是因为 release 命令在临时文件系统上作为 dyno 运行，因此找不到复制的文件。

这似乎是第 22 条规则。将 collectstatic 放入 Dockerfile 失败，因为没有可用的配置变量，但将其作为发布命令失败，因为只保存了构建阶段的文件更改？

怎么办？

这是我在 settings.py 中的 collectstatic 设置

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'whitenoise.middleware.WhiteNoiseMiddleware',
    ...
]
...
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles')
STATIC_URL = '/static/'
STATICFILES_DIRS = (
    os.path.join(BASE_DIR, 'static'),
)
STATICFILES_STORAGE = 'backend.storage.WhiteNoiseStaticFilesStorage'

Dockerfile

# Pull base image
FROM python:3.7-slim

# Set environment varibles
ENV PYTHONDONTWRITEBYTECODE 1
ENV PYTHONUNBUFFERED 1

# Set work directory
RUN mkdir /code
WORKDIR /code

# Install dependencies
RUN pip install pipenv
COPY Pipfile Pipfile.lock /code/
RUN pipenv install --system

# Copy project
COPY . /code/

## collect static files
RUN mkdir backend/staticfiles

# This fails because DJANGO_SECRET_KEY can't be empty
RUN python manage.py --noinput

heroku.yml

build:
  docker:
    web: Dockerfile
run:
  web: gunicorn backend.config.wsgi:application --bind 0.0.0.0:$PORT

【问题讨论】：

他们说它在构建过程中自动运行； devcenter.heroku.com/articles/… 您也可以在 dockerfile 中设置设置模块； ENV DJANGO_SETTINGS_MODULE=project.settings.build

它不会在您构建 Docker 容器时自动运行——该链接仅在您不使用 Docker 时适用。

【参考方案1】：

在与 Heroku 支持确认后，这确实看起来有点像 catch-22。

解决方案是将collectstatic 放在 Dockerfile 中，以便它在构建期间运行并且文件保持不变。

我们通过使用 Django 的 get_random_secret_key 函数设置默认密钥来解决没有密钥配置变量的问题。

运行阶段使用 Heroku 配置变量中的密钥，因此我们实际上并不是每次都更改密钥——默认值仅适用于构建过程。 collectstatic 不索引密钥，所以这很好。

在settings.py中

from django.core.management.utils import get_random_secret_key
...
SECRET_KEY = os.getenv('DJANGO_SECRET_KEY', default=get_random_secret_key())

【讨论】：

非常感谢！我浪费了几个小时试图让静态文件在 Heroku 上工作！这是一个非常优雅的解决方案。

天哪，我真希望我在 2 天前找到那个帖子！

【参考方案2】：

我不使用heroku，所以无法测试，但您应该能够在运行应用程序之前运行collect static；

Dockerfile

# Pull base image
FROM python:3.7-slim

# Set environment varibles
ENV PYTHONDONTWRITEBYTECODE 1
ENV PYTHONUNBUFFERED 1

# Set work directory
WORKDIR /code/

# Install dependencies
RUN pip install pipenv
COPY Pipfile Pipfile.lock .
RUN pipenv install --system

# Copy project
COPY . .

# Collect static files
RUN python manage.py collectstatic --noinput

# run gunicorn
CMD gunicorn hello_django.wsgi:application --bind 0.0.0.0:$PORT

您也不能在 dockerfile 中运行 collectstatic，或者事件运行应用程序，因为这些可以由 heroku.yml 运行，例如；

build:
  docker:
    web: Dockerfile
  config:
    DJANGO_SETTINGS_MODULE: project.settings
run:
  web: gunicorn backend.config.wsgi:application --bind 0.0.0.0:$PORT
release:
  image: web
  command:
    - python manage.py collectstatic --noinput

您的工作目录也不需要mkdir。只需在 dockerfile 的早期设置 WORKDIR /code/，然后基于该目录运行。

这里有一篇不错的文章； https://testdriven.io/blog/deploying-django-to-heroku-with-docker/

【讨论】：

使用 Dockerfile 中的 collectstatic 构建失败，因为 django 密钥在构建时对 collectstatic 命令不可用。使用 collectstatic 作为发布命令，它将成功构建和发布，但实际上无法找到静态文件，我相信因为在发布期间创建的文件不会持续存在。那篇文章是个谜；我想知道作者是否从未实际测试过它。

@RyanKnight 但你会注意到我已经将设置模块添加为环境变量，这将允许 django 加载设置并执行命令。

是的，试过了，还是不行。问题是在 Heroku 上构建时配置变量不可用：devcenter.heroku.com/articles/…

@RyanKnight 如何从heroku.yml 传递配置变量以进行构建？ （我已经更新了我的答案以包括这个）

作为构建过程的一部分运行时的问题是找不到设置文件；我在manage.py 中为此设置了默认路径，所以这从来都不是问题。问题是访问通过 Heroku 配置变量设置的环境变量。 collectstatic 失败的一个配置变量是 django 密钥，因为它返回“”，但需要一个值。