django-remotestorage 13.08.0

要求

• Python 2.7 (not 3.X)
• Django
• Django OAuth 2.0 Server App (oauth2app)
• （可选，建议）South-用于 自动数据库架构更新

目前oauth2app是not on PyPI，但是 pip可以直接从github安装它。

应用程序的各种接口使用一些外部资源，如Twitter Bootstrapcss文件（从 bootstrapcdn.com）和 remoteStorage.js， 如果您使用https 接口-来自本地URL，如果在静态根目录中可用。见 “定制/接口”了解详细信息。

从Django的迁移未显示

这个包裹过去被称为django unhosted，但后来决定 在太迟之前把它改名。

不幸的是，没有简单的方法可以重命名django应用程序和python 包，特别是如果不希望保留旧的包名称 所以必须采取一些手动步骤 迁移到新的（django remotestorage）应用程序/包。

• 卸载django unhosted python包（通过 pip uninstall     django-unhosted、操作系统工具或删除模块 手动路径）。
• 全部重命名名称为“django_unhosted”的数据库表 从“django_remotestorage”开始。很多简单易用的 图形用户界面工具（如pgadmin， phpPgAdmin， phpMyAdmin， phpSQLiteAdmin等）或 本机cli接口（sqlite3 /path/to/db.sqlite，psql， mysql等）可用于此。
• 更新settings.py和urlconf以从 “django_remotestorage”模块，而不是“django_unhosted”。替换 变量名中的所有“unhosted”如果用于 设置.py。
• 如果有自定义的urlconf和/或模板，请替换对 具有“remotestorage”的“unhosted”命名空间。

它应该相当简单，但是可以随意打开问题或 contact developers 如果所描述的过程不适合你。

部署/配置

django应用程序作为“django项目”的一部分部署，该项目位于 它是最小的-只有几个configuration files， 指定要使用的数据库，以及应处理哪些应用程序 网址。

pip install django-remotestorage

pip install 'git+https://github.com/RemoteStorage/django-remotestorage.git#egg=django-remotestorage'

git clone https://github.com/RemoteStorage/django-remotestorage.git
cd django-remotestorage
python setup.py install
pip install -r requirements.txt # or download/install each by hand as well

pip install 'git+https://github.com/hiidef/oauth2app.git#egg=oauth2app'

cd
django-admin.py startproject myproject
cd myproject

# Update settings.py (sqlite3 is used as db here) and urls.py
sed -i \
    -e 's/'\''ENGINE'\''.*/"ENGINE": "django.db.backends.sqlite3",/' \
    -e 's/'\''NAME'\''.*/"NAME": "db.sqlite",/' \
    -e 's/STATIC_ROOT *=/STATIC_ROOT="./static"/' \
    myproject/settings.py
echo -e >>myproject/settings.py \
    'from django_remotestorage.settings_base import update_settings' \
    '\nupdate_settings(__name__)'
sed -i \
    -e '1afrom django_remotestorage.urls import remotestorage_patterns' \
    -e 's/# Examples:.*/("", include(remotestorage_patterns)),\n\n\0/' \
    myproject/urls.py

# Create database schema and link app static files to STATIC_ROOT
./manage.py syncdb --noinput
./manage.py migrate django_remotestorage
./manage.py collectstatic --noinput --link

# Run simple dev server
./manage.py runserver

django-admin.py syncdb

django-admin.py migrate django_remotestorage

成分

应用程序由几个独立的组件（子应用程序，绑定到 URL路径通过 django_remotestorage.urls）：

• webfinger（名称：webfinger，url: {包含前缀}/.已知/主机元，{包含前缀}/webfinger； 看见 django_remotestorage.apps.webfinger.urls， 其他子应用程序也有类似的urlconf文件）。
• oauth2（名称：oauth2，url:{include_prefix}/oauth2）。
• 存储api（名称：api，url:{include_prefix}/api）。
• 帐户/客户端管理（名称：“account”，url: {包含前缀}/帐户）。也可以使用 以下名称：“account_auth”（登录/注销表单/链接）， “账户认证管理”（注册表） “客户机管理”（客户机/应用程序访问管理界面 对于已登录的用户）。“account”是所有这些的别名 接口。
• 演示客户端（名称：demo，url:{include_prefix}/）

一些组件相互提供链接（例如，webfinger 在提供的xrd/json数据中提供到oauth2和api的链接，解析为 “远程存储：{app}：{view_name}”，因此您可以将这些应用重新绑定到任何 url，只要为django “reverse()” function提供相同的名称空间/视图名称 和“url”模板标记。

当包含“django_remotestorage.url.remotestorage_patterns”时 直接（不是来自单个组件的urlconf）， “remotestorage_components”settings.py选项可以设置为iterable 应启用的组件，例如：

REMOTESTORAGE_COMPONENTS = 'webfinger', 'oauth2', 'api'

…将只启用存储api、oauth2和webfinger子应用程序-bare 功能性远程存储节点的最小值。除非有其他办法 验证django用户（如 django.contrib.auth.views.login 或者django.contrib.admin）已启用，也可能需要 启用“account_auth”接口以通过OAuth2授权。

如果urlconf中省略了“account”（或其部分）和“demo”应用程序 完全（如果不需要的话），在OAuth2中不会有任何指向它们的链接 访问确认界面。它们的界面页面和功能 无法访问。

“api”和“oauth2”子应用程序未链接到任何其他组件 也可以单独使用 嗯（例如，如果授权服务器和存储在不同的 但它们必须共享一个数据库，以便api能够 验证验证令牌。

OAuth2

强烈建议增加数据库字段长度（使用 oauth2app settings）在之前 首次运行syncdb:

• OAuth2_客户端密钥长度=1024（默认值：30）
• OAuth2_scope_length=2048（默认值：255）

有关 为什么要这么做。

另一个重要的可调参数是oauth2_access_token_expiration（默认值： 3600=1小时），至少在remotestorage.js 0.6.9（“稳定”下） 在写的时刻）-本质上设置了最大间隔。 需要访问OAuth2接口并获取新的访问令牌，因为 remotestorage.js似乎无法刷新这些。

网指

如果 webfinger 和host-meta 对域的请求应该包含比 远程存储，它们可以通过替换webfinger应用程序进行扩展 完全或添加自定义模板。

webfinger应用程序正在使用“webfinger/host{meta.{xml，json}”和 “webfinger/webfinger.{xml，json}”模板，由提供 django_remotestorage.apps.webfinger.xrd_gen.loader或生成 动态（对于json，如果找不到模板provide）。

请参阅中的示例XML模板 django_remotestorage/templates/webfinger/{host_meta,webfinger}.xml.example。

存储/webdav

如果远程存储由（可配置的）Django Storage API支持。

默认情况下， DEFAULT_FILE_STORAGE 使用存储类。不同的存储类可以由 “remotestorage\u dav\u storage”参数（传递给 get_storage_class）。

存储api实现的示例可能包括：

• django-storages （s3、couchdb、sql、ftp、mongodb、cloudfiles等）
• django-dropbox （Dropbox）
• django-riak-engine （里亚克）
• django-tahoestorage （Tahoe Lafs）

但基本上有一个客户机可以存储几乎所有的数据 技术-只需谷歌它，安装和设置远程存储 （或默认的文件存储）。

默认存储（文件存储）参数可以配置为 媒体URL和媒体根目录 settings，请参阅 “Managing files”姜戈 文档部分了解详细信息。

还有一些优化参数：

• 远程存储发送文件（bool，默认值：false）

  将storage.path（如果后端支持）通过 “x-sendfile”头而不是请求时的实际内容，因此 该响应可以由前端守护程序直接提供，而无需 涉及后端应用程序。

• remotestorage_dav_accel（字符串，默认值：无）

  将“x-accel-redirect”标题设置为的空HttpResponse返回 指定的前缀（可以是空字符串）加上请求的路径，因此 实际的响应可以由apache mod_accel提供。

• 远程存储重定向（bool，默认值：false）

  返回重定向到媒体URL（由storage.url方法生成）。用过的 仅当媒体URL设置为非空字符串时。

  只有在检查oauth2app生成的承载之后才能提供这些url http“authorization”头中的令牌，可以使用django（或自定义 或者一些智能httpd。

  不要将httpd配置为在没有 授权，因为每个人都可以绕过OAuth2 通过猜测文件路径就可以访问远程存储中的任何内容 或者从js获取/重用它们，这非常容易利用。

接口

通常的演练-将自己的模板放到加载程序中，在 设置.py。

这些页面上提供的外部资源可以放在 静态根目录将由本地httpd提供服务。见 django_remotestorage.utils.external_resources_context 上下文处理器以获取详细信息。

如果为这些接口提供服务，请特别注意使资源成为本地资源 通过https-如果mitm可以放置任何 javascript（通过普通http加载）到页面。

注意，如果不需要的话，可以禁用任何/所有ui， 只需使用remotestorage_components选项（如“组件”中所述） 或者不包括在urlconf中，樱桃采摘 实际上是需要的。

定制的一个常见情况是需要将整个应用程序放入 子路径（“/remotestorage”在示例中）可以通过放置 这将进入项目的根url.py:

from django.conf.urls import patterns, include, url

from django_remotestorage.apps.webfinger.urls import host_meta_patterns
from django_remotestorage.urls import remotestorage_patterns

urlpatterns = patterns('',
    url(r'', include(host_meta_patterns)),
    url(r'^remotestorage/', include(remotestorage_patterns)),
)

这样，演示客户端将在“/remotestorage”url和所有 链接将包括该前缀（例如来自 webfinger将指向“/remotestorage/oauth2/authorize”）。

不过，请确保webfinger应用程序的主机元视图是available at a well-known url “/.well-known/host-meta”，因此是“主机元模式”的特例 从根链接。

网指

• 不容易支持signed XRD 目前。签名的staticxml“模板”（或仅提供文件） 如果TLS不是一个选项，则可以使用httpd）作为解决方法。

OAuth2

• 存储对象路径（想想“public/myphoto.jpg”）用作OAuth2 远程存储的“作用域”。oauth2app基本上只保留一个表 这些（将它们视为一组有限的预先能力）。

  这里的问题：

  • OAuth2App将“scope”存储为255个字符的键，而路径/ 集合名称可能更长。上游pull request指定 字段长度已合并（截至2012年7月19日），因此请使用任何更新的 中具有足够大的oauth2_scope_length参数的版本 settings.py（它doesn’t really affect performance 现代数据库，只是让你的生活更艰难）。
  目前，OAuth2App检查访问范围（范围）的存在性。 尽管可以访问 其中一些可能未经用户授权，需要临时 造成这种混乱。上游拉取请求： https://github.com/hiidef/oauth2app/pull/32
  • 在维护 （在本例中没有意义）表。

• remotestorage.js 0.6.9（“目前稳定”的版本）有一个known issue 将遗留的“path1，path2”作为“scope”传递，进一步复杂化 为OAuth2App准备的东西 能力，根据规范）。

  解决方法是通过缺少“：rw”后缀来检测旧格式 并通过发出重定向来更新地址中的“scope”。

  注意，由于路径可能包含逗号，“path1，path2”可以是 模棱两可（因为这个问题），可以被视为 “路径1:rw”和“路径2:rw”或“路径1，路径2:rw”。当前实施 如果没有结肠脱落，则选择前一种解释 后缀。

• remotestorage.js 0.6.9（“目前稳定”的版本）使用主机名 应用程序站点的OAuth2客户机ID，在OAuth2App中对应 到“key”字段，默认情况下只有32个字符长， 对某些主机名来说可能不够，但可以（而且should！）是 由django中的oauth2_client_key_length参数配置 项目设置.py。记住在syncdb或update之前 稍后是表列。

  可能的解决方法是使用哈希作为客户端的ID 内部和重定向远程存储请求 “client_id=hostname.com”改为 “客户ID=sha1:bbc21f0ccb5dfbf81f5043d78aa”。

  我不明白为什么客户ID在 现在，如果有原因的话，请报告一个问题，somE类 自动迁移到散列可能随时都可以部署。

• 目前OAuth2App是not on PyPI， 但是pip可以直接从github安装它。

WebDAV

• CSRF中间件 （django.middleware.csrf.CsrfViewMiddleware） 必须禁用，因为remotestorage.js不通过django csrf 令牌以及put（和类似的）请求。是有选择性的 不过，通过应用程序窗体的decorator启用。

• 数据当前存储在django存储中，而路径元数据 是通过django数据库api存储的，它引入了 故障点（以及两者之间同步丢失的可能性）； 因为一个数据没有另一个是无用的。

  似乎没有任何简单的方法可以解决这个问题-将路径数据存储在 存储密钥不适用于任何驱动程序，将其推到内容中 当这些内容将由python以外的任何东西提供服务时将不起作用 （比如，httpd）和在数据库中存储文件只在相对 小文件。

  所以一定要备份数据库和实际的存储，或者写 一些特定于存储的kludge也可以在那里存储元数据。例子 会在post-save django signal中添加一个钩子， 它将从storageobject.data.name和store获取存储路径 一些“{name}.meta”文件以及序列化的模型数据。