Django Minio Storage 技术文档

Django Minio Storage 技术文档

1. 安装指南

1.1 安装依赖

在开始安装 django-minio-storage 之前，请确保您的系统已经安装了以下依赖：

• Python 3.8 或更高版本
• Django 3.2 或更高版本

1.2 使用 pip 安装

您可以使用 pip 来安装 django-minio-storage。打开终端并运行以下命令：

pip install django-minio-storage

1.3 验证安装

安装完成后，您可以通过以下命令验证是否安装成功：

pip show django-minio-storage

如果安装成功，您将看到关于 django-minio-storage 的详细信息。

2. 项目的使用说明

2.1 配置 Django 项目

在您的 Django 项目的 settings.py 文件中，添加以下配置以启用 django-minio-storage：

INSTALLED_APPS = [
    ...
    'django_minio_storage',
    ...
]

DEFAULT_FILE_STORAGE = 'django_minio_storage.storage.MinioMediaStorage'
STATICFILES_STORAGE = 'django_minio_storage.storage.MinioStaticStorage'

MINIO_STORAGE_ENDPOINT = 'your-minio-endpoint'
MINIO_STORAGE_ACCESS_KEY = 'your-access-key'
MINIO_STORAGE_SECRET_KEY = 'your-secret-key'
MINIO_STORAGE_USE_HTTPS = True  # 如果使用 HTTPS，设置为 True
MINIO_STORAGE_MEDIA_BUCKET_NAME = 'your-media-bucket'
MINIO_STORAGE_AUTO_CREATE_MEDIA_BUCKET = True
MINIO_STORAGE_STATIC_BUCKET_NAME = 'your-static-bucket'
MINIO_STORAGE_AUTO_CREATE_STATIC_BUCKET = True

2.2 上传文件

配置完成后，您可以像往常一样使用 Django 的文件上传功能。上传的文件将自动存储在 Minio 服务器上。

2.3 访问文件

上传的文件可以通过 Minio 提供的 URL 进行访问。您可以在 Django 模板中使用 {{ MEDIA_URL }} 和 {{ STATIC_URL }} 来访问这些文件。

3. 项目API使用文档

3.1 MinioMediaStorage API

MinioMediaStorage 是用于存储媒体文件的存储类。它提供了以下主要方法：

• _save(name, content): 保存文件到 Minio 服务器。
• url(name): 返回文件的 URL。
• exists(name): 检查文件是否存在。

3.2 MinioStaticStorage API

MinioStaticStorage 是用于存储静态文件的存储类。它提供了以下主要方法：

• _save(name, content): 保存文件到 Minio 服务器。
• url(name): 返回文件的 URL。
• exists(name): 检查文件是否存在。

4. 项目安装方式

4.1 从 PyPI 安装

您可以通过 pip 从 PyPI 安装 django-minio-storage：

pip install django-minio-storage

4.2 从源码安装

如果您想从源码安装，可以按照以下步骤操作：

1. 克隆项目仓库：

git clone https://github.com/py-pa/django-minio-storage.git

2. 进入项目目录：

cd django-minio-storage

3. 安装依赖：

pip install -r requirements.txt

4. 安装项目：

python setup.py install

通过以上步骤，您可以成功安装并使用 django-minio-storage 来管理 Django 项目的静态和媒体文件存储。